Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

AsciiDocDocument

OfficeIMO.AsciiDoc

Namespace
OfficeIMO.AsciiDoc
Assembly
OfficeIMO.AsciiDoc
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

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.

Accepted by parameters 2

Methods

public AsciiDocDocument Add(string source, AsciiDocParseOptions? options = null) #

Appends parsed AsciiDoc blocks, including their metadata and source trivia.

Parameters

source string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
public AsciiDocDocument AddHeading(int sectionLevel, string inlineSource) #

Appends a section heading. Section levels 1 through 5 use two through six equals signs.

Parameters

sectionLevel int required
inlineSource string required
public AsciiDocDocument AddParagraph(string inlineSource) #

Appends a paragraph with native inline syntax while protecting block-start syntax.

Parameters

inlineSource string required

Exceptions

  • ArgumentException – The source is empty or contains more than one paragraph.
public IEnumerable<TBlock> BlocksOfType<TBlock>() #

Enumerates blocks of a requested semantic type.

Type Parameters

TBlock

Returns

IEnumerable<TBlock>
public static AsciiDocDocument Create() #

Creates an empty editable AsciiDoc document.

public IEnumerable<AsciiDocAttributeEntry> GetAttributeEntries(int maximumNestingDepth = 64, CancellationToken cancellationToken = default) #

Enumerates attribute entries in source order, including compound bodies, with a bounded traversal depth.

Parameters

maximumNestingDepth int = 64 optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IEnumerable<AsciiDocAttributeEntry>
public AsciiDocDocumentAttributes GetAttributes(IReadOnlyDictionary<string, string>? initialValues = null) #

Builds the effective document attribute set in source order.

Parameters

initialValues System.Collections.Generic.IReadOnlyDictionary<string, string>? = null optional
GetBlockContexts 2 overloads
public IEnumerable<AsciiDocBlockContext> GetBlockContexts(IReadOnlyDictionary<string, string>? initialValues = null, bool expandAssignmentValues = true) #

Enumerates source blocks with immutable attribute snapshots in document order.

Parameters

initialValues System.Collections.Generic.IReadOnlyDictionary<string, string>? = null optional
expandAssignmentValues bool = true optional

Returns

IEnumerable<AsciiDocBlockContext>
public IEnumerable<AsciiDocBlockContext> GetBlockContexts(IReadOnlyDictionary<string, string>? initialValues, bool expandAssignmentValues, int maximumNestingDepth, CancellationToken cancellationToken = default) #

Enumerates attribute snapshots with bounded compound traversal and cooperative cancellation.

Parameters

initialValues System.Collections.Generic.IReadOnlyDictionary<string, string>? required
expandAssignmentValues bool required
maximumNestingDepth int required
cancellationToken System.Threading.CancellationToken = default optional

Returns

IEnumerable<AsciiDocBlockContext>
public IReadOnlyList<AsciiDocBlock> Insert(int index, string source, AsciiDocParseOptions? options = null) #

Inserts parsed AsciiDoc blocks at a zero-based source-block index.

Parameters

index int required
source string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional

Returns

IReadOnlyList<AsciiDocBlock>
Load 4 overloads
public static AsciiDocDocument Load(string path, AsciiDocParseOptions? options = null, Encoding? encoding = null) #

Loads 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 string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
encoding System.Text.Encoding? = null optional
public static AsciiDocDocument Load(string path, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken) #

Loads and parses an AsciiDoc file with cooperative cancellation.

Parameters

path string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? required
encoding System.Text.Encoding? required
cancellationToken System.Threading.CancellationToken required
public static AsciiDocDocument Load(Stream stream, AsciiDocParseOptions? options = null, Encoding? encoding = null) #

Loads and parses an AsciiDoc document from a caller-owned stream.

Parameters

stream System.IO.Stream required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
encoding System.Text.Encoding? = null optional
public static AsciiDocDocument Load(Stream stream, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken) #

Loads bounded text with cooperative cancellation while preserving the caller's stream.

Parameters

