AdfDocument
OfficeIMO.Adf
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
- Method AdfConverter.FromHtml
- Method AdfConverter.FromMarkdown
- Method AdfDocument.Parse
Accepted by parameters 3
- Method AdfConverter.ToHtml
- Method AdfConverter.ToMarkdown
- Method AdfConverter.ToMarkdownDocument
Constructors
public AdfDocument(IEnumerable<AdfNode>? content) #Creates an ADF document with the supplied top-level nodes.
Parameters
- content System.Collections.Generic.IEnumerable<OfficeIMO.Adf.AdfNode>?
Methods
public static AdfDocument Parse(string json) #Parses an ADF JSON document and retains unrecognized fields for round trips.
Parameters
- json string
Returns
AdfDocumentpublic static AdfDocument Parse(string json, AdfProcessingOptions options) #Parses ADF JSON with explicit resource limits and cancellation.
Parameters
- json string
- options OfficeIMO.Adf.AdfProcessingOptions
Returns
AdfDocumentpublic string ToJson(bool indented = false) #Serializes this document to ADF JSON without performing structural validation.
Parameters
- indented bool = false
Returns
stringpublic string ToJson(AdfProcessingOptions options, bool indented = false) #Serializes ADF JSON with explicit resource limits and cancellation.
Parameters
- options OfficeIMO.Adf.AdfProcessingOptions
- indented bool = false
Returns
stringpublic AdfValidationResult Validate() #Validates the structural ADF contract without rejecting unknown node or mark types.
Returns
AdfValidationResultpublic AdfValidationResult Validate(AdfProcessingOptions options) #Validates ADF structure with explicit resource limits and cancellation.
Parameters
- options OfficeIMO.Adf.AdfProcessingOptions
Returns
AdfValidationResultpublic AdfValidationResult Validate(AdfValidationOptions options) #Validates against the selected structural or bundled full-schema contract.
Parameters
- options OfficeIMO.Adf.AdfValidationOptions
Returns
AdfValidationResultpublic AdfValidationResult Validate(AdfValidationOptions options, CancellationToken cancellationToken) #Validates against the selected contract with cancellation during graph and rule traversal.
Parameters
- options OfficeIMO.Adf.AdfValidationOptions
- cancellationToken System.Threading.CancellationToken
Returns
AdfValidationResultInherited Methods
Properties
public IDictionary<string, JsonElement> ExtensionData { get; } #Unknown root properties retained during parse/write round trips.