DocumentBase class
DocumentBase class
Provides the abstract base class for a main document and a glossary document of a Word document. To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.
Remarks
Aspose.Words represents a Word document as a tree of nodes. DocumentBase is a root node of the tree that contains all other nodes of the document.
DocumentBase also stores document-wide information such as DocumentBase.styles and DocumentBase.lists that the tree nodes might refer to.
Inheritance: DocumentBase → CompositeNode → Node
Properties
| Name | Description |
|---|---|
| backgroundShape | Gets or sets the background shape of the document. Can be null. |
| count | Gets the number of immediate children of this node. (Inherited from CompositeNode) |
| customNodeId | Specifies custom node identifier. (Inherited from Node) |
| document | Gets this instance. |
| firstChild | Gets the first child of the node. (Inherited from CompositeNode) |
| fontInfos | Provides access to properties of fonts used in this document. |
| footnoteSeparators | Provides access to the footnote/endnote separators defined in the document. |
| hasChildNodes | Returns true if this node has any child nodes.(Inherited from CompositeNode) |
| isComposite | Returns true if this node can contain other nodes.(Inherited from Node) |
| lastChild | Gets the last child of the node. (Inherited from CompositeNode) |
| lists | Provides access to the list formatting used in the document. |
| nextSibling | Gets the node immediately following this node. (Inherited from Node) |
| nodeChangingCallback | Called when a node is inserted or removed in the document. |
| nodeType | Gets the type of this node. (Inherited from Node) |
| pageColor | Gets or sets the page color of the document. This property is a simpler version of DocumentBase.backgroundShape. |
| parentNode | Gets the immediate parent of this node. (Inherited from Node) |
| previousSibling | Gets the node immediately preceding this node. (Inherited from Node) |
| range | Returns a Range object that represents the portion of a document that is contained in this node. (Inherited from Node) |
| resourceLoadingCallback | Allows to control how external resources are loaded. |
| styles | Returns a collection of styles defined in the document. |
Methods
| Name | Description |
|---|---|
| appendChild(newChild) | Adds the specified node to the end of the list of child nodes for this node. (Inherited from CompositeNode) |
| asBody() | Cast node to Body. (Inherited from Node) |
| asBookmarkEnd() | Cast node to BookmarkEnd. (Inherited from Node) |
| asBookmarkStart() | Cast node to BookmarkStart. (Inherited from Node) |
| asBuildingBlock() | Cast node to BuildingBlock. (Inherited from Node) |
| asCell() | Cast node to Cell. (Inherited from Node) |
| asComment() | Cast node to Comment. (Inherited from Node) |
| asCommentRangeEnd() | Cast node to CommentRangeEnd. (Inherited from Node) |
| asCommentRangeStart() | Cast node to CommentRangeStart. (Inherited from Node) |
| asCompositeNode() | Cast node to CompositeNode. (Inherited from Node) |
| asDocument() | Cast node to Node.document. (Inherited from Node) |
| asEditableRangeEnd() | Cast node to EditableRangeEnd. (Inherited from Node) |
| asEditableRangeStart() | Cast node to EditableRangeStart. (Inherited from Node) |
| asFieldEnd() | Cast node to FieldEnd. (Inherited from Node) |
| asFieldSeparator() | Cast node to FieldSeparator. (Inherited from Node) |
| asFieldStart() | Cast node to FieldStart. (Inherited from Node) |
| asFootnote() | Cast node to Footnote. (Inherited from Node) |
| asFormField() | Cast node to FormField. (Inherited from Node) |
| asGlossaryDocument() | Cast node to GlossaryDocument. (Inherited from Node) |
| asGroupShape() | Cast node to GroupShape. (Inherited from Node) |
| asHeaderFooter() | Cast node to HeaderFooter. (Inherited from Node) |
| asOfficeMath() | Cast node to OfficeMath. (Inherited from Node) |
| asParagraph() | Cast node to Paragraph. (Inherited from Node) |
| asRow() | Cast node to Row. (Inherited from Node) |
| asRun() | Cast node to Run. (Inherited from Node) |
| asSection() | Cast node to Section. (Inherited from Node) |
| asShape() | Cast node to Shape. (Inherited from Node) |
| asSmartTag() | Cast node to SmartTag. (Inherited from Node) |
| asSpecialChar() | Cast node to SpecialChar. (Inherited from Node) |
| asStructuredDocumentTag() | Cast node to StructuredDocumentTag. (Inherited from Node) |
| asStructuredDocumentTagRangeEnd() | Cast node to StructuredDocumentTagRangeEnd. (Inherited from Node) |
| asStructuredDocumentTagRangeStart() | Cast node to StructuredDocumentTagRangeStart. (Inherited from Node) |
| asSubDocument() | Cast node to SubDocument. (Inherited from Node) |
| asTable() | Cast node to Table. (Inherited from Node) |
| clone(isCloneChildren) | Creates a duplicate of the node. (Inherited from Node) |
| getAncestor(ancestorType) | Gets the first ancestor of the specified NodeType. (Inherited from Node) |
| getBuildingBlock(index, isDeep) | Returns an Nth child BuildingBlock node. (Inherited from CompositeNode) |
| getChild(nodeType, index, isDeep) | Returns an Nth child node that matches the specified type. (Inherited from CompositeNode) |
| getChildNodes(nodeType, isDeep) | Returns a live collection of child nodes that match the specified type. (Inherited from CompositeNode) |
| getComment(index, isDeep) | Returns an Nth child Comment node. (Inherited from CompositeNode) |
| getEditableRangeStart(index, isDeep) | Returns an Nth child EditableRangeStart node. (Inherited from CompositeNode) |
| getFootnote(index, isDeep) | Returns an Nth child Footnote node. (Inherited from CompositeNode) |
| getGroupShape(index, isDeep) | Returns an Nth child GroupShape node. (Inherited from CompositeNode) |
| getOfficeMath(index, isDeep) | Returns an Nth child OfficeMath node. (Inherited from CompositeNode) |
| getParagraph(index, isDeep) | Returns an Nth child Paragraph node. (Inherited from CompositeNode) |
| getRun(index, isDeep) | Returns an Nth child Run node. (Inherited from CompositeNode) |
| getSdt(index, isDeep) | Returns an Nth child StructuredDocumentTag node. (Inherited from CompositeNode) |
| getSdtRangeEnd(index, isDeep) | Returns an Nth child StructuredDocumentTagRangeEnd node. (Inherited from CompositeNode) |
| getSdtRangeStart(index, isDeep) | Returns an Nth child StructuredDocumentTagRangeStart node. (Inherited from CompositeNode) |
| getShape(index, isDeep) | Returns an Nth child Shape node. (Inherited from CompositeNode) |
| getSmartTag(index, isDeep) | Returns an Nth child SmartTag node. (Inherited from CompositeNode) |
| getTable(index, isDeep) | Returns an Nth child Table node. (Inherited from CompositeNode) |
| getText() | Gets the text of this node and of all its children. (Inherited from Node) |
| importNode(srcNode, isImportChildren) | Imports a node from another document to the current document. |
| importNode(srcNode, isImportChildren, importFormatMode) | Imports a node from another document to the current document with an option to control formatting. |
| indexOf(child) | Returns the index of the specified child node in the child node array. (Inherited from CompositeNode) |
| insertAfter(newChild, refChild) | Inserts the specified node immediately after the specified reference node. (Inherited from CompositeNode) |
| insertBefore(newChild, refChild) | Inserts the specified node immediately before the specified reference node. (Inherited from CompositeNode) |
| nextPreOrder(rootNode) | Gets next node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| nodeTypeToString(nodeType) | A utility method that converts a node type enum value into a user friendly string. (Inherited from Node) |
| prependChild(newChild) | Adds the specified node to the beginning of the list of child nodes for this node. (Inherited from CompositeNode) |
| previousPreOrder(rootNode) | Gets the previous node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| referenceEquals(other) | (Inherited from Node) |
| remove() | Removes itself from the parent. (Inherited from Node) |
| removeAllChildren() | Removes all the child nodes of the current node. (Inherited from CompositeNode) |
| removeChild(oldChild) | Removes the specified child node. (Inherited from CompositeNode) |
| removeSmartTags() | Removes all SmartTag descendant nodes of the current node. (Inherited from CompositeNode) |
| selectNodes(xpath) | Selects a list of nodes matching the XPath expression. (Inherited from CompositeNode) |
| selectSingleNode(xpath) | Selects the first Node that matches the XPath expression. (Inherited from CompositeNode) |
| toString(saveFormat) | Exports the content of the node into a string in the specified format. (Inherited from Node) |
| toString(saveOptions) | Exports the content of the node into a string using the specified save options. (Inherited from Node) |
Examples
Shows how to initialize the subclasses of DocumentBase.
let doc = new aw.Document();
expect(doc.getType().baseType).toEqual(typeof(DocumentBase));
let glossaryDoc = new aw.BuildingBlocks.GlossaryDocument();
doc.glossaryDocument = glossaryDoc;
expect(glossaryDoc.getType().baseType).toEqual(typeof(DocumentBase));
See Also
- module Aspose.Words
- class CompositeNode
- class Document
- class DocumentBase