stream System.IO.Stream required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? required
encoding System.Text.Encoding? required
cancellationToken System.Threading.CancellationToken required
LoadAsync 2 overloads
public static async Task<AsciiDocDocument> LoadAsync(string path, AsciiDocParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #

Asynchronously loads and parses an AsciiDoc file.

Parameters

path string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
encoding System.Text.Encoding? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<AsciiDocDocument>
public static async Task<AsciiDocDocument> LoadAsync(Stream stream, AsciiDocParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #

Asynchronously loads and parses an AsciiDoc document from a caller-owned stream.

Parameters

stream System.IO.Stream required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
encoding System.Text.Encoding? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<AsciiDocDocument>
LoadResult 4 overloads
public static AsciiDocParseResult LoadResult(string path, AsciiDocParseOptions? options = null, Encoding? encoding = null) #

Loads an AsciiDoc file with its lossless syntax and recovery diagnostics. Retains decoded characters and line endings, not original encoding or BOM bytes.

Parameters

path string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
encoding System.Text.Encoding? = null optional
public static AsciiDocParseResult LoadResult(string path, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken) #

Loads a bounded AsciiDoc file and returns recovery diagnostics with cooperative cancellation.

Parameters

path string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? required
encoding System.Text.Encoding? required
cancellationToken System.Threading.CancellationToken required
public static AsciiDocParseResult LoadResult(Stream stream, AsciiDocParseOptions? options = null, Encoding? encoding = null) #

Loads an AsciiDoc document from a caller-owned stream with syntax and recovery diagnostics.

Parameters

stream System.IO.Stream required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
encoding System.Text.Encoding? = null optional
public static AsciiDocParseResult LoadResult(Stream stream, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken) #

Loads bounded text and returns recovery diagnostics with cooperative cancellation.

Parameters

stream System.IO.Stream required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? required
encoding System.Text.Encoding? required
cancellationToken System.Threading.CancellationToken required
LoadResultAsync 2 overloads
public static async Task<AsciiDocParseResult> LoadResultAsync(string path, AsciiDocParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #

Asynchronously loads an AsciiDoc file with syntax and recovery diagnostics.

Parameters

path string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
encoding System.Text.Encoding? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<AsciiDocParseResult>
public static async Task<AsciiDocParseResult> LoadResultAsync(Stream stream, AsciiDocParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #

Asynchronously loads an AsciiDoc stream with syntax and recovery diagnostics.

Parameters

stream System.IO.Stream required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
encoding System.Text.Encoding? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<AsciiDocParseResult>
public AsciiDocDocument Move(AsciiDocBlock block, int index) #

Moves a semantic block and its bound metadata and attachments before the original zero-based index.

Parameters

block OfficeIMO.AsciiDoc.AsciiDocBlock required
index int required
Parse 2 overloads
public static AsciiDocDocument Parse(string source, AsciiDocParseOptions? options = null) #

Parses an AsciiDoc string into the typed document model.

Parameters

source string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
public static AsciiDocDocument Parse(string source, AsciiDocParseOptions? options, CancellationToken cancellationToken) #

Parses an AsciiDoc string with cooperative cancellation.

Parameters

source string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? required
cancellationToken System.Threading.CancellationToken required
ParseResult 2 overloads
public static AsciiDocParseResult ParseResult(string source, AsciiDocParseOptions? options = null) #

Parses an AsciiDoc string with syntax and recovery diagnostics.

Parameters

source string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional
public static AsciiDocParseResult ParseResult(string source, AsciiDocParseOptions? options, CancellationToken cancellationToken) #

Parses source with recovery diagnostics and cooperative cancellation.

Parameters

source string required
options OfficeIMO.AsciiDoc.AsciiDocParseOptions? required
cancellationToken System.Threading.CancellationToken required
public bool Remove(AsciiDocBlock block) #

Removes a semantic block together with its bound metadata and list attachments.

Parameters

block OfficeIMO.AsciiDoc.AsciiDocBlock required

Returns

bool
Save 2 overloads
public void Save(string path, AsciiDocWriterOptions? options = null, Encoding? encoding = null) #

Saves the current document text to a file.

Parameters

path string required
options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null optional
encoding System.Text.Encoding? = null optional
public void Save(Stream stream, AsciiDocWriterOptions? options = null, Encoding? encoding = null) #

Writes the current document text to a caller-owned stream.

Parameters

stream System.IO.Stream required
options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null optional
encoding System.Text.Encoding? = null optional
SaveAsync 2 overloads
public async Task SaveAsync(string path, AsciiDocWriterOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #

Asynchronously saves the current document text to a file.

Parameters

path string required
options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null optional
encoding System.Text.Encoding? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task
public Task SaveAsync(Stream stream, AsciiDocWriterOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #

Asynchronously writes the current document text to a caller-owned stream.

Parameters

stream System.IO.Stream required
options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null optional
encoding System.Text.Encoding? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task
ToAsciiDoc 3 overloads
public string ToAsciiDoc() #

Writes this document using preserve mode.

Returns

string
public string ToAsciiDoc(AsciiDocWriterMode mode) #

Writes this document using the requested mode.

Parameters

mode OfficeIMO.AsciiDoc.AsciiDocWriterMode required

Returns

string
public string ToAsciiDoc(AsciiDocWriterOptions? options) #

Writes this document with explicit options.

Parameters

options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? required

Returns

string
public byte[] ToBytes(AsciiDocWriterOptions? options = null, Encoding? encoding = null) #

Encodes the current document text.

Parameters

options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null optional
encoding System.Text.Encoding? = null optional

Returns

byte[]

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 bool IsModified { get; } #

True when any editable block or list item has changed.