# DocBookDocument

Source-preserving DocBook 4/5 document with a bounded typed common-structure API and extension access.

Class 

`OfficeIMO.DocBook`

**Namespace**

`OfficeIMO.DocBook`

**Assembly**

`OfficeIMO.DocBook`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[DocBookDocument.cs:64](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L64)

**Modifiers**

sealed

Source-preserving DocBook 4/5 document with a bounded typed common-structure API and extension access.

## Inheritance

- object
- DocBookDocument

## Usage

Explore 6 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 6

- Method [DocBookDocument.CreateArticle](/api/doc-book/officeimo-docbook-docbookdocument/#method-createarticle-officeimo-docbook-docbookprofile)
- Method [DocBookDocument.CreateBook](/api/doc-book/officeimo-docbook-docbookdocument/#method-createbook-officeimo-docbook-docbookprofile)
- Method [DocBookDocument.FromOfficeDocumentModel](/api/doc-book/officeimo-docbook-docbookdocument/#method-fromofficedocumentmodel-officeimo-officedocumentmodel-nullable-officeimo-docbook-docbookdocumentkind-nullable-officeimo-docbook-docbookprofile-officeimo-docbook-docbookconversionoptions)
- Method [DocBookDocument.Load](/api/doc-book/officeimo-docbook-docbookdocument/#method-load-string-officeimo-docbook-docbookloadoptions-threading-cancellationtoken)
- Method [DocBookDocument.LoadAsync](/api/doc-book/officeimo-docbook-docbookdocument/#method-loadasync-io-stream-officeimo-docbook-docbookloadoptions-threading-cancellationtoken)
- Method [DocBookDocument.Parse](/api/doc-book/officeimo-docbook-docbookdocument/#method-parse-string-officeimo-docbook-docbookloadoptions-threading-cancellationtoken)

Filter members 

Show inherited

## Methods

`public DocBookNode AddParagraph(string text)` [#](#method-addparagraph-string)

[DocBookDocument.cs:121](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L121)

Adds a top-level paragraph, creating a chapter container first for a book.

Parameters

**text string required**

Returns

`DocBookNode`

`public DocBookNode AddSection(string title)` [#](#method-addsection-string)

[DocBookDocument.cs:119](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L119)

Adds a top-level section, creating a chapter container first for a book.

Parameters

**title string required**

Returns

`DocBookNode`

`public static DocBookDocument CreateArticle(DocBookProfile profile = DocBook52)` [#](#method-createarticle-officeimo-docbook-docbookprofile)

[DocBookDocument.cs:64](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L64)

Creates an article using the exact selected writer profile.

Parameters

**profile OfficeIMO.DocBook.DocBookProfile = DocBook52 optional**

Returns

`DocBookDocument`

`public static DocBookDocument CreateBook(DocBookProfile profile = DocBook52)` [#](#method-createbook-officeimo-docbook-docbookprofile)

[DocBookDocument.cs:66](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L66)

Creates a book using the exact selected writer profile.

Parameters

**profile OfficeIMO.DocBook.DocBookProfile = DocBook52 optional**

Returns

`DocBookDocument`

`public static DocBookConversionResult<DocBookDocument> FromOfficeDocumentModel(OfficeDocumentModel model, DocBookDocumentKind? kind = null, DocBookProfile? profile = null, DocBookConversionOptions? options = null)` [#](#method-fromofficedocumentmodel-officeimo-officedocumentmodel-nullable-officeimo-docbook-docbookdocumentkind-nullable-officeimo-docbook-docbookprofile-officeimo-docbook-docbookconversionoptions)

[DocBookDocument.Conversion.cs:606](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.Conversion.cs#L606)

Creates an article or book from the shared recursive common structure.

Parameters

**model OfficeIMO.OfficeDocumentModel required**

**kind OfficeIMO.DocBook.DocBookDocumentKind? = null optional**

**profile OfficeIMO.DocBook.DocBookProfile? = null optional**

**options OfficeIMO.DocBook.DocBookConversionOptions? = null optional**

Returns

`DocBookConversionResult<DocBookDocument>`

Load 2 overloads

`public static DocBookDocument Load(string path, DocBookLoadOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-load-string-officeimo-docbook-docbookloadoptions-threading-cancellationtoken)

[DocBookDocument.cs:98](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L98)

Loads a DocBook file.

Parameters

**path string required**

**options OfficeIMO.DocBook.DocBookLoadOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`DocBookDocument`

`public static DocBookDocument Load(Stream stream, DocBookLoadOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-load-io-stream-officeimo-docbook-docbookloadoptions-threading-cancellationtoken)

[DocBookDocument.cs:106](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L106)

Loads DocBook from a caller-owned stream while preserving seekable position.

Parameters

**stream System.IO.Stream required**

**options OfficeIMO.DocBook.DocBookLoadOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`DocBookDocument`

`public static async Task<DocBookDocument> LoadAsync(Stream stream, DocBookLoadOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-loadasync-io-stream-officeimo-docbook-docbookloadoptions-threading-cancellationtoken)

Loads DocBook asynchronously from a caller-owned stream.

Parameters

**stream System.IO.Stream required**

**options OfficeIMO.DocBook.DocBookLoadOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<DocBookDocument>`

`public static DocBookDocument Parse(string text, DocBookLoadOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-parse-string-officeimo-docbook-docbookloadoptions-threading-cancellationtoken)

[DocBookDocument.cs:84](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L84)

Parses DocBook text using secure, bounded XML settings.

Parameters

**text string required**

**options OfficeIMO.DocBook.DocBookLoadOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`DocBookDocument`

Save 3 overloads

`public void Save(Stream destination, DocBookSaveOptions? options = null)` [#](#method-save-io-stream-officeimo-docbook-docbooksaveoptions)

[DocBookDocument.cs:387](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L387)

Writes to a caller-owned stream.

Parameters

**destination System.IO.Stream required**

**options OfficeIMO.DocBook.DocBookSaveOptions? = null optional**

`public void Save(DocBookSaveOptions? options = null)` [#](#method-save-officeimo-docbook-docbooksaveoptions)

[DocBookDocument.cs:393](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L393)

Saves to the associated path, failing when no destination is associated.

Parameters

**options OfficeIMO.DocBook.DocBookSaveOptions? = null optional**

`public void Save(string path, DocBookSaveOptions? options = null)` [#](#method-save-string-officeimo-docbook-docbooksaveoptions)

[DocBookDocument.cs:397](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L397)

Atomically saves native output and associates the successfully written path.

Parameters

**path string required**

**options OfficeIMO.DocBook.DocBookSaveOptions? = null optional**

SaveAsync 3 overloads

`public Task SaveAsync(Stream destination, DocBookSaveOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasync-io-stream-officeimo-docbook-docbooksaveoptions-threading-cancellationtoken)

[DocBookDocument.cs:390](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L390)

Writes asynchronously to a caller-owned stream.

Parameters

**destination System.IO.Stream required**

**options OfficeIMO.DocBook.DocBookSaveOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task`

`public Task SaveAsync(DocBookSaveOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasync-officeimo-docbook-docbooksaveoptions-threading-cancellationtoken)

[DocBookDocument.cs:404](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L404)

Asynchronously saves to the associated path.

Parameters

**options OfficeIMO.DocBook.DocBookSaveOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task`

`public async Task SaveAsync(string path, DocBookSaveOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasync-string-officeimo-docbook-docbooksaveoptions-threading-cancellationtoken)

Atomically saves native output asynchronously and associates the successfully written path.

Parameters

**path string required**

**options OfficeIMO.DocBook.DocBookSaveOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task`

`public byte[] ToBytes(DocBookSaveOptions? options = null)` [#](#method-tobytes-officeimo-docbook-docbooksaveoptions)

[DocBookDocument.cs:679](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L679)

Serializes native bytes, preserving an unchanged source when requested.

Parameters

**options OfficeIMO.DocBook.DocBookSaveOptions? = null optional**

Returns

`byte[]`

`public string ToDocBook(DocBookSaveOptions? options = null)` [#](#method-todocbook-officeimo-docbook-docbooksaveoptions)

[DocBookDocument.cs:378](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L378)

Returns DocBook XML, preserving the exact unchanged source by default.

Parameters

**options OfficeIMO.DocBook.DocBookSaveOptions? = null optional**

Returns

`string`

`public DocBookConversionResult<OfficeDocumentModel> ToOfficeDocumentModel(string? sourcePath = null, DocBookConversionOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toofficedocumentmodel-string-officeimo-docbook-docbookconversionoptions-threading-cancellationtoken)

[DocBookDocument.Conversion.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.Conversion.cs#L14)

Converts the typed common structure to the shared recursive document model.

Parameters

**sourcePath string? = null optional**

**options OfficeIMO.DocBook.DocBookConversionOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`DocBookConversionResult<OfficeDocumentModel>`

`public DocBookValidationResult Validate(DocBookValidationOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-validate-officeimo-docbook-docbookvalidationoptions-threading-cancellationtoken)

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

Validates the bounded OfficeIMO common-structure profile. The returned result explicitly does not represent a complete external DTD, RELAX NG, Schematron, XInclude, assembly, or vocabulary-extension validation run.

Parameters

**options OfficeIMO.DocBook.DocBookValidationOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`DocBookValidationResult`

## 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 string? FilePath { get; }` [#](#property-filepath)

[DocBookDocument.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L14)

Gets the associated path, or null for an in-memory document.

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

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

Exact writer and bounded-validation profile selected for this document.

`public DocBookSchemaProfile SchemaProfile { get; }` [#](#property-schemaprofile)

[DocBookDocument.cs:35](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L35)

Exact official schema identifiers associated with [DocBookDocument.Profile](/api/doc-book/officeimo-docbook-docbookdocument/).

`public DocBookDocumentKind Kind { get; }` [#](#property-kind)

[DocBookDocument.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L37)

Document root kind.

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

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

True after a typed mutation or while the backing XML differs from its loaded form.

`public DocBookNode Root { get; }` [#](#property-root)

[DocBookDocument.cs:41](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L41)

Root element as a typed common node.

`public XDocument Xml { get; }` [#](#property-xml)

[DocBookDocument.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L43)

Underlying XML for extension inspection and advanced lossless editing.

`public string? Title { get; set; }` [#](#property-title)

[DocBookDocument.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookDocument.cs#L50)

Document title from the root metadata/title.

<!-- PowerForge markdown artifact sha256:E87436A8F5AF9EC526865D1CF64B163637C296411D5DCC13D0FC2C0DDA105E99 -->
