API Reference

Class

AdfDocument

Edit on GitHub

Namespace OfficeIMO.Adf

Assembly OfficeIMO.Adf

Source revision 45ddf07f0b84 with working tree changes

Source AdfDocument.cs:31

Modifiers sealed

Represents an Atlas Document Format document while retaining fields that OfficeIMO does not yet understand.

Inheritance

Object
AdfDocument

Usage

Explore 6 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 3

Accepted by parameters 3

Method AdfConverter.ToHtml parameter document
Method AdfConverter.ToMarkdown parameter document
Method AdfConverter.ToMarkdownDocument parameter document

Constructors

AdfDocument 2 overloads

public AdfDocument() #

AdfDocument.cs:31

Creates an empty ADF document.

public AdfDocument(IEnumerable<AdfNode>? content) #

AdfDocument.cs:31

Creates an ADF document with the supplied top-level nodes.

Parameters

content System.Collections.Generic.IEnumerable<OfficeIMO.Adf.AdfNode>? requiredposition: 0

Methods

Parse 2 overloads

public static AdfDocument Parse(String json) #

AdfDocument.cs:51

Returns: AdfDocument

Parses an ADF JSON document and retains unrecognized fields for round trips.

Parameters

json System.String requiredposition: 0

public static AdfDocument Parse(String json, AdfProcessingOptions options) #

AdfDocument.cs:54

Returns: AdfDocument

Parses ADF JSON with explicit resource limits and cancellation.

Parameters

json System.String requiredposition: 0
options OfficeIMO.Adf.AdfProcessingOptions requiredposition: 1

ToJson 2 overloads

public String ToJson(Boolean indented = false) #

AdfDocument.cs:58

Returns: String

Serializes this document to ADF JSON without performing structural validation.

Parameters

indented System.Boolean = false optionalposition: 0

public String ToJson(AdfProcessingOptions options, Boolean indented = false) #

AdfDocument.cs:61

Returns: String

Serializes ADF JSON with explicit resource limits and cancellation.

Parameters

options OfficeIMO.Adf.AdfProcessingOptions requiredposition: 0
indented System.Boolean = false optionalposition: 1

Validate 4 overloads

public AdfValidationResult Validate() #

AdfDocument.cs:64

Returns: AdfValidationResult

Validates the structural ADF contract without rejecting unknown node or mark types.

public AdfValidationResult Validate(AdfProcessingOptions options) #

AdfDocument.cs:68

Returns: AdfValidationResult

Validates ADF structure with explicit resource limits and cancellation.

Parameters

options OfficeIMO.Adf.AdfProcessingOptions requiredposition: 0

public AdfValidationResult Validate(AdfValidationOptions options) #

AdfDocument.cs:73

Returns: AdfValidationResult

Validates against the selected structural or bundled full-schema contract.

Parameters

options OfficeIMO.Adf.AdfValidationOptions requiredposition: 0

public AdfValidationResult Validate(AdfValidationOptions options, CancellationToken cancellationToken) #

AdfDocument.cs:77

Returns: AdfValidationResult

Validates against the selected contract with cancellation during graph and rule traversal.

Parameters

options OfficeIMO.Adf.AdfValidationOptions requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

Inherited Methods

Properties

public Int32 Version { get; set; } #

AdfDocument.cs:31

ADF schema version.

public String Type { get; set; } #

AdfDocument.cs:34

Root node type. A normal ADF document uses doc.

public List<AdfNode> Content { get; } #

AdfDocument.cs:37

Top-level document nodes.

public IDictionary<String, JsonElement> ExtensionData { get; } #

AdfDocument.cs:41

Unknown root properties retained during parse/write round trips.