java.lang.ObjectNode
CompositeNode
com.aspose.words.BuildingBlock
public class BuildingBlock
You can create new building blocks and insert them into a glossary document.
You can modify or delete existing building blocks. You can copy or move building blocks
between documents. You can insert content of a building block into a document. Corresponds to the docPart, docPartPr and docPartBody elements in OOXML. Example:
public void buildingBlockFields() throws Exception {
Document doc = new Document();
// BuildingBlocks are stored inside the glossary document
// If you're making a document from scratch, the glossary document must also be manually created
GlossaryDocument glossaryDoc = new GlossaryDocument();
doc.setGlossaryDocument(glossaryDoc);
// Create a building block and name it
BuildingBlock block = new BuildingBlock(glossaryDoc);
block.setName("Custom Block");
// Put in in the document's glossary document
glossaryDoc.appendChild(block);
Assert.assertEquals(glossaryDoc.getCount(), 1);
// All GUIDs are this value by default
Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000");
// In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer
Assert.assertEquals(block.getCategory(), "(Empty Category)");
Assert.assertEquals(block.getType(), BuildingBlockType.NONE);
Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL);
Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT);
// If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties
// All the necessary preparation will be done in a custom document visitor that we will accept
BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc);
block.accept(visitor);
// We can find the block we made in the glossary document like this
BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS,
"My custom building blocks", "Custom Block");
// Our block contains one section which now contains our text
Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText());
Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection());
// Then we can insert it into the document as a new section
doc.appendChild(doc.importNode(customBlock.getFirstSection(), true));
// Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually
doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx");
}
/// <summary>
/// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor.
/// </summary>
public static class BuildingBlockVisitor extends DocumentVisitor {
public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) {
mBuilder = new StringBuilder();
mGlossaryDoc = ownerGlossaryDoc;
}
public int visitBuildingBlockStart(final BuildingBlock block) {
// Change values by default of created BuildingBlock
block.setBehavior(BuildingBlockBehavior.PARAGRAPH);
block.setCategory("My custom building blocks");
block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor.");
block.setGallery(BuildingBlockGallery.QUICK_PARTS);
block.setGuid(UUID.randomUUID());
// Add content for the BuildingBlock to have an effect when used in the document
Section section = new Section(mGlossaryDoc);
block.appendChild(section);
Body body = new Body(mGlossaryDoc);
section.appendChild(body);
Paragraph paragraph = new Paragraph(mGlossaryDoc);
body.appendChild(paragraph);
// Add text that will be visible in the document
Run run = new Run(mGlossaryDoc, "Text inside " + block.getName());
block.getFirstSection().getBody().getFirstParagraph().appendChild(run);
return VisitorAction.CONTINUE;
}
public int visitBuildingBlockEnd(final BuildingBlock block) {
mBuilder.append("Visited " + block.getName() + "\r\n");
return VisitorAction.CONTINUE;
}
private StringBuilder mBuilder;
private GlossaryDocument mGlossaryDoc;
}
Constructor Summary |
---|
BuildingBlock(GlossaryDocument glossaryDoc)
Initializes a new instance of this class. |
Property Getters/Setters Summary | ||
---|---|---|
int | getBehavior() | |
void | setBehavior(int value) | |
Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document. The value of the property is BuildingBlockBehavior integer constant. | ||
java.lang.String | getCategory() | |
void | setCategory(java.lang.String value) | |
Specifies the second-level categorization for the building block. | ||
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. | ||
java.lang.String | getDescription() | |
void | setDescription(java.lang.String value) | |
Gets or sets the description associated with this building block. | ||
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
Node | getFirstChild() | → inherited from CompositeNode |
Gets the first child of the node. | ||
Section | getFirstSection() | |
Gets the first section in the building block. | ||
int | getGallery() | |
void | setGallery(int value) | |
Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting. The value of the property is BuildingBlockGallery integer constant. | ||
java.util.UUID | getGuid() | |
void | setGuid(java.util.UUID value) | |
Gets or sets an identifier (a 128-bit GUID) that uniquely identifies this building block. | ||
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. | ||
Node | getLastChild() | → inherited from CompositeNode |
Gets the last child of the node. | ||
Section | getLastSection() | |
Gets the last section in the building block. | ||
java.lang.String | getName() | |
void | setName(java.lang.String value) | |
Gets or sets the name of this building block. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
int | getNodeType() | |
Returns the |
||
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. | ||
SectionCollection | getSections() | |
Returns a collection that represents all sections in the building block. | ||
int | getType() | |
void | setType(int value) | |
Specifies the building block type. The value of the property is BuildingBlockType integer constant. |
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 |
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. | ||
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. | ||
java.lang.String | getText() | → inherited from CompositeNode |
Gets the text of this node and of all its children. | ||
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<Node> | 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(SaveOptions saveOptions) | → inherited from Node |
Exports the content of the node into a string using the specified save options. | ||
java.lang.String | toString(int saveFormat) | → inherited from Node |
Exports the content of the node into a string in the specified format. |
Constructor Detail |
---|
public BuildingBlock(GlossaryDocument glossaryDoc)
When null
.
To append
glossaryDoc
- The owner document.Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
Property Getters/Setters Detail |
---|
getBehavior/setBehavior | |
public int getBehavior() / public void setBehavior(int value) |
Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
getCategory/setCategory | |
public java.lang.String getCategory() / public void setCategory(java.lang.String value) |
Building blocks in Microsoft Word user interface are arranged
into Galleries. Each
Cannot be null
and cannot be an empty string.
Corresponds to the docPartPr.category.name element in OOXML.
Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
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.
Example:
Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.Document doc = new Document(); Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true); paragraph.appendChild(new Run(doc, "Hello world!")); paragraph.appendChild(new Run(doc, " Hello again!")); NodeCollection children = paragraph.getChildNodes(); // Paragraph may contain children of various types such as runs, shapes and so on for (Node child : (Iterable<Node>) children) if (((child.getNodeType()) == (NodeType.RUN))) { Run run = (Run) child; System.out.println(run.getText()); }
getCount | → inherited from CompositeNode |
public int getCount() |
Example:
Shows how to add, update and delete child nodes from a CompositeNode's child collection.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount()); // A paragraph is a composite node because it can contain runs, which are another type of node Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // We will place these 3 children into the main text of our paragraph Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // We initialized them but not in our paragraph yet Assert.assertEquals("Initial text.", paragraph.getText().trim()); // Insert run2 before initial paragraph text. This will be at the start of the paragraph paragraph.insertBefore(run2, paragraphText); // Insert run3 after initial paragraph text. This will be at the end of the paragraph paragraph.insertAfter(run3, paragraphText); // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1 paragraph.prependChild(run1); Assert.assertEquals("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim()); Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount()); // Access the child node collection and update/delete children ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. "); paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText); Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim()); Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());
getDescription/setDescription | |
public java.lang.String getDescription() / public void setDescription(java.lang.String value) |
The description may contain any string content, usually additional information.
Cannot be null
, but can be an empty string.
Corresponds to the docPartPr.description element in OOXML.
Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
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.
Example:
Shows how to create a node and set its owning document.// Open a file from disk Document doc = new Document(); // Creating a new node of any type requires a document passed into the constructor Paragraph para = new Paragraph(doc); // The new paragraph node does not yet have a parent System.out.println("Paragraph has no parent node: " + (para.getParentNode() == null)); // But the paragraph node knows its document System.out.println("Both nodes' documents are the same: " + (para.getDocument() == doc)); // The fact that a node always belongs to a document allows us to access and modify // properties that reference the document-wide data such as styles or lists para.getParagraphFormat().setStyleName("Heading 1"); // Now add the paragraph to the main text of the first section doc.getFirstSection().getBody().appendChild(para); // The paragraph node is now a child of the Body node System.out.println("Paragraph has a parent node: " + (para.getParentNode() != null));
getFirstChild | → inherited from CompositeNode |
public Node getFirstChild() |
Example:
Shows how to enumerate immediate child nodes of a composite node using NextSibling.Document doc = new Document(getMyDir() + "Paragraphs.docx"); // Loop starting from the first child until we reach null for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) { // Output the types of the nodes that we come across System.out.println(Node.nodeTypeToString(node.getNodeType())); }
Example:
Shows how to efficiently visit all direct and indirect children of a composite node.public void recurseAllNodes() throws Exception { Document doc = new Document(getMyDir() + "Paragraphs.docx"); // Any node that can contain child nodes, such as the document itself, is composite Assert.assertTrue(doc.isComposite()); // Invoke the recursive function that will go through and print all the child nodes of a composite node traverseAllNodes(doc, 0); } /// <summary> /// Recursively traverses a node tree while printing the type of each node with an indent depending on depth as well as the contents of all inline nodes. /// </summary> @Test(enabled = false) public void traverseAllNodes(CompositeNode parentNode, int depth) { // Loop through immediate children of a node for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { System.out.println(MessageFormat.format("{0}{1}", String.format(" ", depth), Node.nodeTypeToString(childNode.getNodeType()))); // Recurse into the node if it is a composite node if (childNode.isComposite()) { System.out.println(); traverseAllNodes((CompositeNode) childNode, depth + 1); } else if (childNode instanceof Inline) { System.out.println(" - \"{childNode.GetText().Trim()}\""); } else { System.out.println(); } } }
getFirstSection | |
public Section getFirstSection() |
null
if there are no sections.
Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
getGallery/setGallery | |
public int getGallery() / public void setGallery(int value) |
Building blocks in Microsoft Word user interface are arranged
into Galleries. Each
Corresponds to the docPartPr.category.gallery element in OOXML.
Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
getGuid/setGuid | |
public java.util.UUID getGuid() / public void setGuid(java.util.UUID value) |
Can be used by an application to uniquely reference a building block regardless of different naming due to localization.
Corresponds to the docPartPr.guid element in OOXML.
Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
hasChildNodes | → inherited from CompositeNode |
public boolean hasChildNodes() |
Example:
Shows how to combine the rows from two tables into one.// Load the document Document doc = new Document(getMyDir() + "Tables.docx"); // Get the first and second table in the document // The rows from the second table will be appended to the end of the first table Table firstTable = (Table) doc.getChild(NodeType.TABLE, 0, true); Table secondTable = (Table) doc.getChild(NodeType.TABLE, 1, true); // Append all rows from the current table to the next // Due to the design of tables even tables with different cell count and widths can be joined into one table while (secondTable.hasChildNodes()) firstTable.getRows().add(secondTable.getFirstRow()); // Remove the empty table container secondTable.remove(); doc.save(getArtifactsDir() + "Table.CombineTables.docx");
isComposite | → inherited from CompositeNode |
public boolean isComposite() |
Example:
Shows how to efficiently visit all direct and indirect children of a composite node.public void recurseAllNodes() throws Exception { Document doc = new Document(getMyDir() + "Paragraphs.docx"); // Any node that can contain child nodes, such as the document itself, is composite Assert.assertTrue(doc.isComposite()); // Invoke the recursive function that will go through and print all the child nodes of a composite node traverseAllNodes(doc, 0); } /// <summary> /// Recursively traverses a node tree while printing the type of each node with an indent depending on depth as well as the contents of all inline nodes. /// </summary> @Test(enabled = false) public void traverseAllNodes(CompositeNode parentNode, int depth) { // Loop through immediate children of a node for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { System.out.println(MessageFormat.format("{0}{1}", String.format(" ", depth), Node.nodeTypeToString(childNode.getNodeType()))); // Recurse into the node if it is a composite node if (childNode.isComposite()) { System.out.println(); traverseAllNodes((CompositeNode) childNode, depth + 1); } else if (childNode instanceof Inline) { System.out.println(" - \"{childNode.GetText().Trim()}\""); } else { System.out.println(); } } }
getLastChild | → inherited from CompositeNode |
public Node getLastChild() |
Example:
Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Create a second section by inserting a section break and add text to both sections builder.writeln("Section 1 text."); builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS); builder.writeln("Section 2 text."); // Both sections are siblings of each other Section lastSection = (Section) doc.getLastChild(); Section firstSection = (Section) lastSection.getPreviousSibling(); // Remove a section based on its sibling relationship with another section if (lastSection.getPreviousSibling() != null) doc.removeChild(firstSection); // The section we removed was the first one, leaving the document with only the second Assert.assertEquals("Section 2 text.", doc.getText().trim());
getLastSection | |
public Section getLastSection() |
null
if there are no sections.
Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
getName/setName | |
public java.lang.String getName() / public void setName(java.lang.String value) |
The name may contain any string content, usually a friendly identifier. Multiple building blocks can have the same name.
Cannot be null
and cannot be an empty string.
Corresponds to the docPartPr.name element in OOXML.
Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
getNextSibling | → inherited from Node |
public Node getNextSibling() |
Example:
Shows how to enumerate immediate child nodes of a composite node using NextSibling.Document doc = new Document(getMyDir() + "Paragraphs.docx"); // Loop starting from the first child until we reach null for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) { // Output the types of the nodes that we come across System.out.println(Node.nodeTypeToString(node.getNodeType())); }
Example:
Shows how to efficiently visit all direct and indirect children of a composite node.public void recurseAllNodes() throws Exception { Document doc = new Document(getMyDir() + "Paragraphs.docx"); // Any node that can contain child nodes, such as the document itself, is composite Assert.assertTrue(doc.isComposite()); // Invoke the recursive function that will go through and print all the child nodes of a composite node traverseAllNodes(doc, 0); } /// <summary> /// Recursively traverses a node tree while printing the type of each node with an indent depending on depth as well as the contents of all inline nodes. /// </summary> @Test(enabled = false) public void traverseAllNodes(CompositeNode parentNode, int depth) { // Loop through immediate children of a node for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { System.out.println(MessageFormat.format("{0}{1}", String.format(" ", depth), Node.nodeTypeToString(childNode.getNodeType()))); // Recurse into the node if it is a composite node if (childNode.isComposite()) { System.out.println(); traverseAllNodes((CompositeNode) childNode, depth + 1); } else if (childNode instanceof Inline) { System.out.println(" - \"{childNode.GetText().Trim()}\""); } else { System.out.println(); } } }
getNodeType | |
public int getNodeType() |
Example:
Shows how to efficiently visit all direct and indirect children of a composite node.public void recurseAllNodes() throws Exception { Document doc = new Document(getMyDir() + "Paragraphs.docx"); // Any node that can contain child nodes, such as the document itself, is composite Assert.assertTrue(doc.isComposite()); // Invoke the recursive function that will go through and print all the child nodes of a composite node traverseAllNodes(doc, 0); } /// <summary> /// Recursively traverses a node tree while printing the type of each node with an indent depending on depth as well as the contents of all inline nodes. /// </summary> @Test(enabled = false) public void traverseAllNodes(CompositeNode parentNode, int depth) { // Loop through immediate children of a node for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { System.out.println(MessageFormat.format("{0}{1}", String.format(" ", depth), Node.nodeTypeToString(childNode.getNodeType()))); // Recurse into the node if it is a composite node if (childNode.isComposite()) { System.out.println(); traverseAllNodes((CompositeNode) childNode, depth + 1); } else if (childNode instanceof Inline) { System.out.println(" - \"{childNode.GetText().Trim()}\""); } else { System.out.println(); } } }
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.
Example:
Shows how to access the parent node.Document doc = new Document(); // Get the document's first paragraph and append a child node to it in the form of a run with text Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); // When inserting a new node, the document that the node will belong to must be provided as an argument Run run = new Run(doc, "Hello world!"); para.appendChild(run); // The node lineage can be traced back to the document itself Assert.assertEquals(para, run.getParentNode()); Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode()); Assert.assertEquals(doc.getFirstSection(), doc.getFirstSection().getBody().getParentNode()); Assert.assertEquals(doc, doc.getFirstSection().getParentNode());
Example:
Shows how to create a node and set its owning document.// Open a file from disk Document doc = new Document(); // Creating a new node of any type requires a document passed into the constructor Paragraph para = new Paragraph(doc); // The new paragraph node does not yet have a parent System.out.println("Paragraph has no parent node: " + (para.getParentNode() == null)); // But the paragraph node knows its document System.out.println("Both nodes' documents are the same: " + (para.getDocument() == doc)); // The fact that a node always belongs to a document allows us to access and modify // properties that reference the document-wide data such as styles or lists para.getParagraphFormat().setStyleName("Heading 1"); // Now add the paragraph to the main text of the first section doc.getFirstSection().getBody().appendChild(para); // The paragraph node is now a child of the Body node System.out.println("Paragraph has a parent node: " + (para.getParentNode() != null));
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
Example:
Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Create a second section by inserting a section break and add text to both sections builder.writeln("Section 1 text."); builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS); builder.writeln("Section 2 text."); // Both sections are siblings of each other Section lastSection = (Section) doc.getLastChild(); Section firstSection = (Section) lastSection.getPreviousSibling(); // Remove a section based on its sibling relationship with another section if (lastSection.getPreviousSibling() != null) doc.removeChild(firstSection); // The section we removed was the first one, leaving the document with only the second Assert.assertEquals("Section 2 text.", doc.getText().trim());
getRange | → inherited from Node |
public Range getRange() |
Example:
Shows how to delete all characters of a range.// Insert two sections into a blank document Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Section 1. "); builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS); builder.write("Section 2."); // Verify the whole text of the document Assert.assertEquals("Section 1. \fSection 2.", doc.getText().trim()); // Delete the first section from the document doc.getSections().get(0).getRange().delete(); // Check the first section was deleted by looking at the text of the whole document again Assert.assertEquals("Section 2.", doc.getText().trim());
getSections | |
public SectionCollection getSections() |
Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
getType/setType | |
public int getType() / public void setType(int value) |
The building block type can influence the visibility and behavior of the building block in Microsoft Word.
Corresponds to the docPartPr.types element in OOXML.
Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
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 building block node and its children are not visited when you execute a
Visitor over a
visitor
- The visitor that will visit the nodes.Example:
Shows how to add a custom building block to a document.public void buildingBlockFields() throws Exception { Document doc = new Document(); // BuildingBlocks are stored inside the glossary document // If you're making a document from scratch, the glossary document must also be manually created GlossaryDocument glossaryDoc = new GlossaryDocument(); doc.setGlossaryDocument(glossaryDoc); // Create a building block and name it BuildingBlock block = new BuildingBlock(glossaryDoc); block.setName("Custom Block"); // Put in in the document's glossary document glossaryDoc.appendChild(block); Assert.assertEquals(glossaryDoc.getCount(), 1); // All GUIDs are this value by default Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000"); // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer Assert.assertEquals(block.getCategory(), "(Empty Category)"); Assert.assertEquals(block.getType(), BuildingBlockType.NONE); Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL); Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT); // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties // All the necessary preparation will be done in a custom document visitor that we will accept BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc); block.accept(visitor); // We can find the block we made in the glossary document like this BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS, "My custom building blocks", "Custom Block"); // Our block contains one section which now contains our text Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText()); Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection()); // Then we can insert it into the document as a new section doc.appendChild(doc.importNode(customBlock.getFirstSection(), true)); // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx"); } /// <summary> /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor. /// </summary> public static class BuildingBlockVisitor extends DocumentVisitor { public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) { mBuilder = new StringBuilder(); mGlossaryDoc = ownerGlossaryDoc; } public int visitBuildingBlockStart(final BuildingBlock block) { // Change values by default of created BuildingBlock block.setBehavior(BuildingBlockBehavior.PARAGRAPH); block.setCategory("My custom building blocks"); block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor."); block.setGallery(BuildingBlockGallery.QUICK_PARTS); block.setGuid(UUID.randomUUID()); // Add content for the BuildingBlock to have an effect when used in the document Section section = new Section(mGlossaryDoc); block.appendChild(section); Body body = new Body(mGlossaryDoc); section.appendChild(body); Paragraph paragraph = new Paragraph(mGlossaryDoc); body.appendChild(paragraph); // Add text that will be visible in the document Run run = new Run(mGlossaryDoc, "Text inside " + block.getName()); block.getFirstSection().getBody().getFirstParagraph().appendChild(run); return VisitorAction.CONTINUE; } public int visitBuildingBlockEnd(final BuildingBlock block) { mBuilder.append("Visited " + block.getName() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; private GlossaryDocument mGlossaryDoc; }
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.Example:
Shows how to construct an Aspose Words document node by node.Document doc = new Document(); // A newly created blank document still comes one section, one body and one paragraph // Calling this method will remove all those nodes to completely empty the document doc.removeAllChildren(); // This document now has no composite nodes that content can be added to // If we wish to edit it, we will need to repopulate its node collection, // which we will start to do with by creating a new Section node Section section = new Section(doc); // Append the section to the document doc.appendChild(section); // Lets set some properties for the section section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE); section.getPageSetup().setPaperSize(PaperSize.LETTER); // The section that we created is empty, lets populate it. The section needs at least the Body node Body body = new Body(doc); section.appendChild(body); // The body needs to have at least one paragraph // Note that the paragraph has not yet been added to the document, // but we have to specify the parent document // The parent document is needed so the paragraph can correctly work // with styles and other document-wide information Paragraph para = new Paragraph(doc); body.appendChild(para); // We can set some formatting for the paragraph para.getParagraphFormat().setStyleName("Heading 1"); para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); // So far we have one empty paragraph in the document // The document is valid and can be saved, but lets add some text before saving // Create a new run of text and add it to our paragraph Run run = new Run(doc); run.setText("Hello World!"); run.getFont().setColor(Color.RED); para.appendChild(run); Assert.assertEquals("Hello World!" + ControlChar.SECTION_BREAK_CHAR, doc.getText()); doc.save(getArtifactsDir() + "Section.CreateFromScratch.docx");
deepClone | → inherited from Node |
public Node deepClone(boolean isCloneChildren) |
Example:
Shows how to clone composite nodes with and without their child nodes.Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new Run(doc, "Hello world!")); // Clone the paragraph and the child nodes Node cloneWithChildren = para.deepClone(true); Assert.assertTrue(((CompositeNode) cloneWithChildren).hasChildNodes()); Assert.assertEquals("Hello world!", cloneWithChildren.getText().trim()); // Clone the paragraph without its clild nodes Node cloneWithoutChildren = para.deepClone(false); Assert.assertFalse(((CompositeNode) cloneWithoutChildren).hasChildNodes()); Assert.assertEquals("", cloneWithoutChildren.getText().trim());
getAncestor | → inherited from Node |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A Example:
Shows how to find out if a table contains another table or if the table itself is nested inside another table.public void calculateDepthOfNestedTables() throws Exception { Document doc = new Document(getMyDir() + "Nested tables.docx"); NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true); for (int i = 0; i < tables.getCount(); i++) { // First lets find if any cells in the table have tables themselves as children int count = getChildTableCount((Table) tables.get(i)); System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count)); // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth int tableDepth = getNestedDepthOfTable((Table) tables.get(i)); if (tableDepth > 0) System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth)); else System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i)); } } /** * Calculates what level a table is nested inside other tables. * * @returns An integer containing the level the table is nested at. * 0 = Table is not nested inside any other table * 1 = Table is nested within one parent table * 2 = Table is nested within two parent tables etc.. */ private static int getNestedDepthOfTable(final Table table) { int depth = 0; int type = table.getNodeType(); // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table Node parent = table.getAncestor(table.getNodeType()); while (parent != null) { // Every time we find a table a level up we increase the depth counter and then try to find an // ancestor of type table from the parent depth++; parent = parent.getAncestor(Table.class); } return depth; } /** * Determines if a table contains any immediate child table within its cells. * Does not recursively traverse through those tables to check for further tables. * * @returns Returns true if at least one child cell contains a table. * Returns false if no cells in the table contains a table. */ private static int getChildTableCount(final Table table) { int tableCount = 0; // Iterate through all child rows in the table for (Row row : table.getRows()) { // Iterate through all child cells in the row for (Cell cell : row.getCells()) { // Retrieve the collection of child tables of this cell TableCollection childTables = cell.getTables(); // If this cell has a table as a child then return true if (childTables.getCount() > 0) tableCount++; } } // No cell contains a table return tableCount; }
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.Example:
Shows how to find out if a table contains another table or if the table itself is nested inside another table.public void calculateDepthOfNestedTables() throws Exception { Document doc = new Document(getMyDir() + "Nested tables.docx"); NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true); for (int i = 0; i < tables.getCount(); i++) { // First lets find if any cells in the table have tables themselves as children int count = getChildTableCount((Table) tables.get(i)); System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count)); // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth int tableDepth = getNestedDepthOfTable((Table) tables.get(i)); if (tableDepth > 0) System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth)); else System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i)); } } /** * Calculates what level a table is nested inside other tables. * * @returns An integer containing the level the table is nested at. * 0 = Table is not nested inside any other table * 1 = Table is nested within one parent table * 2 = Table is nested within two parent tables etc.. */ private static int getNestedDepthOfTable(final Table table) { int depth = 0; int type = table.getNodeType(); // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table Node parent = table.getAncestor(table.getNodeType()); while (parent != null) { // Every time we find a table a level up we increase the depth counter and then try to find an // ancestor of type table from the parent depth++; parent = parent.getAncestor(Table.class); } return depth; } /** * Determines if a table contains any immediate child table within its cells. * Does not recursively traverse through those tables to check for further tables. * * @returns Returns true if at least one child cell contains a table. * Returns false if no cells in the table contains a table. */ private static int getChildTableCount(final Table table) { int tableCount = 0; // Iterate through all child rows in the table for (Row row : table.getRows()) { // Iterate through all child cells in the row for (Cell cell : row.getCells()) { // Retrieve the collection of child tables of this cell TableCollection childTables = cell.getTables(); // If this cell has a table as a child then return true if (childTables.getCount() > 0) tableCount++; } } // No cell contains a table return tableCount; }
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.Example:
Shows how to expand the formatting from styles onto the rows and cells of the table as direct formatting.Document doc = new Document(getMyDir() + "Tables.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); // First print the color of the cell shading. This should be empty as the current shading // is stored in the table style double cellShadingBefore = table.getFirstRow().getRowFormat().getHeight(); System.out.println("Cell shading before style expansion: " + cellShadingBefore); // Expand table style formatting to direct formatting doc.expandTableStylesToDirectFormatting(); // Now print the cell shading after expanding table styles. A blue background pattern color // should have been applied from the table style double cellShadingAfter = table.getFirstRow().getRowFormat().getHeight(); System.out.println("Cell shading after style expansion: " + cellShadingAfter); doc.save(getArtifactsDir() + "Document.TableStyleToDirectFormatting.docx");
Example:
Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.Document doc = new Document(); Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true); paragraph.appendChild(new Run(doc, "Hello world!")); paragraph.appendChild(new Run(doc, " Hello again!")); NodeCollection children = paragraph.getChildNodes(); // Paragraph may contain children of various types such as runs, shapes and so on for (Node child : (Iterable<Node>) children) if (((child.getNodeType()) == (NodeType.RUN))) { Run run = (Run) child; System.out.println(run.getText()); }
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. Example:
Shows how to get all comments with all replies.Document doc = new Document(getMyDir() + "Comments.docx"); // Get all comment from the document NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true); // For all comments and replies we identify comment level and info about it for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { System.out.println("\nThis is a top-level comment"); System.out.println("Comment author: " + comment.getAuthor()); System.out.println("Comment text: " + comment.getText()); for (Comment commentReply : comment.getReplies()) { System.out.println("\n\tThis is a comment reply"); System.out.println("\tReply author: " + commentReply.getAuthor()); System.out.println("\tReply text: " + commentReply.getText()); } } }
Example:
Shows how to extract images from a document and save them as files.Document doc = new Document(getMyDir() + "Images.docx"); NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true); int imageIndex = 0; for (Shape shape : (Iterable<Shape>) shapes) { if (shape.hasImage()) { String imageFileName = MessageFormat.format("File.ExtractImagesToFiles.{0}{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType())); shape.getImageData().save(getArtifactsDir() + imageFileName); imageIndex++; } } Assert.assertEquals(9, imageIndex);
getText | → inherited from CompositeNode |
public java.lang.String getText() |
The returned string includes all control and special characters as described in
Example:
Shows how to output all paragraphs in a document that are bulleted or numbered.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getListFormat().applyNumberDefault(); builder.writeln("Numbered list item 1"); builder.writeln("Numbered list item 2"); builder.writeln("Numbered list item 3"); builder.getListFormat().removeNumbers(); builder.getListFormat().applyBulletDefault(); builder.writeln("Bulleted list item 1"); builder.writeln("Bulleted list item 2"); builder.writeln("Bulleted list item 3"); builder.getListFormat().removeNumbers(); NodeCollection paras = doc.getChildNodes(NodeType.PARAGRAPH, true); for (Paragraph para : (Iterable<Paragraph>) paras) { if (para.getListFormat().isListItem()) { System.out.println(java.text.MessageFormat.format("*** A paragraph belongs to list {0}", para.getListFormat().getList().getListId())); System.out.println(para.getText()); } }
Example:
Shows the difference between calling the GetText and ToString methods on a node.Document doc = new Document(); // Enter a field into the document DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField("MERGEFIELD Field"); // GetText will retrieve all field codes and special characters Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText()); // ToString will give us the plaintext version of the document in the save format we put into the parameter Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));
indexOf | → inherited from CompositeNode |
public int indexOf(Node child) |
Example:
Shows how to get the index of a given child node from its parent.Document doc = new Document(getMyDir() + "Rendering.docx"); // Get the body of the first section in the document Body body = doc.getFirstSection().getBody(); // Retrieve the index of the last paragraph in the body Assert.assertEquals(24, body.getChildNodes().indexOf(body.getLastParagraph()));
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. Example:
Shows how to replace all textboxes with images.Document doc = new Document(getMyDir() + "Textboxes in drawing canvas.docx"); // This gets a live collection of all shape nodes in the document NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true); // Since we will be adding/removing nodes, it is better to copy all collection // into a fixed size array, otherwise iterator will be invalidated Node[] shapes = shapeCollection.toArray(); for (Node node : shapes) { Shape shape = (Shape) node; // Filter out all shapes that we don't need if (shape.getShapeType() == ShapeType.TEXT_BOX) { // Create a new shape that will replace the existing shape Shape image = new Shape(doc, ShapeType.IMAGE); // Load the image into the new shape image.getImageData().setImage(getImageDir() + "Windows MetaFile.wmf"); // Make new shape's position to match the old shape image.setLeft(shape.getLeft()); image.setTop(shape.getTop()); image.setWidth(shape.getWidth()); image.setHeight(shape.getHeight()); image.setRelativeHorizontalPosition(shape.getRelativeHorizontalPosition()); image.setRelativeVerticalPosition(shape.getRelativeVerticalPosition()); image.setHorizontalAlignment(shape.getHorizontalAlignment()); image.setVerticalAlignment(shape.getVerticalAlignment()); image.setWrapType(shape.getWrapType()); image.setWrapSide(shape.getWrapSide()); // Insert new shape after the old shape and remove the old shape shape.getParentNode().insertAfter(image, shape); shape.remove(); } } doc.save(getArtifactsDir() + "Shape.ReplaceTextboxesWithImages.docx");
Example:
Shows how to add, update and delete child nodes from a CompositeNode's child collection.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount()); // A paragraph is a composite node because it can contain runs, which are another type of node Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // We will place these 3 children into the main text of our paragraph Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // We initialized them but not in our paragraph yet Assert.assertEquals("Initial text.", paragraph.getText().trim()); // Insert run2 before initial paragraph text. This will be at the start of the paragraph paragraph.insertBefore(run2, paragraphText); // Insert run3 after initial paragraph text. This will be at the end of the paragraph paragraph.insertAfter(run3, paragraphText); // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1 paragraph.prependChild(run1); Assert.assertEquals("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim()); Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount()); // Access the child node collection and update/delete children ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. "); paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText); Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim()); Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());
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.Example:
Shows how to add, update and delete child nodes from a CompositeNode's child collection.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount()); // A paragraph is a composite node because it can contain runs, which are another type of node Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // We will place these 3 children into the main text of our paragraph Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // We initialized them but not in our paragraph yet Assert.assertEquals("Initial text.", paragraph.getText().trim()); // Insert run2 before initial paragraph text. This will be at the start of the paragraph paragraph.insertBefore(run2, paragraphText); // Insert run3 after initial paragraph text. This will be at the end of the paragraph paragraph.insertAfter(run3, paragraphText); // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1 paragraph.prependChild(run1); Assert.assertEquals("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim()); Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount()); // Access the child node collection and update/delete children ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. "); paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText); Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim()); Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());
iterator | → inherited from CompositeNode |
public java.util.Iterator<Node> iterator() |
Example:
Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.Document doc = new Document(); Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true); paragraph.appendChild(new Run(doc, "Hello world!")); paragraph.appendChild(new Run(doc, " Hello again!")); NodeCollection children = paragraph.getChildNodes(); // Paragraph may contain children of various types such as runs, shapes and so on for (Node child : (Iterable<Node>) children) if (((child.getNodeType()) == (NodeType.RUN))) { Run run = (Run) child; System.out.println(run.getText()); }
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.Example:
Shows how to delete all images from a document using pre-order tree traversal.Document doc = new Document(getMyDir() + "Images.docx"); Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10); Node curNode = doc; while (curNode != null) { Node nextNode = curNode.nextPreOrder(doc); if (curNode.previousPreOrder(doc) != null && nextNode != null) { Assert.assertEquals(curNode, nextNode.previousPreOrder(doc)); } if (curNode.getNodeType() == NodeType.SHAPE) { Shape shape = (Shape) curNode; // Several shape types can have an image including image shapes and OLE objects if (shape.hasImage()) { shape.remove(); } } curNode = nextNode; } // The only remaining shape doesn't have an image Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount()); Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());
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.Example:
Shows how to add, update and delete child nodes from a CompositeNode's child collection.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount()); // A paragraph is a composite node because it can contain runs, which are another type of node Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // We will place these 3 children into the main text of our paragraph Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // We initialized them but not in our paragraph yet Assert.assertEquals("Initial text.", paragraph.getText().trim()); // Insert run2 before initial paragraph text. This will be at the start of the paragraph paragraph.insertBefore(run2, paragraphText); // Insert run3 after initial paragraph text. This will be at the end of the paragraph paragraph.insertAfter(run3, paragraphText); // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1 paragraph.prependChild(run1); Assert.assertEquals("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim()); Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount()); // Access the child node collection and update/delete children ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. "); paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText); Assert.assertEquals("Run 1. Updated run 2. Run 3.", paragraph.getText().trim()); Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());
previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.Example:
Shows how to delete all images from a document using pre-order tree traversal.Document doc = new Document(getMyDir() + "Images.docx"); Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10); Node curNode = doc; while (curNode != null) { Node nextNode = curNode.nextPreOrder(doc); if (curNode.previousPreOrder(doc) != null && nextNode != null) { Assert.assertEquals(curNode, nextNode.previousPreOrder(doc)); } if (curNode.getNodeType() == NodeType.SHAPE) { Shape shape = (Shape) curNode; // Several shape types can have an image including image shapes and OLE objects if (shape.hasImage()) { shape.remove(); } } curNode = nextNode; } // The only remaining shape doesn't have an image Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount()); Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());
remove | → inherited from Node |
public void remove() |
Example:
Shows how to delete all images from a document.Document doc = new Document(getMyDir() + "Images.docx"); Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10); // Here we get all shapes from the document node, but you can do this for any smaller // node too, for example delete shapes from a single section or a paragraph NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true); // We cannot delete shape nodes while we enumerate through the collection // One solution is to add nodes that we want to delete to a temporary array and delete afterwards ArrayList shapesToDelete = new ArrayList(); for (Shape shape : (Iterable<Shape>) shapes) { // Several shape types can have an image including image shapes and OLE objects if (shape.hasImage()) { shapesToDelete.add(shape); } } // Now we can delete shapes for (Shape shape : (Iterable<Shape>) shapesToDelete) shape.remove(); // The only remaining shape doesn't have an image Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount()); Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());
Example:
Shows how to remove all nodes of a specific type from a composite node.Document doc = new Document(getMyDir() + "Tables.docx"); Assert.assertEquals(2, doc.getChildNodes(NodeType.TABLE, true).getCount()); // Select the first child node in the body Node curNode = doc.getFirstSection().getBody().getFirstChild(); while (curNode != null) { // Save the next sibling node as a variable in case we want to move to it after deleting this node Node nextNode = curNode.getNextSibling(); // A section body can contain Paragraph and Table nodes // If the node is a Table, remove it from the parent if (curNode.getNodeType() == NodeType.TABLE) { curNode.remove(); } // Continue going through child nodes until null (no more siblings) is reached curNode = nextNode; } Assert.assertEquals(0, doc.getChildNodes(NodeType.TABLE, true).getCount());
removeAllChildren | → inherited from CompositeNode |
public void removeAllChildren() |
Example:
Shows how to construct an Aspose Words document node by node.Document doc = new Document(); // A newly created blank document still comes one section, one body and one paragraph // Calling this method will remove all those nodes to completely empty the document doc.removeAllChildren(); // This document now has no composite nodes that content can be added to // If we wish to edit it, we will need to repopulate its node collection, // which we will start to do with by creating a new Section node Section section = new Section(doc); // Append the section to the document doc.appendChild(section); // Lets set some properties for the section section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE); section.getPageSetup().setPaperSize(PaperSize.LETTER); // The section that we created is empty, lets populate it. The section needs at least the Body node Body body = new Body(doc); section.appendChild(body); // The body needs to have at least one paragraph // Note that the paragraph has not yet been added to the document, // but we have to specify the parent document // The parent document is needed so the paragraph can correctly work // with styles and other document-wide information Paragraph para = new Paragraph(doc); body.appendChild(para); // We can set some formatting for the paragraph para.getParagraphFormat().setStyleName("Heading 1"); para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); // So far we have one empty paragraph in the document // The document is valid and can be saved, but lets add some text before saving // Create a new run of text and add it to our paragraph Run run = new Run(doc); run.setText("Hello World!"); run.getFont().setColor(Color.RED); para.appendChild(run); Assert.assertEquals("Hello World!" + ControlChar.SECTION_BREAK_CHAR, doc.getText()); doc.save(getArtifactsDir() + "Section.CreateFromScratch.docx");
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.Example:
Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Create a second section by inserting a section break and add text to both sections builder.writeln("Section 1 text."); builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS); builder.writeln("Section 2 text."); // Both sections are siblings of each other Section lastSection = (Section) doc.getLastChild(); Section firstSection = (Section) lastSection.getPreviousSibling(); // Remove a section based on its sibling relationship with another section if (lastSection.getPreviousSibling() != null) doc.removeChild(firstSection); // The section we removed was the first one, leaving the document with only the second Assert.assertEquals("Section 2 text.", doc.getText().trim());
removeSmartTags | → inherited from CompositeNode |
public void removeSmartTags() |
Example:
Removes all smart tags from descendant nodes of the composite node.Document doc = new Document(getMyDir() + "Smart tags.doc"); Assert.assertEquals(8, doc.getChildNodes(NodeType.SMART_TAG, true).getCount()); // Remove smart tags from the whole document doc.removeSmartTags(); Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
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.Example:
Shows how to select certain nodes by using an XPath expression.Document doc = new Document(getMyDir() + "Tables.docx"); // This expression will extract all paragraph nodes which are descendants of any table node in the document // This will return any paragraphs which are in a table NodeList nodeList = doc.selectNodes("//Table//Paragraph"); // Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table int index = 0; Iterator<Node> e = nodeList.iterator(); while (e.hasNext()) { Node currentNode = e.next(); System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim())); } // This expression will select any paragraphs that are direct children of any body node in the document nodeList = doc.selectNodes("//Body/Paragraph"); // We can treat the list as an array too Assert.assertEquals(nodeList.toArray().length, 4); // Use SelectSingleNode to select the first result of the same expression as above Node node = doc.selectSingleNode("//Body/Paragraph"); Assert.assertEquals(Paragraph.class, node.getClass());
Example:
Shows how to test if a node is inside a field by using an XPath expression.Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx"); // Evaluate the XPath expression. The resulting NodeList will contain all nodes found inside a field a field (between FieldStart // and FieldEnd exclusive). There can however be FieldStart and FieldEnd nodes in the list if there are nested fields // in the path. Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs NodeList resultList = doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]"); // Check if the specified run is one of the nodes that are inside the field System.out.println("Contents of the first Run node that's part of a field: {resultList.First(n => n.NodeType == NodeType.Run).GetText().Trim()}");
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.Example:
Shows how to select certain nodes by using an XPath expression.Document doc = new Document(getMyDir() + "Tables.docx"); // This expression will extract all paragraph nodes which are descendants of any table node in the document // This will return any paragraphs which are in a table NodeList nodeList = doc.selectNodes("//Table//Paragraph"); // Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table int index = 0; Iterator<Node> e = nodeList.iterator(); while (e.hasNext()) { Node currentNode = e.next(); System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim())); } // This expression will select any paragraphs that are direct children of any body node in the document nodeList = doc.selectNodes("//Body/Paragraph"); // We can treat the list as an array too Assert.assertEquals(nodeList.toArray().length, 4); // Use SelectSingleNode to select the first result of the same expression as above Node node = doc.selectSingleNode("//Body/Paragraph"); Assert.assertEquals(Paragraph.class, node.getClass());
toString | → inherited from Node |
public java.lang.String toString(SaveOptions saveOptions) throws java.lang.Exception |
saveOptions
- Specifies the options that control how the node is saved.Example:
Exports the content of a node to String in HTML format.Document doc = new Document(getMyDir() + "Document.docx"); // Extract the last paragraph in the document to convert to HTML Node node = doc.getLastSection().getBody().getLastParagraph(); // When ToString is called using the html SaveFormat overload then the node is converted directly to html Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" + "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" + "</p>", node.toString(SaveFormat.HTML)); // We can also modify the result of this conversion using a SaveOptions object HtmlSaveOptions saveOptions = new HtmlSaveOptions(); saveOptions.setExportRelativeFontSize(true); Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" + "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" + "</p>", node.toString(saveOptions));
toString | → inherited from Node |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.Example:
Shows how to extract the label of each paragraph in a list as a value or a String.Document doc = new Document(getMyDir() + "Rendering.docx"); doc.updateListLabels(); int listParaCount = 1; for (Paragraph paragraph : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) { // Find if we have the paragraph list. In our document our list uses plain arabic numbers, // which start at three and ends at six if (paragraph.getListFormat().isListItem()) { System.out.println(MessageFormat.format("List item paragraph #{0}", listParaCount)); // This is the text we get when actually getting when we output this node to text format // The list labels are not included in this text output. Trim any paragraph formatting characters String paragraphText = paragraph.toString(SaveFormat.TEXT).trim(); System.out.println("Exported Text: " + paragraphText); ListLabel label = paragraph.getListLabel(); // This gets the position of the paragraph in current level of the list. If we have a list with multiple level then this // will tell us what position it is on that particular level System.out.println("\tNumerical Id: " + label.getLabelValue()); // Combine them together to include the list label with the text in the output System.out.println("\tList label combined with text: " + label.getLabelString() + " " + paragraphText); listParaCount++; } }
Example:
Exports the content of a node to String in HTML format.Document doc = new Document(getMyDir() + "Document.docx"); // Extract the last paragraph in the document to convert to HTML Node node = doc.getLastSection().getBody().getLastParagraph(); // When ToString is called using the html SaveFormat overload then the node is converted directly to html Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" + "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" + "</p>", node.toString(SaveFormat.HTML)); // We can also modify the result of this conversion using a SaveOptions object HtmlSaveOptions saveOptions = new HtmlSaveOptions(); saveOptions.setExportRelativeFontSize(true); Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" + "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" + "</p>", node.toString(saveOptions));
Example:
Shows the difference between calling the GetText and ToString methods on a node.Document doc = new Document(); // Enter a field into the document DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField("MERGEFIELD Field"); // GetText will retrieve all field codes and special characters Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText()); // ToString will give us the plaintext version of the document in the save format we put into the parameter Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));