API Reference
AsciiDocDocument
Parsed AsciiDoc document with a lossless syntax tree and typed editable top-level blocks.
Inheritance
- Object
- AsciiDocDocument
Usage
Explore 21 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 19
- Method AsciiDocDelimitedBlock.GetBody
- Property AsciiDocDelimitedBlock.Body
- Method AsciiDocDocument.Add
- Method AsciiDocDocument.AddHeading
- Method AsciiDocDocument.AddParagraph
- Method AsciiDocDocument.Create
- Method AsciiDocDocument.Load
- Method AsciiDocDocument.LoadAsync
- Method AsciiDocDocument.Move
- Method AsciiDocDocument.Parse
- Method AsciiDocParseResult.RequireValue
- Property AsciiDocParseResult.Document
- Property AsciiDocParseResult.Value
- Property AsciiDocProcessingResult.Document
- Property AsciiDocProcessingResult.SourceDocument
- Method AsciiDocTableBlock.GetBody
- Property AsciiDocTableBlock.Body
- Method AsciiDocTableCell.GetBody
- Property AsciiDocTableCell.Body
Accepted by parameters 2
- Method AsciiDocCalloutCatalog.Create
- Method AsciiDocReferenceCatalog.Create
Methods
public AsciiDocDocument Add(String source, AsciiDocParseOptions? options = null) #AsciiDocDocumentAppends parsed AsciiDoc blocks, including their metadata and source trivia.
Parameters
- source System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
public AsciiDocDocument AddHeading(Int32 sectionLevel, String inlineSource) #AsciiDocDocumentAppends a section heading. Section levels 1 through 5 use two through six equals signs.
Parameters
- sectionLevel System.Int32
- inlineSource System.String
public AsciiDocDocument AddParagraph(String inlineSource) #AsciiDocDocumentAppends a paragraph with native inline syntax while protecting block-start syntax.
Parameters
- inlineSource System.String
Exceptions
ArgumentException– The source is empty or contains more than one paragraph.
public IEnumerable<TBlock> BlocksOfType<TBlock>() #IEnumerable<TBlock>Enumerates blocks of a requested semantic type.
Type Parameters
- TBlock
public static AsciiDocDocument Create() #AsciiDocDocumentCreates an empty editable AsciiDoc document.
public IEnumerable<AsciiDocAttributeEntry> GetAttributeEntries(Int32 maximumNestingDepth = 64, CancellationToken cancellationToken = default) #IEnumerable<AsciiDocAttributeEntry>Enumerates attribute entries in source order, including compound bodies, with a bounded traversal depth.
Parameters
- maximumNestingDepth System.Int32 = 64
- cancellationToken System.Threading.CancellationToken = default
public AsciiDocDocumentAttributes GetAttributes(IReadOnlyDictionary<String, String>? initialValues = null) #AsciiDocDocumentAttributesBuilds the effective document attribute set in source order.
Parameters
- initialValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>? = null
public IEnumerable<AsciiDocBlockContext> GetBlockContexts(IReadOnlyDictionary<String, String>? initialValues = null, Boolean expandAssignmentValues = true) #IEnumerable<AsciiDocBlockContext>Enumerates source blocks with immutable attribute snapshots in document order.
Parameters
- initialValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>? = null
- expandAssignmentValues System.Boolean = true
public IEnumerable<AsciiDocBlockContext> GetBlockContexts(IReadOnlyDictionary<String, String>? initialValues, Boolean expandAssignmentValues, Int32 maximumNestingDepth, CancellationToken cancellationToken = default) #IEnumerable<AsciiDocBlockContext>Enumerates attribute snapshots with bounded compound traversal and cooperative cancellation.
Parameters
- initialValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>?
- expandAssignmentValues System.Boolean
- maximumNestingDepth System.Int32
- cancellationToken System.Threading.CancellationToken = default
public IReadOnlyList<AsciiDocBlock> Insert(Int32 index, String source, AsciiDocParseOptions? options = null) #IReadOnlyList<AsciiDocBlock>Inserts parsed AsciiDoc blocks at a zero-based source-block index.
Parameters
- index System.Int32
- source System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
public static AsciiDocDocument Load(String path, AsciiDocParseOptions? options = null, Encoding? encoding = null) #AsciiDocDocumentLoads and parses an AsciiDoc file using the selected encoding or Unicode BOM detection with a UTF-8 default. Retains decoded characters and line endings, not original encoding or BOM bytes.
Parameters
- path System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
- encoding System.Text.Encoding? = null
public static AsciiDocDocument Load(String path, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken) #AsciiDocDocumentLoads and parses an AsciiDoc file with cooperative cancellation.
Parameters
- path System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions?
- encoding System.Text.Encoding?
- cancellationToken System.Threading.CancellationToken
public static AsciiDocDocument Load(Stream stream, AsciiDocParseOptions? options = null, Encoding? encoding = null) #AsciiDocDocumentLoads and parses an AsciiDoc document from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
- encoding System.Text.Encoding? = null
public static AsciiDocDocument Load(Stream stream, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken) #AsciiDocDocumentLoads bounded text with cooperative cancellation while preserving the caller's stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions?
- encoding System.Text.Encoding?
- cancellationToken System.Threading.CancellationToken
public static async Task<AsciiDocDocument> LoadAsync(String path, AsciiDocParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Task<AsciiDocDocument>Asynchronously loads and parses an AsciiDoc file.
Parameters
- path System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<AsciiDocDocument> LoadAsync(Stream stream, AsciiDocParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Task<AsciiDocDocument>Asynchronously loads and parses an AsciiDoc document from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
public static AsciiDocParseResult LoadResult(String path, AsciiDocParseOptions? options = null, Encoding? encoding = null) #AsciiDocParseResultLoads an AsciiDoc file with its lossless syntax and recovery diagnostics. Retains decoded characters and line endings, not original encoding or BOM bytes.
Parameters
- path System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
- encoding System.Text.Encoding? = null
public static AsciiDocParseResult LoadResult(String path, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken) #AsciiDocParseResultLoads a bounded AsciiDoc file and returns recovery diagnostics with cooperative cancellation.
Parameters
- path System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions?
- encoding System.Text.Encoding?
- cancellationToken System.Threading.CancellationToken
public static AsciiDocParseResult LoadResult(Stream stream, AsciiDocParseOptions? options = null, Encoding? encoding = null) #AsciiDocParseResultLoads an AsciiDoc document from a caller-owned stream with syntax and recovery diagnostics.
Parameters
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
- encoding System.Text.Encoding? = null
public static AsciiDocParseResult LoadResult(Stream stream, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken) #AsciiDocParseResultLoads bounded text and returns recovery diagnostics with cooperative cancellation.
Parameters
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions?
- encoding System.Text.Encoding?
- cancellationToken System.Threading.CancellationToken
public static async Task<AsciiDocParseResult> LoadResultAsync(String path, AsciiDocParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Task<AsciiDocParseResult>Asynchronously loads an AsciiDoc file with syntax and recovery diagnostics.
Parameters
- path System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<AsciiDocParseResult> LoadResultAsync(Stream stream, AsciiDocParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Task<AsciiDocParseResult>Asynchronously loads an AsciiDoc stream with syntax and recovery diagnostics.
Parameters
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
public AsciiDocDocument Move(AsciiDocBlock block, Int32 index) #AsciiDocDocumentMoves a semantic block and its bound metadata and attachments before the original zero-based index.
Parameters
- block OfficeIMO.AsciiDoc.AsciiDocBlock
- index System.Int32
public static AsciiDocDocument Parse(String source, AsciiDocParseOptions? options = null) #AsciiDocDocumentParses an AsciiDoc string into the typed document model.
Parameters
- source System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
public static AsciiDocDocument Parse(String source, AsciiDocParseOptions? options, CancellationToken cancellationToken) #AsciiDocDocumentParses an AsciiDoc string with cooperative cancellation.
Parameters
- source System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions?
- cancellationToken System.Threading.CancellationToken
public static AsciiDocParseResult ParseResult(String source, AsciiDocParseOptions? options = null) #AsciiDocParseResultParses an AsciiDoc string with syntax and recovery diagnostics.
Parameters
- source System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null
public static AsciiDocParseResult ParseResult(String source, AsciiDocParseOptions? options, CancellationToken cancellationToken) #AsciiDocParseResultParses source with recovery diagnostics and cooperative cancellation.
Parameters
- source System.String
- options OfficeIMO.AsciiDoc.AsciiDocParseOptions?
- cancellationToken System.Threading.CancellationToken
public Boolean Remove(AsciiDocBlock block) #BooleanRemoves a semantic block together with its bound metadata and list attachments.
Parameters
- block OfficeIMO.AsciiDoc.AsciiDocBlock
public Void Save(String path, AsciiDocWriterOptions? options = null, Encoding? encoding = null) #VoidSaves the current document text to a file.
Parameters
- path System.String
- options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null
- encoding System.Text.Encoding? = null
public Void Save(Stream stream, AsciiDocWriterOptions? options = null, Encoding? encoding = null) #VoidWrites the current document text to a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null
- encoding System.Text.Encoding? = null
public async Task SaveAsync(String path, AsciiDocWriterOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #TaskAsynchronously saves the current document text to a file.
Parameters
- path System.String
- options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
public Task SaveAsync(Stream stream, AsciiDocWriterOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #TaskAsynchronously writes the current document text to a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
public String ToAsciiDoc(AsciiDocWriterMode mode) #StringWrites this document using the requested mode.
Parameters
- mode OfficeIMO.AsciiDoc.AsciiDocWriterMode
public String ToAsciiDoc(AsciiDocWriterOptions? options) #StringWrites this document with explicit options.
Parameters
- options OfficeIMO.AsciiDoc.AsciiDocWriterOptions?
public Byte[] ToBytes(AsciiDocWriterOptions? options = null, Encoding? encoding = null) #Byte[]Encodes the current document text.
Parameters
- options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null
- encoding System.Text.Encoding? = null
public MemoryStream ToStream(AsciiDocWriterOptions? options = null, Encoding? encoding = null) #MemoryStreamEncodes the current document in a new writable memory stream positioned at the beginning.
Parameters
- options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null
- encoding System.Text.Encoding? = null
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public AsciiDocSourceText Source { get; } #Original source text and line mapping.
public AsciiDocDocumentProfile Profile { get; } #Selected bounded document profile.
public IReadOnlyList<AsciiDocBlock> Blocks { get; } #Typed top-level source blocks, including trivia and comments.
public IReadOnlyList<AsciiDocDiagnostic> Diagnostics { get; } #Parser and recovery diagnostics.
public Boolean IsModified { get; } #True when any editable block or list item has changed.