API Reference
Class
AdfDocument
Represents an Atlas Document Format document while retaining fields that OfficeIMO does not yet understand.
Inheritance
- Object
- AdfDocument
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method AdfConverter.FromHtml
- Method AdfConverter.FromMarkdown
- Method AdfConverter.FromMarkdown
- Method AdfDocument.Parse
Accepted by parameters
- Method AdfConverter.ToHtml
- Method AdfConverter.ToMarkdown
- Method AdfConverter.ToMarkdownDocument
Constructors
AdfDocument 2 overloads
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) #Returns:
AdfDocumentParses an ADF JSON document and retains unrecognized fields for round trips.
Parameters
- json System.String
public String ToJson(Boolean indented = false) #Returns:
StringSerializes this document to ADF JSON without performing structural validation.
Parameters
- indented System.Boolean = false
public AdfValidationResult Validate() #Returns:
AdfValidationResultValidates the structural ADF contract without rejecting unknown node or mark types.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public Int32 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.