# DocBookNodeKind

Common structures with typed authoring support.

Enum 

`OfficeIMO.DocBook`

**Namespace**

`OfficeIMO.DocBook`

**Assembly**

`OfficeIMO.DocBook`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[DocBookContracts.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L23)

**Base**

`Enum`

**Implements**

`IComparable` `ISpanFormattable` `IFormattable` `IConvertible`

**Modifiers**

sealed

Common structures with typed authoring support.

## Inheritance

- Enum
- DocBookNodeKind

## Usage

Explore 36 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 34

- Property [DocBookNode.Kind](/api/doc-book/officeimo-docbook-docbooknode/#property-kind)
- Field [DocBookNodeKind.Author](/api/doc-book/officeimo-docbook-docbooknodekind/#field-author)
- Field [DocBookNodeKind.Caption](/api/doc-book/officeimo-docbook-docbooknodekind/#field-caption)
- Field [DocBookNodeKind.Caution](/api/doc-book/officeimo-docbook-docbooknodekind/#field-caution)
- Field [DocBookNodeKind.CrossReference](/api/doc-book/officeimo-docbook-docbooknodekind/#field-crossreference)
- Field [DocBookNodeKind.Entry](/api/doc-book/officeimo-docbook-docbooknodekind/#field-entry)
- Field [DocBookNodeKind.Figure](/api/doc-book/officeimo-docbook-docbooknodekind/#field-figure)
- Field [DocBookNodeKind.ImageData](/api/doc-book/officeimo-docbook-docbooknodekind/#field-imagedata)
- Field [DocBookNodeKind.ImageObject](/api/doc-book/officeimo-docbook-docbooknodekind/#field-imageobject)
- Field [DocBookNodeKind.Important](/api/doc-book/officeimo-docbook-docbooknodekind/#field-important)
- Field [DocBookNodeKind.Index](/api/doc-book/officeimo-docbook-docbooknodekind/#field-index)
- Field [DocBookNodeKind.IndexTerm](/api/doc-book/officeimo-docbook-docbooknodekind/#field-indexterm)
- Field [DocBookNodeKind.Info](/api/doc-book/officeimo-docbook-docbooknodekind/#field-info)
- Field [DocBookNodeKind.ItemizedList](/api/doc-book/officeimo-docbook-docbooknodekind/#field-itemizedlist)
- Field [DocBookNodeKind.Link](/api/doc-book/officeimo-docbook-docbooknodekind/#field-link)
- Field [DocBookNodeKind.ListItem](/api/doc-book/officeimo-docbook-docbooknodekind/#field-listitem)
- Field [DocBookNodeKind.MediaObject](/api/doc-book/officeimo-docbook-docbooknodekind/#field-mediaobject)
- Field [DocBookNodeKind.Note](/api/doc-book/officeimo-docbook-docbooknodekind/#field-note)
- Field [DocBookNodeKind.OrderedList](/api/doc-book/officeimo-docbook-docbooknodekind/#field-orderedlist)
- Field [DocBookNodeKind.Paragraph](/api/doc-book/officeimo-docbook-docbooknodekind/#field-paragraph)
- Field [DocBookNodeKind.ProgramListing](/api/doc-book/officeimo-docbook-docbooknodekind/#field-programlisting)
- Field [DocBookNodeKind.Row](/api/doc-book/officeimo-docbook-docbooknodekind/#field-row)
- Field [DocBookNodeKind.Screen](/api/doc-book/officeimo-docbook-docbooknodekind/#field-screen)
- Field [DocBookNodeKind.Section](/api/doc-book/officeimo-docbook-docbooknodekind/#field-section)
- Field [DocBookNodeKind.Subtitle](/api/doc-book/officeimo-docbook-docbooknodekind/#field-subtitle)
- Field [DocBookNodeKind.Table](/api/doc-book/officeimo-docbook-docbooknodekind/#field-table)
- Field [DocBookNodeKind.TableBody](/api/doc-book/officeimo-docbook-docbooknodekind/#field-tablebody)
- Field [DocBookNodeKind.TableGroup](/api/doc-book/officeimo-docbook-docbooknodekind/#field-tablegroup)
- Field [DocBookNodeKind.TableHead](/api/doc-book/officeimo-docbook-docbooknodekind/#field-tablehead)
- Field [DocBookNodeKind.Tip](/api/doc-book/officeimo-docbook-docbooknodekind/#field-tip)
- Field [DocBookNodeKind.Title](/api/doc-book/officeimo-docbook-docbooknodekind/#field-title)
- Field [DocBookNodeKind.Unknown](/api/doc-book/officeimo-docbook-docbooknodekind/#field-unknown)
- Field [DocBookNodeKind.VariableList](/api/doc-book/officeimo-docbook-docbooknodekind/#field-variablelist)
- Field [DocBookNodeKind.Warning](/api/doc-book/officeimo-docbook-docbooknodekind/#field-warning)

### Accepted by parameters 2

- Method [DocBookNode.Add](/api/doc-book/officeimo-docbook-docbooknode/#method-add-officeimo-docbook-docbooknodekind-string) parameter `kind`
- Method [DocBookNode.AddAdmonition](/api/doc-book/officeimo-docbook-docbooknode/#method-addadmonition-officeimo-docbook-docbooknodekind-string) parameter `kind`

Filter members 

Show inherited

## Inherited Methods

`public int CompareTo(object? target)` [#](#method-compareto-object)

Inherited from Enum

Parameters

**target object? required**

Returns

`int`

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

Inherited from Enum

Parameters

**obj object? required**

Returns

`bool`

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

Inherited from Enum

Returns

`int`

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

Inherited from object

Returns

`Type`

`public TypeCode GetTypeCode()` [#](#method-gettypecode)

Inherited from Enum

Returns

`TypeCode`

`public bool HasFlag(Enum flag)` [#](#method-hasflag-enum)

Inherited from Enum

Parameters

**flag Enum required**

Returns

`bool`

ToString 4 overloads

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

Inherited from Enum

Returns

`string`

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

Inherited from Enum

Parameters

**format string? required**

Returns

`string`

`public string ToString(IFormatProvider? provider)` [#](#method-tostring-iformatprovider)

Inherited from Enum

`Obsolete("The provider argument is not used. Use ToString() instead.")`

Parameters

**provider IFormatProvider? required**

Returns

`string`

`public string ToString(string? format, IFormatProvider? provider)` [#](#method-tostring-string-iformatprovider)

Inherited from Enum

`Obsolete("The provider argument is not used. Use ToString(String) instead.")`

Parameters

**format string? required**

**provider IFormatProvider? required**

Returns

`string`

## Values

`public const DocBookNodeKind Unknown` [#](#field-unknown)

[DocBookContracts.cs:25](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L25)

Preserved extension outside the typed profile.

Value: `0`

`public const DocBookNodeKind Info` [#](#field-info)

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

Metadata container.

Value: `1`

`public const DocBookNodeKind Title` [#](#field-title)

[DocBookContracts.cs:29](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L29)

Title.

Value: `2`

`public const DocBookNodeKind Subtitle` [#](#field-subtitle)

[DocBookContracts.cs:31](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L31)

Subtitle.

Value: `3`

`public const DocBookNodeKind Author` [#](#field-author)

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

Author metadata.

Value: `4`

`public const DocBookNodeKind Section` [#](#field-section)

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

Section.

Value: `5`

`public const DocBookNodeKind Paragraph` [#](#field-paragraph)

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

Paragraph.

Value: `6`

`public const DocBookNodeKind ItemizedList` [#](#field-itemizedlist)

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

Unordered list.

Value: `7`

`public const DocBookNodeKind OrderedList` [#](#field-orderedlist)

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

Ordered list.

Value: `8`

`public const DocBookNodeKind VariableList` [#](#field-variablelist)

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

Variable or definition list.

Value: `9`

`public const DocBookNodeKind ListItem` [#](#field-listitem)

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

List item.

Value: `10`

`public const DocBookNodeKind Table` [#](#field-table)

[DocBookContracts.cs:47](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L47)

Table.

Value: `11`

`public const DocBookNodeKind TableGroup` [#](#field-tablegroup)

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

CALS table group.

Value: `12`

`public const DocBookNodeKind TableHead` [#](#field-tablehead)

[DocBookContracts.cs:51](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L51)

Table head.

Value: `13`

`public const DocBookNodeKind TableBody` [#](#field-tablebody)

[DocBookContracts.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L53)

Table body.

Value: `14`

`public const DocBookNodeKind Row` [#](#field-row)

[DocBookContracts.cs:55](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L55)

Table row.

Value: `15`

`public const DocBookNodeKind Entry` [#](#field-entry)

[DocBookContracts.cs:57](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L57)

Table cell entry.

Value: `16`

`public const DocBookNodeKind ProgramListing` [#](#field-programlisting)

[DocBookContracts.cs:59](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L59)

Program listing.

Value: `17`

`public const DocBookNodeKind Screen` [#](#field-screen)

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

Screen or terminal content.

Value: `18`

`public const DocBookNodeKind Link` [#](#field-link)

[DocBookContracts.cs:63](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L63)

Link.

Value: `19`

`public const DocBookNodeKind CrossReference` [#](#field-crossreference)

[DocBookContracts.cs:65](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L65)

Cross-reference.

Value: `20`

`public const DocBookNodeKind Note` [#](#field-note)

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

Note admonition.

Value: `21`

`public const DocBookNodeKind Tip` [#](#field-tip)

[DocBookContracts.cs:69](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L69)

Tip admonition.

Value: `22`

`public const DocBookNodeKind Important` [#](#field-important)

[DocBookContracts.cs:71](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L71)

Important admonition.

Value: `23`

`public const DocBookNodeKind Caution` [#](#field-caution)

[DocBookContracts.cs:73](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L73)

Caution admonition.

Value: `24`

`public const DocBookNodeKind Warning` [#](#field-warning)

[DocBookContracts.cs:75](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L75)

Warning admonition.

Value: `25`

`public const DocBookNodeKind Figure` [#](#field-figure)

[DocBookContracts.cs:77](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L77)

Figure.

Value: `26`

`public const DocBookNodeKind MediaObject` [#](#field-mediaobject)

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

Media object.

Value: `27`

`public const DocBookNodeKind ImageObject` [#](#field-imageobject)

[DocBookContracts.cs:81](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L81)

Image object.

Value: `28`

`public const DocBookNodeKind ImageData` [#](#field-imagedata)

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

Image data.

Value: `29`

`public const DocBookNodeKind Caption` [#](#field-caption)

[DocBookContracts.cs:85](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L85)

Caption.

Value: `30`

`public const DocBookNodeKind Index` [#](#field-index)

[DocBookContracts.cs:87](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L87)

Index.

Value: `31`

`public const DocBookNodeKind IndexTerm` [#](#field-indexterm)

[DocBookContracts.cs:89](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.DocBook/DocBookContracts.cs#L89)

Index term.

Value: `32`

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