API Reference
DocBookNode
Typed common-structure view over a DocBook element. Unknown elements and attributes remain in the backing XML.
Inheritance
- Object
- DocBookNode
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method DocBookDocument.AddParagraph
- Method DocBookDocument.AddSection
- Property DocBookDocument.Root
- Method DocBookNode.Add
- Method DocBookNode.AddAdmonition
- Method DocBookNode.AddExtension
- Method DocBookNode.AddImage
- 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) #DocBookNodeAdds a supported common node.
Parameters
- kind OfficeIMO.DocBook.DocBookNodeKind
- text System.String = null
public DocBookNode AddAdmonition(DocBookNodeKind kind, String text) #DocBookNodeAdds an admonition such as note, tip, important, caution, or warning.
Parameters
- kind OfficeIMO.DocBook.DocBookNodeKind
- text System.String
public DocBookNode AddExtension(XName name, String text = null) #DocBookNodeAdds an extension element without claiming typed vocabulary support.
Parameters
- name System.Xml.Linq.XName
- text System.String = null
public DocBookNode AddImage(String fileReference, String caption = null) #DocBookNodeAdds an image media object.
Parameters
- fileReference System.String
- caption System.String = null
public DocBookNode AddImage(String fileReference, String caption, String alternateText) #DocBookNodeAdds an image media object with distinct caption and alternative text.
Parameters
- fileReference System.String
- caption System.String
- alternateText System.String
public DocBookNode AddIndexTerm(String primary) #DocBookNodeAdds an index term.
Parameters
- primary System.String
public DocBookNode AddLink(String text, String href) #DocBookNodeAdds an external link.
Parameters
- text System.String
- href System.String
public DocBookNode AddListItem(String text) #DocBookNodeAdds a list item containing a paragraph.
Parameters
- text System.String
public DocBookNode AddParagraph(String text) #DocBookNodeAdds a paragraph.
Parameters
- text System.String
public DocBookNode AddProgramListing(String code, String language = null) #DocBookNodeAdds a program listing.
Parameters
- code System.String
- language System.String = null
public DocBookNode AddSection(String title) #DocBookNodeAdds a section with a title.
Parameters
- title System.String
public DocBookNode AddTable(String title = null) #DocBookNodeAdds a table.
Parameters
- title System.String = null
public String GetAttribute(XName name) #StringGets any standard or extension attribute.
Parameters
- name System.Xml.Linq.XName
public Void SetAttribute(XName name, String value) #VoidSets or removes any standard or extension attribute.
Parameters
- name System.Xml.Linq.XName
- value System.String
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
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.