GlossaryDocument class
GlossaryDocument class
Represents the root element for a glossary document within a Word document. A glossary document is a storage for AutoText, AutoCorrect entries and Building Blocks. To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.
Remarks
Some documents, usually templates, can contain AutoText, AutoCorrect entries and/or Building Blocks (also known as glossary document entries, document parts or building blocks).
To access building blocks, you need to load a document into a Document object. Building blocks will be available via the Document.glossary_document property.
GlossaryDocument can contain any number of BuildingBlock objects. Each BuildingBlock represents one document part.
Corresponds to the glossaryDocument and docParts elements in OOXML.
Inheritance: GlossaryDocument → DocumentBase → CompositeNode → Node
Constructors
| Name | Description |
|---|---|
| GlossaryDocument() | The default constructor. |
Properties
| Name | Description |
|---|---|
| background_shape | Gets or sets the background shape of the document. Can be None.(Inherited from DocumentBase) |
| building_blocks | Returns a typed collection that represents all building blocks in the glossary document. |
| 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_building_block | Gets the first building block in the glossary document. |
| first_child | Gets the first child of the node. (Inherited from CompositeNode) |
| font_infos | Provides access to properties of fonts used in this document. (Inherited from DocumentBase) |
| footnote_separators | Provides access to the footnote/endnote separators defined in the document. (Inherited from DocumentBase) |
| 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_building_block | Gets the last building block in the glossary document. |
| last_child | Gets the last child of the node. (Inherited from CompositeNode) |
| lists | Provides access to the list formatting used in the document. (Inherited from DocumentBase) |
| 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. (Inherited from DocumentBase) |
| node_type | Returns the NodeType.GLOSSARY_DOCUMENT value. |
| page_color | Gets or sets the page color of the document. This property is a simpler version of DocumentBase.background_shape. (Inherited from DocumentBase) |
| 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. (Inherited from DocumentBase) |
| styles | Returns a collection of styles defined in the document. (Inherited from DocumentBase) |
| warning_callback | Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss. (Inherited from DocumentBase) |
Methods
| Name | Description |
|---|---|
| accept(visitor) | Accepts a visitor. |
| accept_end(visitor) | Accepts a visitor for visiting the end of the Glossary document. |
| accept_start(visitor) | Accepts a visitor for visiting the start of the Glossary document. |
| 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_building_block(gallery, category, name) | Finds a building block using the specified gallery, category and name. |
| 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. (Inherited from DocumentBase) |
| 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. (Inherited from DocumentBase) |
| 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) |
See Also
- module aspose.words.buildingblocks
- class DocumentBase
- class Document
- property Document.glossary_document
- class BuildingBlock