# AsciiDocDocument

Parsed AsciiDoc document with a lossless syntax tree and typed editable top-level blocks.

Class 

`OfficeIMO.AsciiDoc`

**Namespace**

`OfficeIMO.AsciiDoc`

**Assembly**

`OfficeIMO.AsciiDoc`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[AsciiDocDocument.cs:48](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L48)

**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.

### Returned or exposed by 19

- Method [AsciiDocDelimitedBlock.GetBody](/api/ascii-doc/officeimo-asciidoc-asciidocdelimitedblock/#method-getbody-threading-cancellationtoken)
- Property [AsciiDocDelimitedBlock.Body](/api/ascii-doc/officeimo-asciidoc-asciidocdelimitedblock/#property-body)
- Method [AsciiDocDocument.Add](/api/ascii-doc/officeimo-asciidoc-asciidocdocument/#method-add-string-officeimo-asciidoc-asciidocparseoptions)
- Method [AsciiDocDocument.AddHeading](/api/ascii-doc/officeimo-asciidoc-asciidocdocument/#method-addheading-int32-string)
- Method [AsciiDocDocument.AddParagraph](/api/ascii-doc/officeimo-asciidoc-asciidocdocument/#method-addparagraph-string)
- Method [AsciiDocDocument.Create](/api/ascii-doc/officeimo-asciidoc-asciidocdocument/#method-create)
- Method [AsciiDocDocument.Load](/api/ascii-doc/officeimo-asciidoc-asciidocdocument/#method-load-io-stream-officeimo-asciidoc-asciidocparseoptions-text-encoding-threading-cancellationtoken)
- Method [AsciiDocDocument.LoadAsync](/api/ascii-doc/officeimo-asciidoc-asciidocdocument/#method-loadasync-string-officeimo-asciidoc-asciidocparseoptions-text-encoding-threading-cancellationtoken)
- Method [AsciiDocDocument.Move](/api/ascii-doc/officeimo-asciidoc-asciidocdocument/#method-move-officeimo-asciidoc-asciidocblock-int32)
- Method [AsciiDocDocument.Parse](/api/ascii-doc/officeimo-asciidoc-asciidocdocument/#method-parse-string-officeimo-asciidoc-asciidocparseoptions)
- Method [AsciiDocParseResult.RequireValue](/api/ascii-doc/officeimo-asciidoc-asciidocparseresult/#method-requirevalue)
- Property [AsciiDocParseResult.Document](/api/ascii-doc/officeimo-asciidoc-asciidocparseresult/#property-document)
- Property [AsciiDocParseResult.Value](/api/ascii-doc/officeimo-asciidoc-asciidocparseresult/#property-value)
- Property [AsciiDocProcessingResult.Document](/api/ascii-doc/officeimo-asciidoc-asciidocprocessingresult/#property-document)
- Property [AsciiDocProcessingResult.SourceDocument](/api/ascii-doc/officeimo-asciidoc-asciidocprocessingresult/#property-sourcedocument)
- Method [AsciiDocTableBlock.GetBody](/api/ascii-doc/officeimo-asciidoc-asciidoctableblock/#method-getbody-cancellationtoken)
- Property [AsciiDocTableBlock.Body](/api/ascii-doc/officeimo-asciidoc-asciidoctableblock/#property-body)
- Method [AsciiDocTableCell.GetBody](/api/ascii-doc/officeimo-asciidoc-asciidoctablecell/#method-getbody-threading-cancellationtoken)
- Property [AsciiDocTableCell.Body](/api/ascii-doc/officeimo-asciidoc-asciidoctablecell/#property-body)

### Accepted by parameters 2

- Method [AsciiDocCalloutCatalog.Create](/api/ascii-doc/officeimo-asciidoc-asciidoccalloutcatalog/#method-create-officeimo-asciidoc-asciidocdocument-int32-threading-cancellationtoken) parameter `document`
- Method [AsciiDocReferenceCatalog.Create](/api/ascii-doc/officeimo-asciidoc-asciidocreferencecatalog/#method-create-officeimo-asciidoc-asciidocdocument-int32-threading-cancellationtoken) parameter `document`

Filter members 

Show inherited

## Methods

`public AsciiDocDocument Add(string source, AsciiDocParseOptions? options = null)` [#](#method-add-string-officeimo-asciidoc-asciidocparseoptions)

[AsciiDocDocument.Authoring.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.Authoring.cs#L9)

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

Parameters

**source string required**

**options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional**

Returns

`AsciiDocDocument`

`public AsciiDocDocument AddHeading(int sectionLevel, string inlineSource)` [#](#method-addheading-int32-string)

[AsciiDocDocument.Authoring.cs:45](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.Authoring.cs#L45)

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

Parameters

**sectionLevel int required**

**inlineSource string required**

Returns

`AsciiDocDocument`

`public AsciiDocDocument AddParagraph(string inlineSource)` [#](#method-addparagraph-string)

[AsciiDocDocument.Authoring.cs:34](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.Authoring.cs#L34)

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

Parameters

**inlineSource string required**

Returns

`AsciiDocDocument`

Exceptions

- `ArgumentException` – The source is empty or contains more than one paragraph.

`public IEnumerable<TBlock> BlocksOfType<TBlock>()` [#](#method-blocksoftype)

[AsciiDocDocument.cs:90](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L90)

Enumerates blocks of a requested semantic type.

Type Parameters

**TBlock**

Returns

`IEnumerable<TBlock>`

`public static AsciiDocDocument Create()` [#](#method-create)

[AsciiDocDocument.Authoring.cs:5](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.Authoring.cs#L5)

Creates an empty editable AsciiDoc document.

Returns

`AsciiDocDocument`

`public IEnumerable<AsciiDocAttributeEntry> GetAttributeEntries(int maximumNestingDepth = 64, CancellationToken cancellationToken = default)` [#](#method-getattributeentries-int32-threading-cancellationtoken)

[AsciiDocDocument.cs:128](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L128)

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)` [#](#method-getattributes-collections-generic-ireadonlydictionary-system-string-system-string)

[AsciiDocDocument.cs:94](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L94)

Builds the effective document attribute set in source order.

Parameters

**initialValues System.Collections.Generic.IReadOnlyDictionary<string, string>? = null optional**

Returns

`AsciiDocDocumentAttributes`

GetBlockContexts 2 overloads

`public IEnumerable<AsciiDocBlockContext> GetBlockContexts(IReadOnlyDictionary<string, string>? initialValues = null, bool expandAssignmentValues = true)` [#](#method-getblockcontexts-collections-generic-ireadonlydictionary-system-string-system-string-boolean)

[AsciiDocDocument.cs:103](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L103)

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)` [#](#method-getblockcontexts-collections-generic-ireadonlydictionary-system-string-system-string-boolean-int32-threading-cancellationtoken)

[AsciiDocDocument.cs:108](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L108)

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)` [#](#method-insert-int32-string-officeimo-asciidoc-asciidocparseoptions)

[AsciiDocDocument.Authoring.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.Authoring.cs#L15)

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)` [#](#method-load-string-officeimo-asciidoc-asciidocparseoptions-text-encoding)

[AsciiDocDocument.cs:67](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L67)

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**

Returns

`AsciiDocDocument`

`public static AsciiDocDocument Load(string path, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken)` [#](#method-load-string-officeimo-asciidoc-asciidocparseoptions-text-encoding-threading-cancellationtoken)

[AsciiDocDocument.cs:79](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L79)

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**

Returns

`AsciiDocDocument`

`public static AsciiDocDocument Load(Stream stream, AsciiDocParseOptions? options = null, Encoding? encoding = null)` [#](#method-load-io-stream-officeimo-asciidoc-asciidocparseoptions-text-encoding)

[AsciiDocDocument.IO.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.IO.cs#L10)

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**

Returns

`AsciiDocDocument`

`public static AsciiDocDocument Load(Stream stream, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken)` [#](#method-load-io-stream-officeimo-asciidoc-asciidocparseoptions-text-encoding-threading-cancellationtoken)

[AsciiDocDocument.IO.cs:19](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.IO.cs#L19)

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**

Returns

`AsciiDocDocument`

LoadAsync 2 overloads

`public static async Task<AsciiDocDocument> LoadAsync(string path, AsciiDocParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default)` [#](#method-loadasync-string-officeimo-asciidoc-asciidocparseoptions-text-encoding-threading-cancellationtoken)

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)` [#](#method-loadasync-io-stream-officeimo-asciidoc-asciidocparseoptions-text-encoding-threading-cancellationtoken)

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)` [#](#method-loadresult-string-officeimo-asciidoc-asciidocparseoptions-text-encoding)

[AsciiDocDocument.cs:74](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L74)

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**

Returns

`AsciiDocParseResult`

`public static AsciiDocParseResult LoadResult(string path, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken)` [#](#method-loadresult-string-officeimo-asciidoc-asciidocparseoptions-text-encoding-threading-cancellationtoken)

[AsciiDocDocument.cs:83](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L83)

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**

Returns

`AsciiDocParseResult`

`public static AsciiDocParseResult LoadResult(Stream stream, AsciiDocParseOptions? options = null, Encoding? encoding = null)` [#](#method-loadresult-io-stream-officeimo-asciidoc-asciidocparseoptions-text-encoding)

[AsciiDocDocument.IO.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.IO.cs#L14)

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**

Returns

`AsciiDocParseResult`

`public static AsciiDocParseResult LoadResult(Stream stream, AsciiDocParseOptions? options, Encoding? encoding, CancellationToken cancellationToken)` [#](#method-loadresult-io-stream-officeimo-asciidoc-asciidocparseoptions-text-encoding-threading-cancellationtoken)

[AsciiDocDocument.IO.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.IO.cs#L23)

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**

Returns

`AsciiDocParseResult`

LoadResultAsync 2 overloads

`public static async Task<AsciiDocParseResult> LoadResultAsync(string path, AsciiDocParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default)` [#](#method-loadresultasync-string-officeimo-asciidoc-asciidocparseoptions-text-encoding-threading-cancellationtoken)

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)` [#](#method-loadresultasync-io-stream-officeimo-asciidoc-asciidocparseoptions-text-encoding-threading-cancellationtoken)

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)` [#](#method-move-officeimo-asciidoc-asciidocblock-int32)

[AsciiDocDocument.Authoring.cs:65](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.Authoring.cs#L65)

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**

Returns

`AsciiDocDocument`

Parse 2 overloads

`public static AsciiDocDocument Parse(string source, AsciiDocParseOptions? options = null)` [#](#method-parse-string-officeimo-asciidoc-asciidocparseoptions)

[AsciiDocDocument.cs:48](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L48)

Parses an AsciiDoc string into the typed document model.

Parameters

**source string required**

**options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional**

Returns

`AsciiDocDocument`

`public static AsciiDocDocument Parse(string source, AsciiDocParseOptions? options, CancellationToken cancellationToken)` [#](#method-parse-string-officeimo-asciidoc-asciidocparseoptions-threading-cancellationtoken)

[AsciiDocDocument.cs:56](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L56)

Parses an AsciiDoc string with cooperative cancellation.

Parameters

**source string required**

**options OfficeIMO.AsciiDoc.AsciiDocParseOptions? required**

**cancellationToken System.Threading.CancellationToken required**

Returns

`AsciiDocDocument`

ParseResult 2 overloads

`public static AsciiDocParseResult ParseResult(string source, AsciiDocParseOptions? options = null)` [#](#method-parseresult-string-officeimo-asciidoc-asciidocparseoptions)

[AsciiDocDocument.cs:52](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L52)

Parses an AsciiDoc string with syntax and recovery diagnostics.

Parameters

**source string required**

**options OfficeIMO.AsciiDoc.AsciiDocParseOptions? = null optional**

Returns

`AsciiDocParseResult`

`public static AsciiDocParseResult ParseResult(string source, AsciiDocParseOptions? options, CancellationToken cancellationToken)` [#](#method-parseresult-string-officeimo-asciidoc-asciidocparseoptions-threading-cancellationtoken)

[AsciiDocDocument.cs:60](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L60)

Parses source with recovery diagnostics and cooperative cancellation.

Parameters

**source string required**

**options OfficeIMO.AsciiDoc.AsciiDocParseOptions? required**

**cancellationToken System.Threading.CancellationToken required**

Returns

`AsciiDocParseResult`

`public bool Remove(AsciiDocBlock block)` [#](#method-remove-officeimo-asciidoc-asciidocblock)

[AsciiDocDocument.Authoring.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.Authoring.cs#L53)

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)` [#](#method-save-string-officeimo-asciidoc-asciidocwriteroptions-text-encoding)

[AsciiDocDocument.IO.cs:75](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.IO.cs#L75)

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)` [#](#method-save-io-stream-officeimo-asciidoc-asciidocwriteroptions-text-encoding)

[AsciiDocDocument.IO.cs:82](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.IO.cs#L82)

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)` [#](#method-saveasync-string-officeimo-asciidoc-asciidocwriteroptions-text-encoding-threading-cancellationtoken)

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)` [#](#method-saveasync-io-stream-officeimo-asciidoc-asciidocwriteroptions-text-encoding-threading-cancellationtoken)

[AsciiDocDocument.IO.cs:105](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.IO.cs#L105)

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()` [#](#method-toasciidoc)

[AsciiDocDocument.cs:143](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L143)

Writes this document using preserve mode.

Returns

`string`

`public string ToAsciiDoc(AsciiDocWriterMode mode)` [#](#method-toasciidoc-officeimo-asciidoc-asciidocwritermode)

[AsciiDocDocument.cs:147](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L147)

Writes this document using the requested mode.

Parameters

**mode OfficeIMO.AsciiDoc.AsciiDocWriterMode required**

Returns

`string`

`public string ToAsciiDoc(AsciiDocWriterOptions? options)` [#](#method-toasciidoc-officeimo-asciidoc-asciidocwriteroptions)

[AsciiDocDocument.cs:150](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L150)

Writes this document with explicit options.

Parameters

**options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? required**

Returns

`string`

`public byte[] ToBytes(AsciiDocWriterOptions? options = null, Encoding? encoding = null)` [#](#method-tobytes-officeimo-asciidoc-asciidocwriteroptions-text-encoding)

[AsciiDocDocument.IO.cs:71](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.IO.cs#L71)

Encodes the current document text.

Parameters

**options OfficeIMO.AsciiDoc.AsciiDocWriterOptions? = null optional**

**encoding System.Text.Encoding? = null optional**

Returns

`byte[]`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public AsciiDocSourceText Source { get; }` [#](#property-source)

[AsciiDocDocument.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L27)

Original source text and line mapping.

`public AsciiDocSyntaxTree SyntaxTree { get; }` [#](#property-syntaxtree)

[AsciiDocDocument.cs:30](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L30)

Lossless syntax tree.

`public AsciiDocDocumentProfile Profile { get; }` [#](#property-profile)

[AsciiDocDocument.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L33)

Selected bounded document profile.

`public IReadOnlyList<AsciiDocBlock> Blocks { get; }` [#](#property-blocks)

[AsciiDocDocument.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L36)

Typed top-level source blocks, including trivia and comments.

`public IReadOnlyList<AsciiDocDiagnostic> Diagnostics { get; }` [#](#property-diagnostics)

[AsciiDocDocument.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L39)

Parser and recovery diagnostics.

`public bool IsModified { get; }` [#](#property-ismodified)

[AsciiDocDocument.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc/AsciiDocDocument.cs#L42)

True when any editable block or list item has changed.

<!-- PowerForge markdown artifact sha256:9467B8FD0688B79E51D0EB881D057DE96DD9038B1DF183AD7013845B068CE4E8 -->
