API Reference
AsciiDocDocument
Parsed AsciiDoc document with a lossless syntax tree and typed editable top-level blocks.
Inheritance
- Object
- AsciiDocDocument
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 AsciiDocDocument.Load
- Method AsciiDocDocument.Load
- Method AsciiDocDocument.LoadAsync
- Method AsciiDocDocument.LoadAsync
- Method AsciiDocDocument.Parse
- Method AsciiDocParseResult.RequireValue
- Property AsciiDocParseResult.Document
- Property AsciiDocParseResult.Value
- Property AsciiDocProcessingResult.Document
- Property AsciiDocProcessingResult.SourceDocument
Methods
public IEnumerable<TBlock> BlocksOfType<TBlock>() #IEnumerable<TBlock>Enumerates blocks of a requested semantic type.
Type Parameters
- TBlock
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 static AsciiDocDocument Load(String path, AsciiDocParseOptions options = null, Encoding encoding = null) #AsciiDocDocumentLoads and parses an AsciiDoc file using the runtime's UTF-8 BOM detection. 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(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 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(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 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 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 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 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 override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public AsciiDocSourceText Source { get; } #Original source text and line mapping.
public AsciiDocSyntaxTree SyntaxTree { get; } #Lossless syntax tree.
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.