Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

DocBookNode

OfficeIMO.DocBook

Namespace
OfficeIMO.DocBook
Assembly
OfficeIMO.DocBook
Source revision
ba882f6b0d07 with working tree changes
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.

Methods

public DocBookNode Add(DocBookNodeKind kind, string? text = null) #

Adds a supported common node.

Parameters

kind OfficeIMO.DocBook.DocBookNodeKind required
text string? = null optional
public DocBookNode AddAdmonition(DocBookNodeKind kind, string text) #

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

Parameters

kind OfficeIMO.DocBook.DocBookNodeKind required
text string required
public DocBookNode AddExtension(XName name, string? text = null) #

Adds an extension element without claiming typed vocabulary support.

Parameters

name System.Xml.Linq.XName required
text string? = null optional
AddImage 2 overloads
public DocBookNode AddImage(string fileReference, string? caption = null) #

Adds an image media object.

Parameters

fileReference string required
caption string? = null optional
public DocBookNode AddImage(string fileReference, string? caption, string? alternateText) #

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

Parameters

fileReference string required
caption string? required
alternateText string? required
public DocBookNode AddIndexTerm(string primary) #

Adds an index term.

Parameters

primary string required
public DocBookNode AddItemizedList() #

Adds an itemized list.

public DocBookNode AddListItem(string text) #

Adds a list item containing a paragraph.

Parameters

text string required
public DocBookNode AddOrderedList() #

Adds an ordered list.

public DocBookNode AddParagraph(string text) #

Adds a paragraph.

Parameters

text string required
public DocBookNode AddProgramListing(string code, string? language = null) #

Adds a program listing.

Parameters

code string required
language string? = null optional
public DocBookNode AddSection(string title) #

Adds a section with a title.

Parameters

title string required
public DocBookNode AddTable(string? title = null) #

Adds a table.

Parameters

title string? = null optional
public string? GetAttribute(XName name) #

Gets any standard or extension attribute.

Parameters

name System.Xml.Linq.XName required

Returns

string?
public void Remove() #

Removes this node.

public void SetAttribute(XName name, string? value) #

Sets or removes any standard or extension attribute.

Parameters

name System.Xml.Linq.XName required
value string? required

Properties

public DocBookNodeKind Kind { get; } #

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

public string Name { get; } #

Element local name.

public string Text { get; set; } #

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

public IReadOnlyDictionary<XName, string> Attributes { get; } #

All attributes, including namespaced extension attributes.

public IReadOnlyList<DocBookNode> Children { get; } #

Child elements in source order.