Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

AdfDocument

OfficeIMO.Adf

Namespace
OfficeIMO.Adf
Assembly
OfficeIMO.Adf
Source revision
ba882f6b0d07 with working tree changes
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

Constructors

AdfDocument 2 overloads
public AdfDocument() #

Creates an empty ADF document.

public AdfDocument(IEnumerable<AdfNode>? content) #

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

Parameters

content System.Collections.Generic.IEnumerable<OfficeIMO.Adf.AdfNode>? required

Methods

Parse 2 overloads
public static AdfDocument Parse(string json) #

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

Parameters

json string required
public static AdfDocument Parse(string json, AdfProcessingOptions options) #

Parses ADF JSON with explicit resource limits and cancellation.

Parameters

json string required
options OfficeIMO.Adf.AdfProcessingOptions required
ToJson 2 overloads
public string ToJson(bool indented = false) #

Serializes this document to ADF JSON without performing structural validation.

Parameters

indented bool = false optional

Returns

string
public string ToJson(AdfProcessingOptions options, bool indented = false) #

Serializes ADF JSON with explicit resource limits and cancellation.

Parameters

options OfficeIMO.Adf.AdfProcessingOptions required
indented bool = false optional

Returns

string
Validate 4 overloads
public AdfValidationResult Validate() #

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

public AdfValidationResult Validate(AdfProcessingOptions options) #

Validates ADF structure with explicit resource limits and cancellation.

Parameters

options OfficeIMO.Adf.AdfProcessingOptions required
public AdfValidationResult Validate(AdfValidationOptions options) #

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

Parameters

options OfficeIMO.Adf.AdfValidationOptions required
public AdfValidationResult Validate(AdfValidationOptions options, CancellationToken cancellationToken) #

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

Parameters

options OfficeIMO.Adf.AdfValidationOptions required
cancellationToken System.Threading.CancellationToken required

Properties

public int Version { get; set; } #

ADF schema version.

public string Type { get; set; } #

Root node type. A normal ADF document uses doc.

public List<AdfNode> Content { get; } #

Top-level document nodes.

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

Unknown root properties retained during parse/write round trips.