public class FieldStart
A complete field in a Microsoft Word document is a complex structure consisting of a field start character, field code, field separator character, field result and field end character. Some fields only have field start, field code and field end.
To easily insert a new field into a document, use the
Example:
Shows how to work with a collection of fields.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" "); builder.insertField(" TIME "); builder.insertField(" REVNUM "); builder.insertField(" AUTHOR \"John Doe\" "); builder.insertField(" SUBJECT \"My Subject\" "); builder.insertField(" QUOTE \"Hello world!\" "); doc.updateFields(); FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(6, fields.getCount()); // Iterate over the field collection, and print contents and type // of every field using a custom visitor implementation. FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); /// <summary> /// Document visitor implementation that prints field info. /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private final /*final*/ StringBuilder mBuilder; }
Example:
Shows how to find all hyperlinks in a Word document, and then change their URLs and display names.import com.aspose.words.*; import org.testng.annotations.Test; import java.util.regex.Matcher; import java.util.regex.Pattern; Document doc = new Document(getMyDir() + "Hyperlinks.docx"); // Hyperlinks in a Word documents are fields. To begin looking for hyperlinks, we must first find all the fields. // Use the "SelectNodes" method to find all the fields in the document via an XPath. NodeList fieldStarts = doc.selectNodes("//FieldStart"); for (FieldStart fieldStart : (Iterable<FieldStart>) fieldStarts) { if (fieldStart.getFieldType() == FieldType.FIELD_HYPERLINK) { Hyperlink hyperlink = new Hyperlink(fieldStart); // Hyperlinks that link to bookmarks do not have URLs. if (hyperlink.isLocal()) continue; // Give each URL hyperlink a new URL and name. hyperlink.setTarget(NEW_URL); hyperlink.setName(NEW_NAME); } } doc.save(getArtifactsDir() + "ReplaceHyperlinks.Fields.docx"); } private static final String NEW_URL = "http://www.aspose.com"; private static final String NEW_NAME = "Aspose - The .NET & Java Component Publisher"; } /** * This "facade" class makes it easier to work with a hyperlink field in a Word document. * <p> * HYPERLINK fields contain and display hyperlinks in the document body. A field in Aspose.Words * consists of several nodes, and it might be difficult to work with all those nodes directly. * This implementation will work only if the hyperlink code and name each consist of only one Run node. * <p> * The node structure for fields is as follows: * <p> * [FieldStart][Run - field code][FieldSeparator][Run - field result][FieldEnd] * <p> * Below are two example field codes of HYPERLINK fields: * HYPERLINK "url" * HYPERLINK \l "bookmark name" * <p> * A field's "Result" property contains text that the field displays in the document body to the user. */ class Hyperlink { Hyperlink(final FieldStart fieldStart) throws Exception { if (fieldStart == null) { throw new IllegalArgumentException("fieldStart"); } if (fieldStart.getFieldType() != FieldType.FIELD_HYPERLINK) { throw new IllegalArgumentException("Field start type must be FieldHyperlink."); } mFieldStart = fieldStart; // Find the field separator node. mFieldSeparator = findNextSibling(mFieldStart, NodeType.FIELD_SEPARATOR); if (mFieldSeparator == null) { throw new IllegalStateException("Cannot find field separator."); } // Normally, we can always find the field's end node, but the example document // contains a paragraph break inside a hyperlink, which puts the field end // in the next paragraph. It will be much more complicated to handle fields which span several // paragraphs correctly. In this case allowing field end to be null is enough. mFieldEnd = findNextSibling(mFieldSeparator, NodeType.FIELD_END); // Field code looks something like "HYPERLINK "http:\\www.myurl.com"", but it can consist of several runs. String fieldCode = getTextSameParent(mFieldStart.getNextSibling(), mFieldSeparator); Matcher matcher = G_REGEX.matcher(fieldCode.trim()); matcher.find(); // The hyperlink is local if \l is present in the field code. mIsLocal = (matcher.group(1) != null) && (matcher.group(1).length() > 0); mTarget = matcher.group(2); } /** * Gets or sets the display name of the hyperlink. */ String getName() throws Exception { return getTextSameParent(mFieldSeparator, mFieldEnd); } void setName(final String value) throws Exception { // Hyperlink display name is stored in the field result, which is a Run // node between field separator and field end. Run fieldResult = (Run) mFieldSeparator.getNextSibling(); fieldResult.setText(value); // If the field result consists of more than one run, delete these runs. removeSameParent(fieldResult.getNextSibling(), mFieldEnd); } /** * Gets or sets the target URL or bookmark name of the hyperlink. */ String getTarget() { return mTarget; } void setTarget(final String value) throws Exception { mTarget = value; updateFieldCode(); } /** * True if the hyperlinks target is a bookmark inside the document. False if the hyperlink is a URL. */ boolean isLocal() { return mIsLocal; } void isLocal(final boolean value) throws Exception { mIsLocal = value; updateFieldCode(); } private void updateFieldCode() throws Exception { // A field's field code is in a Run node between the field's start node and field separator. Run fieldCode = (Run) mFieldStart.getNextSibling(); fieldCode.setText(java.text.MessageFormat.format("HYPERLINK {0}\"{1}\"", ((mIsLocal) ? "\\l " : ""), mTarget)); // If the field code consists of more than one run, delete these runs. removeSameParent(fieldCode.getNextSibling(), mFieldSeparator); } /** * Goes through siblings starting from the start node until it finds a node of the specified type or null. */ private static Node findNextSibling(final Node startNode, final int nodeType) { for (Node node = startNode; node != null; node = node.getNextSibling()) { if (node.getNodeType() == nodeType) return node; } return null; } /** * Retrieves text from start up to but not including the end node. */ private static String getTextSameParent(final Node startNode, final Node endNode) { if ((endNode != null) && (startNode.getParentNode() != endNode.getParentNode())) { throw new IllegalArgumentException("Start and end nodes are expected to have the same parent."); } StringBuilder builder = new StringBuilder(); for (Node child = startNode; !child.equals(endNode); child = child.getNextSibling()) { builder.append(child.getText()); } return builder.toString(); } /** * Removes nodes from start up to but not including the end node. * Assumes that the start and end nodes have the same parent. */ private static void removeSameParent(final Node startNode, final Node endNode) { if ((endNode != null) && (startNode.getParentNode() != endNode.getParentNode())) { throw new IllegalArgumentException("Start and end nodes are expected to have the same parent."); } Node curChild = startNode; while ((curChild != null) && (curChild != endNode)) { Node nextChild = curChild.getNextSibling(); curChild.remove(); curChild = nextChild; } } private final Node mFieldStart; private final Node mFieldSeparator; private final Node mFieldEnd; private boolean mIsLocal; private String mTarget; private static final Pattern G_REGEX = Pattern.compile( "\\S+" + // One or more non spaces HYPERLINK or other word in other languages. "\\s+" + // One or more spaces. "(?:\"\"\\s+)?" + // Non-capturing optional "" and one or more spaces. "(\\\\l\\s+)?" + // Optional \l flag followed by one or more spaces. "\"" + // One apostrophe. "([^\"]+)" + // One or more characters, excluding the apostrophe (hyperlink target). "\"" // One closing apostrophe. ); }
Property Getters/Setters Summary | ||
---|---|---|
int | getCustomNodeId() | |
void | setCustomNodeId(intvalue) | |
Specifies custom node identifier. | ||
DocumentBase | getDocument() | |
Gets the document to which this node belongs.
|
||
byte[] | getFieldData() | |
Gets custom field data which is associated with the field.
|
||
int | getFieldType() | |
Returns the type of the field.
The value of the property is FieldType integer constant. |
||
Font | getFont() | |
Provides access to the font formatting of this object.
|
||
boolean | isComposite() | |
Returns true if this node can contain other nodes.
|
||
boolean | isDeleteRevision() | |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
|
||
boolean | isDirty() | |
void | isDirty(booleanvalue) | |
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. | ||
boolean | isFormatRevision() | |
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
|
||
boolean | isInsertRevision() | |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
|
||
boolean | isLocked() | |
void | isLocked(booleanvalue) | |
Gets or sets whether the parent field is locked (should not recalculate its result). | ||
boolean | isMoveFromRevision() | |
Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
|
||
boolean | isMoveToRevision() | |
Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
|
||
Node | getNextSibling() | |
Gets the node immediately following this node.
|
||
int | getNodeType() | |
Returns |
||
CompositeNode | getParentNode() | |
Gets the immediate parent of this node.
|
||
Paragraph | getParentParagraph() | |
Retrieves the parent |
||
Node | getPreviousSibling() | |
Gets the node immediately preceding this node.
|
||
Range | getRange() | |
Returns a Range object that represents the portion of a document that is contained in this node.
|
Method Summary | ||
---|---|---|
boolean | accept(DocumentVisitor visitor) | |
Accepts a visitor.
|
||
Node | deepClone(boolean isCloneChildren) | |
Creates a duplicate of the node.
|
||
CompositeNode | getAncestor(int ancestorType) | |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | |
Gets the first ancestor of the specified object type.
|
||
Field | getField() | |
Returns a field for the field char.
|
||
java.lang.String | getText() | |
Gets the special character that this node represents.
|
||
Node | nextPreOrder(Node rootNode) | |
Gets next node according to the pre-order tree traversal algorithm.
|
||
Node | previousPreOrder(Node rootNode) | |
Gets the previous node according to the pre-order tree traversal algorithm.
|
||
void | remove() | |
Removes itself from the parent.
|
||
java.lang.String | toString(SaveOptions saveOptions) | |
Exports the content of the node into a string using the specified save options.
|
||
java.lang.String | toString(int saveFormat) | |
Exports the content of the node into a string in the specified format.
|
public int getCustomNodeId() / public void setCustomNodeId(int value)
Default is zero.
This identifier can be set and used arbitrarily. For example, as a key to get external data.
Important note, specified value is not saved to an output file and exists only during the node lifetime.
Example:
Shows how to traverse through a composite node's collection of child nodes.Document doc = new Document(); // Add two runs and one shape as child nodes to the first paragraph of this document. Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true); paragraph.appendChild(new Run(doc, "Hello world! ")); Shape shape = new Shape(doc, ShapeType.RECTANGLE); shape.setWidth(200.0); shape.setHeight(200.0); // Note that the 'CustomNodeId' is not saved to an output file and exists only during the node lifetime. shape.setCustomNodeId(100); shape.setWrapType(WrapType.INLINE); paragraph.appendChild(shape); paragraph.appendChild(new Run(doc, "Hello again!")); // Iterate through the paragraph's collection of immediate children, // and print any runs or shapes that we find within. NodeCollection children = paragraph.getChildNodes(); Assert.assertEquals(3, paragraph.getChildNodes().getCount()); for (Node child : (Iterable<Node>) children) switch (child.getNodeType()) { case NodeType.RUN: System.out.println("Run contents:"); System.out.println("\t\"{child.GetText().Trim()}\""); break; case NodeType.SHAPE: Shape childShape = (Shape) child; System.out.println("Shape:"); System.out.println("\t{childShape.ShapeType}, {childShape.Width}x{childShape.Height}"); }
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.Document doc = new Document(); Paragraph para = new Paragraph(doc); para.appendChild(new Run(doc, "Hello world!")); // We have not yet appended this paragraph as a child to any composite node. Assert.assertNull(para.getParentNode()); // If a node is an appropriate child node type of another composite node, // we can attach it as a child only if both nodes have the same owner document. // The owner document is the document we passed to the node's constructor. // We have not attached this paragraph to the document, so the document does not contain its text. Assert.assertEquals(para.getDocument(), doc); Assert.assertEquals("", doc.getText().trim()); // Since the document owns this paragraph, we can apply one of its styles to the paragraph's contents. para.getParagraphFormat().setStyleName("Heading 1"); // Add this node to the document, and then verify its contents. doc.getFirstSection().getBody().appendChild(para); Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode()); Assert.assertEquals("Hello world!", doc.getText().trim());
public byte[] getFieldData()
public int getFieldType()
Example:
Shows how to work with a FieldStart node.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); FieldDate field = (FieldDate) builder.insertField(FieldType.FIELD_DATE, true); field.getFormat().setDateTimeFormat("dddd, MMMM dd, yyyy"); field.update(); FieldChar fieldStart = field.getStart(); Assert.assertEquals(FieldType.FIELD_DATE, fieldStart.getFieldType()); Assert.assertEquals(false, fieldStart.isDirty()); Assert.assertEquals(false, fieldStart.isLocked()); // Retrieve the facade object which represents the field in the document. field = (FieldDate) fieldStart.getField(); Assert.assertEquals(false, field.isLocked()); Assert.assertEquals(" DATE \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode()); // Update the field to show the current date. field.update();
public Font getFont()
Example:
Shows how to construct an Aspose.Words document by hand.Document doc = new Document(); // A blank document contains one section, one body and one paragraph. // Call the "RemoveAllChildren" method to remove all those nodes, // and end up with a document node with no children. doc.removeAllChildren(); // This document now has no composite child nodes that we can add content to. // If we wish to edit it, we will need to repopulate its node collection. // First, create a new section, and then append it as a child to the root document node. Section section = new Section(doc); doc.appendChild(section); // Set some page setup properties for the section. section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE); section.getPageSetup().setPaperSize(PaperSize.LETTER); // A section needs a body, which will contain and display all its contents // on the page between the section's header and footer. Body body = new Body(doc); section.appendChild(body); // Create a paragraph, set some formatting properties, and then append it as a child to the body. Paragraph para = new Paragraph(doc); para.getParagraphFormat().setStyleName("Heading 1"); para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); body.appendChild(para); // Finally, add some content to do the document. Create a run, // set its appearance and contents, and then append it as a child to the paragraph. Run run = new Run(doc); run.setText("Hello World!"); run.getFont().setColor(Color.RED); para.appendChild(run); Assert.assertEquals("Hello World!", doc.getText().trim()); doc.save(getArtifactsDir() + "Section.CreateManually.docx");
public boolean isComposite()
Example:
Shows how to traverse a composite node's tree of child nodes.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) { 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. Otherwise, print its contents if it is an inline 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(); } } }
public boolean isDeleteRevision()
Example:
Shows how to determine the revision type of an inline node.Document doc = new Document(getMyDir() + "Revision runs.docx"); // When we edit the document while the "Track Changes" option, found in via Review -> Tracking, // is turned on in Microsoft Word, the changes we apply count as revisions. // When editing a document using Aspose.Words, we can begin tracking revisions by // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method. // We can either accept revisions to assimilate them into the document // or reject them to change the proposed change effectively. Assert.assertEquals(6, doc.getRevisions().getCount()); // The parent node of a revision is the run that the revision concerns. A Run is an Inline node. Run run = (Run) doc.getRevisions().get(0).getParentNode(); Paragraph firstParagraph = run.getParentParagraph(); RunCollection runs = firstParagraph.getRuns(); Assert.assertEquals(runs.getCount(), 6); // Below are five types of revisions that can flag an Inline node. // 1 - An "insert" revision: // This revision occurs when we insert text while tracking changes. Assert.assertTrue(runs.get(2).isInsertRevision()); // 2 - A "format" revision: // This revision occurs when we change the formatting of text while tracking changes. Assert.assertTrue(runs.get(2).isFormatRevision()); // 3 - A "move from" revision: // When we highlight text in Microsoft Word, and then drag it to a different place in the document // while tracking changes, two revisions appear. // The "move from" revision is a copy of the text originally before we moved it. Assert.assertTrue(runs.get(4).isMoveFromRevision()); // 4 - A "move to" revision: // The "move to" revision is the text that we moved in its new position in the document. // "Move from" and "move to" revisions appear in pairs for every move revision we carry out. // Accepting a move revision deletes the "move from" revision and its text, // and keeps the text from the "move to" revision. // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision. Assert.assertTrue(runs.get(1).isMoveToRevision()); // 5 - A "delete" revision: // This revision occurs when we delete text while tracking changes. When we delete text like this, // it will stay in the document as a revision until we either accept the revision, // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was. Assert.assertTrue(runs.get(5).isDeleteRevision());
public boolean isDirty() / public void isDirty(boolean value)
Example:
Shows how to work with a FieldStart node.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); FieldDate field = (FieldDate) builder.insertField(FieldType.FIELD_DATE, true); field.getFormat().setDateTimeFormat("dddd, MMMM dd, yyyy"); field.update(); FieldChar fieldStart = field.getStart(); Assert.assertEquals(FieldType.FIELD_DATE, fieldStart.getFieldType()); Assert.assertEquals(false, fieldStart.isDirty()); Assert.assertEquals(false, fieldStart.isLocked()); // Retrieve the facade object which represents the field in the document. field = (FieldDate) fieldStart.getField(); Assert.assertEquals(false, field.isLocked()); Assert.assertEquals(" DATE \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode()); // Update the field to show the current date. field.update();
public boolean isFormatRevision()
Example:
Shows how to determine the revision type of an inline node.Document doc = new Document(getMyDir() + "Revision runs.docx"); // When we edit the document while the "Track Changes" option, found in via Review -> Tracking, // is turned on in Microsoft Word, the changes we apply count as revisions. // When editing a document using Aspose.Words, we can begin tracking revisions by // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method. // We can either accept revisions to assimilate them into the document // or reject them to change the proposed change effectively. Assert.assertEquals(6, doc.getRevisions().getCount()); // The parent node of a revision is the run that the revision concerns. A Run is an Inline node. Run run = (Run) doc.getRevisions().get(0).getParentNode(); Paragraph firstParagraph = run.getParentParagraph(); RunCollection runs = firstParagraph.getRuns(); Assert.assertEquals(runs.getCount(), 6); // Below are five types of revisions that can flag an Inline node. // 1 - An "insert" revision: // This revision occurs when we insert text while tracking changes. Assert.assertTrue(runs.get(2).isInsertRevision()); // 2 - A "format" revision: // This revision occurs when we change the formatting of text while tracking changes. Assert.assertTrue(runs.get(2).isFormatRevision()); // 3 - A "move from" revision: // When we highlight text in Microsoft Word, and then drag it to a different place in the document // while tracking changes, two revisions appear. // The "move from" revision is a copy of the text originally before we moved it. Assert.assertTrue(runs.get(4).isMoveFromRevision()); // 4 - A "move to" revision: // The "move to" revision is the text that we moved in its new position in the document. // "Move from" and "move to" revisions appear in pairs for every move revision we carry out. // Accepting a move revision deletes the "move from" revision and its text, // and keeps the text from the "move to" revision. // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision. Assert.assertTrue(runs.get(1).isMoveToRevision()); // 5 - A "delete" revision: // This revision occurs when we delete text while tracking changes. When we delete text like this, // it will stay in the document as a revision until we either accept the revision, // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was. Assert.assertTrue(runs.get(5).isDeleteRevision());
public boolean isInsertRevision()
Example:
Shows how to determine the revision type of an inline node.Document doc = new Document(getMyDir() + "Revision runs.docx"); // When we edit the document while the "Track Changes" option, found in via Review -> Tracking, // is turned on in Microsoft Word, the changes we apply count as revisions. // When editing a document using Aspose.Words, we can begin tracking revisions by // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method. // We can either accept revisions to assimilate them into the document // or reject them to change the proposed change effectively. Assert.assertEquals(6, doc.getRevisions().getCount()); // The parent node of a revision is the run that the revision concerns. A Run is an Inline node. Run run = (Run) doc.getRevisions().get(0).getParentNode(); Paragraph firstParagraph = run.getParentParagraph(); RunCollection runs = firstParagraph.getRuns(); Assert.assertEquals(runs.getCount(), 6); // Below are five types of revisions that can flag an Inline node. // 1 - An "insert" revision: // This revision occurs when we insert text while tracking changes. Assert.assertTrue(runs.get(2).isInsertRevision()); // 2 - A "format" revision: // This revision occurs when we change the formatting of text while tracking changes. Assert.assertTrue(runs.get(2).isFormatRevision()); // 3 - A "move from" revision: // When we highlight text in Microsoft Word, and then drag it to a different place in the document // while tracking changes, two revisions appear. // The "move from" revision is a copy of the text originally before we moved it. Assert.assertTrue(runs.get(4).isMoveFromRevision()); // 4 - A "move to" revision: // The "move to" revision is the text that we moved in its new position in the document. // "Move from" and "move to" revisions appear in pairs for every move revision we carry out. // Accepting a move revision deletes the "move from" revision and its text, // and keeps the text from the "move to" revision. // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision. Assert.assertTrue(runs.get(1).isMoveToRevision()); // 5 - A "delete" revision: // This revision occurs when we delete text while tracking changes. When we delete text like this, // it will stay in the document as a revision until we either accept the revision, // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was. Assert.assertTrue(runs.get(5).isDeleteRevision());
public boolean isLocked() / public void isLocked(boolean value)
Example:
Shows how to work with a FieldStart node.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); FieldDate field = (FieldDate) builder.insertField(FieldType.FIELD_DATE, true); field.getFormat().setDateTimeFormat("dddd, MMMM dd, yyyy"); field.update(); FieldChar fieldStart = field.getStart(); Assert.assertEquals(FieldType.FIELD_DATE, fieldStart.getFieldType()); Assert.assertEquals(false, fieldStart.isDirty()); Assert.assertEquals(false, fieldStart.isLocked()); // Retrieve the facade object which represents the field in the document. field = (FieldDate) fieldStart.getField(); Assert.assertEquals(false, field.isLocked()); Assert.assertEquals(" DATE \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode()); // Update the field to show the current date. field.update();
public boolean isMoveFromRevision()
Example:
Shows how to determine the revision type of an inline node.Document doc = new Document(getMyDir() + "Revision runs.docx"); // When we edit the document while the "Track Changes" option, found in via Review -> Tracking, // is turned on in Microsoft Word, the changes we apply count as revisions. // When editing a document using Aspose.Words, we can begin tracking revisions by // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method. // We can either accept revisions to assimilate them into the document // or reject them to change the proposed change effectively. Assert.assertEquals(6, doc.getRevisions().getCount()); // The parent node of a revision is the run that the revision concerns. A Run is an Inline node. Run run = (Run) doc.getRevisions().get(0).getParentNode(); Paragraph firstParagraph = run.getParentParagraph(); RunCollection runs = firstParagraph.getRuns(); Assert.assertEquals(runs.getCount(), 6); // Below are five types of revisions that can flag an Inline node. // 1 - An "insert" revision: // This revision occurs when we insert text while tracking changes. Assert.assertTrue(runs.get(2).isInsertRevision()); // 2 - A "format" revision: // This revision occurs when we change the formatting of text while tracking changes. Assert.assertTrue(runs.get(2).isFormatRevision()); // 3 - A "move from" revision: // When we highlight text in Microsoft Word, and then drag it to a different place in the document // while tracking changes, two revisions appear. // The "move from" revision is a copy of the text originally before we moved it. Assert.assertTrue(runs.get(4).isMoveFromRevision()); // 4 - A "move to" revision: // The "move to" revision is the text that we moved in its new position in the document. // "Move from" and "move to" revisions appear in pairs for every move revision we carry out. // Accepting a move revision deletes the "move from" revision and its text, // and keeps the text from the "move to" revision. // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision. Assert.assertTrue(runs.get(1).isMoveToRevision()); // 5 - A "delete" revision: // This revision occurs when we delete text while tracking changes. When we delete text like this, // it will stay in the document as a revision until we either accept the revision, // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was. Assert.assertTrue(runs.get(5).isDeleteRevision());
public boolean isMoveToRevision()
Example:
Shows how to determine the revision type of an inline node.Document doc = new Document(getMyDir() + "Revision runs.docx"); // When we edit the document while the "Track Changes" option, found in via Review -> Tracking, // is turned on in Microsoft Word, the changes we apply count as revisions. // When editing a document using Aspose.Words, we can begin tracking revisions by // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method. // We can either accept revisions to assimilate them into the document // or reject them to change the proposed change effectively. Assert.assertEquals(6, doc.getRevisions().getCount()); // The parent node of a revision is the run that the revision concerns. A Run is an Inline node. Run run = (Run) doc.getRevisions().get(0).getParentNode(); Paragraph firstParagraph = run.getParentParagraph(); RunCollection runs = firstParagraph.getRuns(); Assert.assertEquals(runs.getCount(), 6); // Below are five types of revisions that can flag an Inline node. // 1 - An "insert" revision: // This revision occurs when we insert text while tracking changes. Assert.assertTrue(runs.get(2).isInsertRevision()); // 2 - A "format" revision: // This revision occurs when we change the formatting of text while tracking changes. Assert.assertTrue(runs.get(2).isFormatRevision()); // 3 - A "move from" revision: // When we highlight text in Microsoft Word, and then drag it to a different place in the document // while tracking changes, two revisions appear. // The "move from" revision is a copy of the text originally before we moved it. Assert.assertTrue(runs.get(4).isMoveFromRevision()); // 4 - A "move to" revision: // The "move to" revision is the text that we moved in its new position in the document. // "Move from" and "move to" revisions appear in pairs for every move revision we carry out. // Accepting a move revision deletes the "move from" revision and its text, // and keeps the text from the "move to" revision. // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision. Assert.assertTrue(runs.get(1).isMoveToRevision()); // 5 - A "delete" revision: // This revision occurs when we delete text while tracking changes. When we delete text like this, // it will stay in the document as a revision until we either accept the revision, // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was. Assert.assertTrue(runs.get(5).isDeleteRevision());
public Node getNextSibling()
Example:
Shows how to use a node's NextSibling property to enumerate through its immediate children.Document doc = new Document(getMyDir() + "Paragraphs.docx"); for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) { System.out.println(Node.nodeTypeToString(node.getNodeType())); }
Example:
Shows how to traverse a composite node's tree of child nodes.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) { 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. Otherwise, print its contents if it is an inline 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(); } } }
public int getNodeType()
Example:
Shows how to traverse a composite node's tree of child nodes.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) { 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. Otherwise, print its contents if it is an inline 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(); } } }
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 a node's parent node.Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); // Append a child Run node to the document's first paragraph. Run run = new Run(doc, "Hello world!"); para.appendChild(run); // The paragraph is the parent node of the run node. We can trace this lineage // all the way to the document node, which is the root of the document's node tree. 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.Document doc = new Document(); Paragraph para = new Paragraph(doc); para.appendChild(new Run(doc, "Hello world!")); // We have not yet appended this paragraph as a child to any composite node. Assert.assertNull(para.getParentNode()); // If a node is an appropriate child node type of another composite node, // we can attach it as a child only if both nodes have the same owner document. // The owner document is the document we passed to the node's constructor. // We have not attached this paragraph to the document, so the document does not contain its text. Assert.assertEquals(para.getDocument(), doc); Assert.assertEquals("", doc.getText().trim()); // Since the document owns this paragraph, we can apply one of its styles to the paragraph's contents. para.getParagraphFormat().setStyleName("Heading 1"); // Add this node to the document, and then verify its contents. doc.getFirstSection().getBody().appendChild(para); Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode()); Assert.assertEquals("Hello world!", doc.getText().trim());
public Paragraph getParentParagraph()
Example:
Shows how to determine the revision type of an inline node.Document doc = new Document(getMyDir() + "Revision runs.docx"); // When we edit the document while the "Track Changes" option, found in via Review -> Tracking, // is turned on in Microsoft Word, the changes we apply count as revisions. // When editing a document using Aspose.Words, we can begin tracking revisions by // invoking the document's "StartTrackRevisions" method and stop tracking by using the "StopTrackRevisions" method. // We can either accept revisions to assimilate them into the document // or reject them to change the proposed change effectively. Assert.assertEquals(6, doc.getRevisions().getCount()); // The parent node of a revision is the run that the revision concerns. A Run is an Inline node. Run run = (Run) doc.getRevisions().get(0).getParentNode(); Paragraph firstParagraph = run.getParentParagraph(); RunCollection runs = firstParagraph.getRuns(); Assert.assertEquals(runs.getCount(), 6); // Below are five types of revisions that can flag an Inline node. // 1 - An "insert" revision: // This revision occurs when we insert text while tracking changes. Assert.assertTrue(runs.get(2).isInsertRevision()); // 2 - A "format" revision: // This revision occurs when we change the formatting of text while tracking changes. Assert.assertTrue(runs.get(2).isFormatRevision()); // 3 - A "move from" revision: // When we highlight text in Microsoft Word, and then drag it to a different place in the document // while tracking changes, two revisions appear. // The "move from" revision is a copy of the text originally before we moved it. Assert.assertTrue(runs.get(4).isMoveFromRevision()); // 4 - A "move to" revision: // The "move to" revision is the text that we moved in its new position in the document. // "Move from" and "move to" revisions appear in pairs for every move revision we carry out. // Accepting a move revision deletes the "move from" revision and its text, // and keeps the text from the "move to" revision. // Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision. Assert.assertTrue(runs.get(1).isMoveToRevision()); // 5 - A "delete" revision: // This revision occurs when we delete text while tracking changes. When we delete text like this, // it will stay in the document as a revision until we either accept the revision, // which will delete the text for good, or reject the revision, which will keep the text we deleted where it was. Assert.assertTrue(runs.get(5).isDeleteRevision());
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); 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());
public Range getRange()
Example:
Shows how to delete all the nodes from a range.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Add text to the first section in the document, and then add another section. builder.write("Section 1. "); builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS); builder.write("Section 2."); Assert.assertEquals("Section 1. \fSection 2.", doc.getText().trim()); // Remove the first section entirely by removing all the nodes // within its range, including the section itself. doc.getSections().get(0).getRange().delete(); Assert.assertEquals(1, doc.getSections().getCount()); Assert.assertEquals("Section 2.", doc.getText().trim());
public boolean accept(DocumentVisitor visitor) throws java.lang.Exception
Calls
For more info see the Visitor design pattern.
visitor
- The visitor that will visit the node.Example:
Shows how to work with a collection of fields.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" "); builder.insertField(" TIME "); builder.insertField(" REVNUM "); builder.insertField(" AUTHOR \"John Doe\" "); builder.insertField(" SUBJECT \"My Subject\" "); builder.insertField(" QUOTE \"Hello world!\" "); doc.updateFields(); FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(6, fields.getCount()); // Iterate over the field collection, and print contents and type // of every field using a custom visitor implementation. FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); /// <summary> /// Document visitor implementation that prints field info. /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private final /*final*/ StringBuilder mBuilder; }
public Node deepClone(boolean isCloneChildren)
This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.
This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.Example:
Shows how to clone a composite node.Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new Run(doc, "Hello world!")); // Below are two ways of cloning a composite node. // 1 - Create a clone of a node, and create a clone of each of its child nodes as well. Node cloneWithChildren = para.deepClone(true); Assert.assertTrue(((CompositeNode) cloneWithChildren).hasChildNodes()); Assert.assertEquals("Hello world!", cloneWithChildren.getText().trim()); // 2 - Create a clone of a node just by itself without any children. Node cloneWithoutChildren = para.deepClone(false); Assert.assertFalse(((CompositeNode) cloneWithoutChildren).hasChildNodes()); Assert.assertEquals("", cloneWithoutChildren.getText().trim());
public CompositeNode getAncestor(int ancestorType)
ancestorType
- A Example:
Shows how to find out if a tables are nested.Document doc = new Document(getMyDir() + "Nested tables.docx"); NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true); for (int i = 0; i < tables.getCount(); i++) { Table table = (Table) tables.get(i); // Find out if any cells in the table have other tables as children. int count = getChildTableCount(table); System.out.print(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count)); // Find out if the table is nested inside another table, and, if so, at what depth. int tableDepth = getNestedDepthOfTable(table); 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; Node parent = table.getAncestor(table.getNodeType()); while (parent != null) { 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 childTableCount = 0; for (Row row : table.getRows()) { for (Cell cell : row.getCells()) { TableCollection childTables = cell.getTables(); if (childTables.getCount() > 0) childTableCount++; } } return childTableCount; }
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 tables are nested.Document doc = new Document(getMyDir() + "Nested tables.docx"); NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true); for (int i = 0; i < tables.getCount(); i++) { Table table = (Table) tables.get(i); // Find out if any cells in the table have other tables as children. int count = getChildTableCount(table); System.out.print(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count)); // Find out if the table is nested inside another table, and, if so, at what depth. int tableDepth = getNestedDepthOfTable(table); 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; Node parent = table.getAncestor(table.getNodeType()); while (parent != null) { 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 childTableCount = 0; for (Row row : table.getRows()) { for (Cell cell : row.getCells()) { TableCollection childTables = cell.getTables(); if (childTables.getCount() > 0) childTableCount++; } } return childTableCount; }
public Field getField()
Example:
Shows how to work with a FieldStart node.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); FieldDate field = (FieldDate) builder.insertField(FieldType.FIELD_DATE, true); field.getFormat().setDateTimeFormat("dddd, MMMM dd, yyyy"); field.update(); FieldChar fieldStart = field.getStart(); Assert.assertEquals(FieldType.FIELD_DATE, fieldStart.getFieldType()); Assert.assertEquals(false, fieldStart.isDirty()); Assert.assertEquals(false, fieldStart.isLocked()); // Retrieve the facade object which represents the field in the document. field = (FieldDate) fieldStart.getField(); Assert.assertEquals(false, field.isLocked()); Assert.assertEquals(" DATE \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode()); // Update the field to show the current date. field.update();
public java.lang.String getText()
public Node nextPreOrder(Node rootNode)
rootNode
- The top node (limit) of traversal.Example:
Shows how to traverse the document's node tree using the pre-order traversal algorithm, and delete any encountered shape with an image.Document doc = new Document(getMyDir() + "Images.docx"); ArrayList<Shape> shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true)); Assert.assertEquals(9, IterableUtils.countMatches(shapes, s -> { try { return s.hasImage(); } catch (Exception e) { e.printStackTrace(); } return false; })); 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) curNode).hasImage()) curNode.remove(); curNode = nextNode; } shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true)); Assert.assertEquals(0, IterableUtils.countMatches(shapes, s -> { try { return s.hasImage(); } catch (Exception e) { e.printStackTrace(); } return false; }));
public Node previousPreOrder(Node rootNode)
rootNode
- The top node (limit) of traversal.Example:
Shows how to traverse the document's node tree using the pre-order traversal algorithm, and delete any encountered shape with an image.Document doc = new Document(getMyDir() + "Images.docx"); ArrayList<Shape> shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true)); Assert.assertEquals(9, IterableUtils.countMatches(shapes, s -> { try { return s.hasImage(); } catch (Exception e) { e.printStackTrace(); } return false; })); 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) curNode).hasImage()) curNode.remove(); curNode = nextNode; } shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true)); Assert.assertEquals(0, IterableUtils.countMatches(shapes, s -> { try { return s.hasImage(); } catch (Exception e) { e.printStackTrace(); } return false; }));
public void remove()
Example:
Shows how to delete all shapes with images from a document.Document doc = new Document(getMyDir() + "Images.docx"); ArrayList<Shape> shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true)); Assert.assertEquals(9, IterableUtils.countMatches(shapes, s -> { try { return s.hasImage(); } catch (Exception e) { e.printStackTrace(); } return false; })); for (Shape shape : shapes) if (shape.hasImage()) shape.remove(); shapes = (ArrayList<Shape>) IterableUtils.toList(doc.getChildNodes(NodeType.SHAPE, true)); Assert.assertEquals(0, IterableUtils.countMatches(shapes, s -> { try { return s.hasImage(); } catch (Exception e) { e.printStackTrace(); } return false; }));
Example:
Shows how to remove all child 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()); 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(); } curNode = nextNode; } Assert.assertEquals(0, doc.getChildNodes(NodeType.TABLE, true).getCount());
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"); Node node = doc.getLastSection().getBody().getLastParagraph(); // When we call the ToString method using the html SaveFormat overload, // it converts the node's contents to their raw html representation. 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));
public java.lang.String toString(int saveFormat) throws java.lang.Exception
saveFormat
- A SaveFormat value.Example:
Shows how to extract the list labels of all paragraphs that are list items.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 getting when we output this node to text format. // This text output will omit list labels. 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 the current level of the list. If we have a list with multiple levels, // this will tell us what position it is on that level. System.out.println("\tNumerical Id: {label.LabelValue}"); // Combine them together to include the list label with the text in the output. System.out.println("\tList label combined with text: {label.LabelString} {paragraphText}"); }
Example:
Exports the content of a node to String in HTML format.Document doc = new Document(getMyDir() + "Document.docx"); Node node = doc.getLastSection().getBody().getLastParagraph(); // When we call the ToString method using the html SaveFormat overload, // it converts the node's contents to their raw html representation. 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(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField("MERGEFIELD Field"); // GetText will retrieve the visible text as well as field codes and special characters. Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText()); // ToString will give us the document's appearance if saved to a passed save format. Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));