java.lang.ObjectNode
CompositeNode
DocumentBase
com.aspose.words.GlossaryDocument
public class GlossaryDocument
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 Corresponds to the glossaryDocument and docParts elements in OOXML.
Constructor Summary |
---|
GlossaryDocument()
Initializes a new instance of this class. |
Property Getters/Setters Summary | ||
---|---|---|
Shape | getBackgroundShape() | → inherited from DocumentBase |
void | setBackgroundShape(Shape value) | |
Gets or sets the background shape of the document. Can be null. | ||
BuildingBlockCollection | getBuildingBlocks() | |
Returns a typed collection that represents all building blocks in the glossary document. | ||
NodeCollection | getChildNodes() | → inherited from CompositeNode |
Gets all immediate child nodes of this node. | ||
int | getCount() | → inherited from CompositeNode |
Gets the number of immediate children of this node. | ||
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
BuildingBlock | getFirstBuildingBlock() | |
Gets the first building block in the glossary document. | ||
Node | getFirstChild() | → inherited from CompositeNode |
Gets the first child of the node. | ||
Aspose.Words.Fonts.FontInfoCollection | getFontInfos() | → inherited from DocumentBase |
Provides access to properties of fonts used in this document. | ||
boolean | hasChildNodes() | → inherited from CompositeNode |
Returns true if this node has any child nodes. | ||
boolean | isComposite() | → inherited from CompositeNode |
Returns true as this node can have child nodes. | ||
BuildingBlock | getLastBuildingBlock() | |
Gets the last building block in the glossary document. | ||
Node | getLastChild() | → inherited from CompositeNode |
Gets the last child of the node. | ||
Aspose.Words.Lists.ListCollection | getLists() | → inherited from DocumentBase |
Provides access to the list formatting used in the document. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
INodeChangingCallback | getNodeChangingCallback() | → inherited from DocumentBase |
void | setNodeChangingCallback(INodeChangingCallback value) | |
Called when a node is inserted or removed in the document. | ||
int | getNodeType() | |
Returns the |
||
java.awt.Color | getPageColor() | → inherited from DocumentBase |
Gets or sets the page color of the document. This property is a simpler version of |
||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Node | getPreviousSibling() | → inherited from Node |
Gets the node immediately preceding this node. | ||
Range | getRange() | → inherited from Node |
Returns a Range object that represents the portion of a document that is contained in this node. | ||
Aspose.Words.Loading.IResourceLoadingCallback | getResourceLoadingCallback() | → inherited from DocumentBase |
Allows to control how external resources are loaded. | ||
StyleCollection | getStyles() | → inherited from DocumentBase |
Returns a collection of styles defined in the document. | ||
IWarningCallback | getWarningCallback() | → inherited from DocumentBase |
void | setWarningCallback(IWarningCallback value) | |
Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss. |
Method Summary | ||
---|---|---|
boolean | accept(DocumentVisitor visitor) | |
Accepts a visitor. | ||
Node | appendChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the end of the list of child nodes for this node. | ||
Node | deepClone(boolean isCloneChildren) | → inherited from Node |
Creates a duplicate of the node. | ||
CompositeNode | getAncestor(int ancestorType) | → inherited from Node |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object type. | ||
BuildingBlock | getBuildingBlock(int gallery, java.lang.String category, java.lang.String name) | |
Finds a building block using the specified gallery, category and name. | ||
Node | getChild(int nodeType, int index, boolean isDeep) | → inherited from CompositeNode |
Returns an Nth child node that matches the specified type. | ||
NodeCollection | getChildNodes(int nodeType, boolean isDeep) | → inherited from CompositeNode |
Returns a live collection of child nodes that match the specified type. | ||
CompositeNode | getContainer() | → inherited from CompositeNode |
Reserved for internal use. | ||
Node | getNextMatchingNode(aspose.obfuscated.type curNode) | → inherited from CompositeNode |
Reserved for internal use. | ||
java.lang.String | getText() | → inherited from CompositeNode |
Gets the text of this node and of all its children. | ||
Node | importNode(Node srcNode, boolean isImportChildren) | → inherited from DocumentBase |
Imports a node from another document to the current document. |
||
Node | importNode(Node srcNode, boolean isImportChildren, int importFormatMode) | → inherited from DocumentBase |
Imports a node from another document to the current document with an option to control formatting. |
||
int | indexOf(Node child) | → inherited from CompositeNode |
Returns the index of the specified child node in the child node array. | ||
Node | insertAfter(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately after the specified reference node. | ||
Node | insertBefore(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately before the specified reference node. | ||
java.util.Iterator | iterator() | → inherited from CompositeNode |
Provides support for the for each style iteration over the child nodes of this node. | ||
Node | nextPreOrder(Node rootNode) | → inherited from Node |
Gets next node according to the pre-order tree traversal algorithm. | ||
Node | prependChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the beginning of the list of child nodes for this node. | ||
Node | previousPreOrder(Node rootNode) | → inherited from Node |
Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | → inherited from Node |
Removes itself from the parent. | ||
void | removeAllChildren() | → inherited from CompositeNode |
Removes all the child nodes of the current node. | ||
Node | removeChild(Node oldChild) | → inherited from CompositeNode |
Removes the specified child node. | ||
void | removeSmartTags() | → inherited from CompositeNode |
Removes all |
||
NodeList | selectNodes(java.lang.String xpath) | → inherited from CompositeNode |
Selects a list of nodes matching the XPath expression. | ||
Node | selectSingleNode(java.lang.String xpath) | → inherited from CompositeNode |
Selects the first Node that matches the XPath expression. | ||
java.lang.String | toString(int saveFormat) | → inherited from Node |
Exports the content of the node into a string in the specified format. | ||
java.lang.String | toTxt() | → inherited from Node |
Exports the content of the node into a string in plain text format. |
Constructor Detail |
---|
public GlossaryDocument()
Property Getters/Setters Detail |
---|
getBackgroundShape/setBackgroundShape | → inherited from DocumentBase |
public Shape getBackgroundShape() / public void setBackgroundShape(Shape value) |
Microsoft Word allows only a shape that has its
Microsoft Word supports only the fill properties of a background shape. All other properties are ignored.
Setting this property to a non-null value will also set the
getBuildingBlocks | |
public BuildingBlockCollection getBuildingBlocks() |
getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes() |
Note, GetChildNodes(NodeType.Any, false)
and creates and returns a new collection every time it is accessed.
If there are no child nodes, this property returns an empty collection.
getCount | → inherited from CompositeNode |
public int getCount() |
getDocument | → inherited from Node |
public DocumentBase getDocument() |
The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.
getFirstBuildingBlock | |
public BuildingBlock getFirstBuildingBlock() |
null
if there are no building blocks available.
getFirstChild | → inherited from CompositeNode |
public Node getFirstChild() |
getFontInfos | → inherited from DocumentBase |
public Aspose.Words.Fonts.FontInfoCollection getFontInfos() |
This collection of font definitions is loaded as is from the document. Font definitions might be optional, missing or incomplete in some documents.
Do not rely on this collection to ascertain that a particular font is used in the document. You should only use this collection to get information about fonts that might be used in the document.
hasChildNodes | → inherited from CompositeNode |
public boolean hasChildNodes() |
isComposite | → inherited from CompositeNode |
public boolean isComposite() |
getLastBuildingBlock | |
public BuildingBlock getLastBuildingBlock() |
null
if there are no building blocks available.
getLastChild | → inherited from CompositeNode |
public Node getLastChild() |
getLists | → inherited from DocumentBase |
public Aspose.Words.Lists.ListCollection getLists() |
For more information see the description of the
getNextSibling | → inherited from Node |
public Node getNextSibling() |
getNodeChangingCallback/setNodeChangingCallback | → inherited from DocumentBase |
public INodeChangingCallback getNodeChangingCallback() / public void setNodeChangingCallback(INodeChangingCallback value) |
getNodeType | |
public int getNodeType() |
getPageColor | → inherited from DocumentBase |
public java.awt.Color getPageColor() |
This property provides a simple way to specify a solid page color for the document.
Setting this property creates and sets an appropriate
If the page color is not set (e.g. there is no background shape in the document) returns a zero color.
getParentNode | → inherited from Node |
public CompositeNode getParentNode() |
If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
getRange | → inherited from Node |
public Range getRange() |
getResourceLoadingCallback | → inherited from DocumentBase |
public Aspose.Words.Loading.IResourceLoadingCallback getResourceLoadingCallback() |
getStyles | → inherited from DocumentBase |
public StyleCollection getStyles() |
For more information see the description of the
getWarningCallback/setWarningCallback | → inherited from DocumentBase |
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value) |
Method Detail |
---|
accept | |
public boolean accept(DocumentVisitor visitor) throws java.lang.Exception |
Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.
For more info see the Visitor design pattern.
Calls
Note: A glossary document node and its children are not visited when you execute a
Visitor over a
visitor
- The visitor that will visit the nodes.appendChild | → inherited from CompositeNode |
public Node appendChild(Node newChild) |
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The node to add.deepClone | → inherited from Node |
public Node deepClone(boolean isCloneChildren) |
This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.
This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.getAncestor | → inherited from Node |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A getAncestor | → inherited from Node |
public CompositeNode getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.getBuildingBlock | |
public BuildingBlock getBuildingBlock(int gallery, java.lang.String category, java.lang.String name) |
This is a convenience method that iterates over all building blocks in this collection and returns the first building block that matches the specified gallery, category and name.
Microsoft Word organizes building blocks into galleries. The galleries
are predefined using the
gallery
- A category
- The category criteria. Can be null, in which case it will not be used for comparison.name
- The building block name criteria.getChild | → inherited from CompositeNode |
public Node getChild(int nodeType, int index, boolean isDeep) |
If index is out of range, a null is returned.
nodeType
- A index
- Zero based index of the child node to select.
Negative indexes are also allowed and indicate access from the end,
that is -1 means the last node.isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. See remarks for more info.getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes(int nodeType, boolean isDeep) |
The collection of nodes returned by this method is always live.
A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.
nodeType
- A isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. getContainer | → inherited from CompositeNode |
public CompositeNode getContainer() |
getNextMatchingNode | → inherited from CompositeNode |
public Node getNextMatchingNode(aspose.obfuscated.type curNode) |
getText | → inherited from CompositeNode |
public java.lang.String getText() |
The returned string includes all control and special characters as described in
importNode | → inherited from DocumentBase |
public Node importNode(Node srcNode, boolean isImportChildren) |
Imports a node from another document to the current document.
This method uses the
Importing a node creates a copy of the source node belonging to the importing document. The returned node has no parent. The source node is not altered or removed from the original document.
Before a node from another document can be inserted into this document, it must be imported.
During import, document-specific properties such as references to styles and lists are translated
from the original to the importing document. After the node was imported, it can be inserted
into the appropriate place in the document using
If the source node already belongs to the destination document, then simply a deep clone of the source node is created.
srcNode
- The node being imported.isImportChildren
- True to import all child nodes recursively; otherwise, false.importNode | → inherited from DocumentBase |
public Node importNode(Node srcNode, boolean isImportChildren, int importFormatMode) |
Imports a node from another document to the current document with an option to control formatting.
This overload is useful to control how styles and list formatting are imported.
Importing a node creates a copy of the source node belonging to the importing document. The returned node has no parent. The source node is not altered or removed from the original document.
Before a node from another document can be inserted into this document, it must be imported.
During import, document-specific properties such as references to styles and lists are translated
from the original to the importing document. After the node was imported, it can be inserted
into the appropriate place in the document using
If the source node already belongs to the destination document, then simply a deep clone of the source node is created.
srcNode
- The node to imported.isImportChildren
- True to import all child nodes recursively; otherwise, false.importFormatMode
- A indexOf | → inherited from CompositeNode |
public int indexOf(Node child) |
insertAfter | → inherited from CompositeNode |
public Node insertAfter(Node newChild, Node refChild) |
If refChild is null, inserts newChild at the beginning of the list of child nodes.
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newNode is placed after the refNode. insertBefore | → inherited from CompositeNode |
public Node insertBefore(Node newChild, Node refChild) |
If refChild is null, inserts newChild at the end of the list of child nodes.
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newChild is placed before this node.iterator | → inherited from CompositeNode |
public java.util.Iterator iterator() |
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.prependChild | → inherited from CompositeNode |
public Node prependChild(Node newChild) |
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The node to add.previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.remove | → inherited from Node |
public void remove() |
removeAllChildren | → inherited from CompositeNode |
public void removeAllChildren() |
removeChild | → inherited from CompositeNode |
public Node removeChild(Node oldChild) |
The parent of oldChild is set to null after the node is removed.
oldChild
- The node to remove.removeSmartTags | → inherited from CompositeNode |
public void removeSmartTags() |
selectNodes | → inherited from CompositeNode |
public NodeList selectNodes(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.selectSingleNode | → inherited from CompositeNode |
public Node selectSingleNode(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.toString | → inherited from Node |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.toTxt | → inherited from Node |
public java.lang.String toTxt() throws java.lang.Exception |
This method removes field codes and Microsoft Word control characters, uses CrLf
(or any other) combination of characters to mark ends of paragraphs in the resulting string.
It produces a different result from