DocBookNode
OfficeIMO.DocBook
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
- Method DocBookDocument.AddSection
- Property DocBookDocument.Root
- Method DocBookNode.Add
- Method DocBookNode.AddAdmonition
- Method DocBookNode.AddExtension
- Method DocBookNode.AddImage
- Method DocBookNode.AddIndexTerm
- Method DocBookNode.AddItemizedList
- Method DocBookNode.AddLink
- Method DocBookNode.AddListItem
- Method DocBookNode.AddOrderedList
- Method DocBookNode.AddParagraph
- Method DocBookNode.AddProgramListing
- Method DocBookNode.AddSection
- Method DocBookNode.AddTable
- Property DocBookNode.Children
Methods
public DocBookNode Add(DocBookNodeKind kind, string? text = null) #Adds a supported common node.
Parameters
- kind OfficeIMO.DocBook.DocBookNodeKind
- text string? = null
Returns
DocBookNodepublic DocBookNode AddAdmonition(DocBookNodeKind kind, string text) #Adds an admonition such as note, tip, important, caution, or warning.
Parameters
- kind OfficeIMO.DocBook.DocBookNodeKind
- text string
Returns
DocBookNodepublic DocBookNode AddExtension(XName name, string? text = null) #Adds an extension element without claiming typed vocabulary support.
Parameters
- name System.Xml.Linq.XName
- text string? = null
Returns
DocBookNodepublic DocBookNode AddImage(string fileReference, string? caption = null) #Adds an image media object.
Parameters
- fileReference string
- caption string? = null
Returns
DocBookNodepublic DocBookNode AddImage(string fileReference, string? caption, string? alternateText) #Adds an image media object with distinct caption and alternative text.
Parameters
- fileReference string
- caption string?
- alternateText string?
Returns
DocBookNodepublic DocBookNode AddIndexTerm(string primary) #Adds an index term.
Parameters
- primary string
Returns
DocBookNodepublic DocBookNode AddLink(string text, string href) #Adds an external link.
Parameters
- text string
- href string
Returns
DocBookNodepublic DocBookNode AddListItem(string text) #Adds a list item containing a paragraph.
Parameters
- text string
Returns
DocBookNodepublic DocBookNode AddParagraph(string text) #Adds a paragraph.
Parameters
- text string
Returns
DocBookNodepublic DocBookNode AddProgramListing(string code, string? language = null) #Adds a program listing.
Parameters
- code string
- language string? = null
Returns
DocBookNodepublic DocBookNode AddSection(string title) #Adds a section with a title.
Parameters
- title string
Returns
DocBookNodepublic DocBookNode AddTable(string? title = null) #Adds a table.
Parameters
- title string? = null
Returns
DocBookNodepublic string? GetAttribute(XName name) #Gets any standard or extension attribute.
Parameters
- name System.Xml.Linq.XName
Returns
string?public void SetAttribute(XName name, string? value) #Sets or removes any standard or extension attribute.
Parameters
- name System.Xml.Linq.XName
- value string?
Inherited Methods
Properties
public DocBookNodeKind Kind { get; } #Common structure kind, or Unknown for a preserved extension element.
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.