# DocBookNode

Typed common-structure view over a DocBook element. Unknown elements and attributes remain in the backing XML.

Class 

`OfficeIMO.DocBook`

**Namespace**

`OfficeIMO.DocBook`

**Assembly**

`OfficeIMO.DocBook`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

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

**Modifiers**

sealed

Typed common-structure view over a DocBook element. Unknown elements and attributes remain in the backing XML.

## Inheritance

- object
- DocBookNode

## Usage

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

- Method [DocBookDocument.AddParagraph](/api/doc-book/officeimo-docbook-docbookdocument/#method-addparagraph-string)
- Method [DocBookDocument.AddSection](/api/doc-book/officeimo-docbook-docbookdocument/#method-addsection-string)
- Property [DocBookDocument.Root](/api/doc-book/officeimo-docbook-docbookdocument/#property-root)
- Method [DocBookNode.Add](/api/doc-book/officeimo-docbook-docbooknode/#method-add-officeimo-docbook-docbooknodekind-string)
- Method [DocBookNode.AddAdmonition](/api/doc-book/officeimo-docbook-docbooknode/#method-addadmonition-officeimo-docbook-docbooknodekind-string)
- Method [DocBookNode.AddExtension](/api/doc-book/officeimo-docbook-docbooknode/#method-addextension-xml-linq-xname-string)
- Method [DocBookNode.AddImage](/api/doc-book/officeimo-docbook-docbooknode/#method-addimage-string-string)
- Method [DocBookNode.AddIndexTerm](/api/doc-book/officeimo-docbook-docbooknode/#method-addindexterm-string)
- Method [DocBookNode.AddItemizedList](/api/doc-book/officeimo-docbook-docbooknode/#method-additemizedlist)
- Method [DocBookNode.AddLink](/api/doc-book/officeimo-docbook-docbooknode/#method-addlink-string-string)
- Method [DocBookNode.AddListItem](/api/doc-book/officeimo-docbook-docbooknode/#method-addlistitem-string)
- Method [DocBookNode.AddOrderedList](/api/doc-book/officeimo-docbook-docbooknode/#method-addorderedlist)
- Method [DocBookNode.AddParagraph](/api/doc-book/officeimo-docbook-docbooknode/#method-addparagraph-string)
- Method [DocBookNode.AddProgramListing](/api/doc-book/officeimo-docbook-docbooknode/#method-addprogramlisting-string-string)
- Method [DocBookNode.AddSection](/api/doc-book/officeimo-docbook-docbooknode/#method-addsection-string)
- Method [DocBookNode.AddTable](/api/doc-book/officeimo-docbook-docbooknode/#method-addtable-string)
- Property [DocBookNode.Children](/api/doc-book/officeimo-docbook-docbooknode/#property-children)

Filter members 

Show inherited

## Methods

`public DocBookNode Add(DocBookNodeKind kind, string? text = null)` [#](#method-add-officeimo-docbook-docbooknodekind-string)

[DocBookNode.cs:126](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L126)

Adds a supported common node.

Parameters

**kind OfficeIMO.DocBook.DocBookNodeKind required**

**text string? = null optional**

Returns

`DocBookNode`

`public DocBookNode AddAdmonition(DocBookNodeKind kind, string text)` [#](#method-addadmonition-officeimo-docbook-docbooknodekind-string)

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

Adds an admonition such as note, tip, important, caution, or warning.

Parameters

**kind OfficeIMO.DocBook.DocBookNodeKind required**

**text string required**

Returns

`DocBookNode`

`public DocBookNode AddExtension(XName name, string? text = null)` [#](#method-addextension-xml-linq-xname-string)

[DocBookNode.cs:164](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L164)

Adds an extension element without claiming typed vocabulary support.

Parameters

**name System.Xml.Linq.XName required**

**text string? = null optional**

Returns

`DocBookNode`

AddImage 2 overloads

`public DocBookNode AddImage(string fileReference, string? caption = null)` [#](#method-addimage-string-string)

[DocBookNode.cs:105](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L105)

Adds an image media object.

Parameters

**fileReference string required**

**caption string? = null optional**

Returns

`DocBookNode`

`public DocBookNode AddImage(string fileReference, string? caption, string? alternateText)` [#](#method-addimage-string-string-string)

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

Adds an image media object with distinct caption and alternative text.

Parameters

**fileReference string required**

**caption string? required**

**alternateText string? required**

Returns

`DocBookNode`

`public DocBookNode AddIndexTerm(string primary)` [#](#method-addindexterm-string)

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

Adds an index term.

Parameters

**primary string required**

Returns

`DocBookNode`

`public DocBookNode AddItemizedList()` [#](#method-additemizedlist)

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

Adds an itemized list.

Returns

`DocBookNode`

`public DocBookNode AddLink(string text, string href)` [#](#method-addlink-string-string)

[DocBookNode.cs:80](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L80)

Adds an external link.

Parameters

**text string required**

**href string required**

Returns

`DocBookNode`

`public DocBookNode AddListItem(string text)` [#](#method-addlistitem-string)

[DocBookNode.cs:61](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L61)

Adds a list item containing a paragraph.

Parameters

**text string required**

Returns

`DocBookNode`

`public DocBookNode AddOrderedList()` [#](#method-addorderedlist)

[DocBookNode.cs:58](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L58)

Adds an ordered list.

Returns

`DocBookNode`

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

[DocBookNode.cs:54](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L54)

Adds a paragraph.

Parameters

**text string required**

Returns

`DocBookNode`

`public DocBookNode AddProgramListing(string code, string? language = null)` [#](#method-addprogramlisting-string-string)

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

Adds a program listing.

Parameters

**code string required**

**language string? = null optional**

Returns

`DocBookNode`

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

[DocBookNode.cs:49](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L49)

Adds a section with a title.

Parameters

**title string required**

Returns

`DocBookNode`

`public DocBookNode AddTable(string? title = null)` [#](#method-addtable-string)

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

Adds a table.

Parameters

**title string? = null optional**

Returns

`DocBookNode`

`public string? GetAttribute(XName name)` [#](#method-getattribute-xml-linq-xname)

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

Gets any standard or extension attribute.

Parameters

**name System.Xml.Linq.XName required**

Returns

`string?`

`public void Remove()` [#](#method-remove)

[DocBookNode.cs:172](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L172)

Removes this node.

`public void SetAttribute(XName name, string? value)` [#](#method-setattribute-xml-linq-xname-string)

[DocBookNode.cs:45](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L45)

Sets or removes any standard or extension attribute.

Parameters

**name System.Xml.Linq.XName required**

**value string? required**

## 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 DocBookNodeKind Kind { get; }` [#](#property-kind)

[DocBookNode.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L15)

Common structure kind, or Unknown for a preserved extension element.

`public string Name { get; }` [#](#property-name)

[DocBookNode.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L17)

Element local name.

`public string Text { get; set; }` [#](#property-text)

[DocBookNode.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L20)

Combined descendant text. Setting it intentionally replaces child content; element-only typed nodes reject direct text.

`public IReadOnlyDictionary<XName, string> Attributes { get; }` [#](#property-attributes)

[DocBookNode.cs:38](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L38)

All attributes, including namespaced extension attributes.

`public IReadOnlyList<DocBookNode> Children { get; }` [#](#property-children)

[DocBookNode.cs:40](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookNode.cs#L40)

Child elements in source order.

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