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.

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: DocumentBaseCompositeNodeNode

Properties

Name Description
background_shape Gets or sets the background shape of the document. Can be None.
child_nodes Gets all immediate child nodes of this node.
(Inherited from CompositeNode)
count Gets the number of immediate children of this node.
(Inherited from CompositeNode)
custom_node_id Specifies custom node identifier.
(Inherited from Node)
document Gets the document to which this node belongs.
(Inherited from Node)
first_child Gets the first child of the node.
(Inherited from CompositeNode)
font_infos Provides access to properties of fonts used in this document.
has_child_nodes Returns True if this node has any child nodes.
(Inherited from CompositeNode)
is_composite Returns True if this node can contain other nodes.
(Inherited from Node)
last_child Gets the last child of the node.
(Inherited from CompositeNode)
lists Provides access to the list formatting used in the document.
next_sibling Gets the node immediately following this node.
(Inherited from Node)
node_changing_callback Called when a node is inserted or removed in the document.
node_type Gets the type of this node.
(Inherited from Node)
page_color Gets or sets the page color of the document. This property is a simpler version of DocumentBase.background_shape.
parent_node Gets the immediate parent of this node.
(Inherited from Node)
previous_sibling 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)
resource_loading_callback Allows to control how external resources are loaded.
styles Returns a collection of styles defined in the document.
warning_callback Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss.

Methods

Name Description
accept(visitor) Accepts a visitor.
(Inherited from Node)
append_child(new_child) Adds the specified node to the end of the list of child nodes for this node.
(Inherited from CompositeNode)
clone(is_clone_children) Creates a duplicate of the node.
(Inherited from Node)
get_ancestor(ancestor_type) Gets the first ancestor of the specified object type.
(Inherited from Node)
get_ancestor(ancestor_type) Gets the first ancestor of the specified NodeType.
(Inherited from Node)
get_child(node_type, index, is_deep) Returns an Nth child node that matches the specified type.
(Inherited from CompositeNode)
get_child_nodes(node_type, is_deep) Returns a live collection of child nodes that match the specified type.
(Inherited from CompositeNode)
get_text() Gets the text of this node and of all its children.
(Inherited from Node)
import_node(src_node, is_import_children) Imports a node from another document to the current document.
import_node(src_node, is_import_children, import_format_mode) Imports a node from another document to the current document with an option to control formatting.
index_of(child) Returns the index of the specified child node in the child node array.
(Inherited from CompositeNode)
insert_after(new_child, ref_child) Inserts the specified node immediately after the specified reference node.
(Inherited from CompositeNode)
insert_before(new_child, ref_child) Inserts the specified node immediately before the specified reference node.
(Inherited from CompositeNode)
next_pre_order(root_node) Gets next node according to the pre-order tree traversal algorithm.
(Inherited from Node)
node_type_to_string(node_type) A utility method that converts a node type enum value into a user friendly string.
(Inherited from Node)
prepend_child(new_child) Adds the specified node to the beginning of the list of child nodes for this node.
(Inherited from CompositeNode)
previous_pre_order(root_node) Gets the previous node according to the pre-order tree traversal algorithm.
(Inherited from Node)
remove() Removes itself from the parent.
(Inherited from Node)
remove_all_children() Removes all the child nodes of the current node.
(Inherited from CompositeNode)
remove_child(old_child) Removes the specified child node.
(Inherited from CompositeNode)
remove_smart_tags() Removes all SmartTag descendant nodes of the current node.
(Inherited from CompositeNode)
select_nodes(xpath) Selects a list of nodes matching the XPath expression.
(Inherited from CompositeNode)
select_single_node(xpath) Selects the first Node that matches the XPath expression.
(Inherited from CompositeNode)
to_string(save_format) Exports the content of the node into a string in the specified format.
(Inherited from Node)
to_string(save_options) 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.

doc = aw.Document()

self.assertIsInstance(doc, aw.DocumentBase)

glossary_doc = aw.buildingblocks.GlossaryDocument()
doc.glossary_document = glossary_doc

self.assertIsInstance(glossary_doc, aw.DocumentBase)

See Also