java.lang.ObjectNode
CompositeNode
com.aspose.words.Paragraph
public class Paragraph
The complete list of child nodes that can occur inside a paragraph consists of
A valid paragraph in Microsoft Word always ends with a paragraph break character and
a minimal valid paragraph consists just of a paragraph break. The Paragraph
class automatically appends the appropriate paragraph break character at the end
and this character is not part of the child nodes of the Paragraph, therefore
a Paragraph can be empty. Do not include the end of paragraph Example:
// Create an "empty" document. Note that like in Microsoft Word,
// the empty document has one section, body and one paragraph in it.
Document doc = new Document();
// This truly makes the document empty. No sections (not possible in Microsoft Word).
doc.removeAllChildren();
// Create a new section node.
// Note that the section has not yet been added to the document,
// but we have to specify the parent document.
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);
// As a matter of interest, you can retrieve text of the whole document and
// see that \x000c is automatically appended. \x000c is the end of section character.
System.out.println(doc.getText());
// Save the document.
doc.save(getArtifactsDir() + "Section.CreateFromScratch.doc");
Constructor Summary |
---|
Paragraph(DocumentBase doc)
Initializes a new instance of the Paragraph class. |
Property Getters/Setters Summary | ||
---|---|---|
boolean | getBreakIsStyleSeparator() | |
True if this paragraph break is a Style Separator. A style separator allows one paragraph to consist of parts that have different paragraph styles. | ||
NodeCollection | getChildNodes() | → inherited from CompositeNode |
Gets all immediate child nodes of this node. | ||
int | getCount() | → inherited from CompositeNode |
Gets the number of immediate children of this node. | ||
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
Node | getFirstChild() | → inherited from CompositeNode |
Gets the first child of the node. | ||
FrameFormat | getFrameFormat() | |
Provides access to the paragraph formatting properties. | ||
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. | ||
boolean | isDeleteRevision() | |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isEndOfCell() | |
True if this paragraph is the last paragraph in a |
||
boolean | isEndOfDocument() | |
True if this paragraph is the last paragraph in the last section of the document. | ||
boolean | isEndOfHeaderFooter() | |
True if this paragraph is the last paragraph in the HeaderFooter (main text story) of a Section; false otherwise. | ||
boolean | isEndOfSection() | |
True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise. | ||
boolean | isFormatRevision() | |
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled. | ||
boolean | isInCell() | |
True if this paragraph is an immediate child of |
||
boolean | isInsertRevision() | |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled. | ||
boolean | isListItem() | |
True when the paragraph is an item in a bulleted or numbered list in original revision. | ||
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 | getLastChild() | → inherited from CompositeNode |
Gets the last child of the node. | ||
ListFormat | getListFormat() | |
Provides access to the list formatting properties of the paragraph. | ||
ListLabel | getListLabel() | |
Gets a |
||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
int | getNodeType() | |
Returns NodeType.Paragraph. The value of the property is NodeType integer constant. | ||
Font | getParagraphBreakFont() | |
Provides access to the font formatting of the paragraph break character. | ||
ParagraphFormat | getParagraphFormat() | |
Provides access to the paragraph formatting properties. | ||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Section | getParentSection() | |
Retrieves the parent |
||
Story | getParentStory() | |
Retrieves the parent section-level story that can be |
||
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. | ||
RunCollection | getRuns() | |
Provides access to the typed collection of pieces of text inside the paragraph. |
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. | ||
Field | appendField(int fieldType, boolean updateField) | |
Appends a field to this paragraph. | ||
Field | appendField(java.lang.String fieldCode) | |
Appends a field to this paragraph. | ||
Field | appendField(java.lang.String fieldCode, java.lang.String fieldValue) | |
Appends a field to this paragraph. | ||
Node | deepClone(boolean isCloneChildren) | → inherited from Node |
java.lang.Object | fetchInheritedParaAttr(int key) | |
Deprecated. Reserved for internal use. | ||
java.lang.Object | fetchParaAttr(int key) | |
Deprecated. Reserved for internal use. | ||
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.Object | getDirectParaAttr(int key) | |
Deprecated. Reserved for internal use. | ||
java.lang.Object | getDirectRunAttr(int key) | |
Deprecated. Reserved for internal use. | ||
TabStop[] | getEffectiveTabStops() | |
Returns array of all tab stops applied to this paragraph, including applied indirectly by styles or lists. | ||
java.lang.String | getText() | |
Gets the text of this paragraph including the end of paragraph character. | ||
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. | ||
Field | insertField(int fieldType, boolean updateField, Node refNode, boolean isAfter) | |
Inserts a field into this paragraph. | ||
Field | insertField(java.lang.String fieldCode, Node refNode, boolean isAfter) | |
Inserts a field into this paragraph. | ||
Field | insertField(java.lang.String fieldCode, java.lang.String fieldValue, Node refNode, boolean isAfter) | |
Inserts a field into this paragraph. | ||
java.util.Iterator<Node> | iterator() | → inherited from CompositeNode |
Provides support for the for each style iteration over the child nodes of this node. | ||
int | joinRunsWithSameFormatting() | |
Joins runs with the same formatting in the paragraph. | ||
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 Paragraph(DocumentBase doc)
When Paragraph is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.
To append Paragraph to the document use InsertAfter or InsertBefore on the story where you want the paragraph inserted.
doc
- The owner document.Example:
Creates a simple document from scratch using the Aspose.Words object model.// Create an "empty" document. Note that like in Microsoft Word, // the empty document has one section, body and one paragraph in it. Document doc = new Document(); // This truly makes the document empty. No sections (not possible in Microsoft Word). doc.removeAllChildren(); // Create a new section node. // Note that the section has not yet been added to the document, // but we have to specify the parent document. 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); // As a matter of interest, you can retrieve text of the whole document and // see that \x000c is automatically appended. \x000c is the end of section character. System.out.println(doc.getText()); // Save the document. doc.save(getArtifactsDir() + "Section.CreateFromScratch.doc");
Property Getters/Setters Detail |
---|
getBreakIsStyleSeparator | |
public boolean getBreakIsStyleSeparator() |
Example:
Shows how to write text to the same line as a TOC heading and have it not show up in the TOC.// Create a blank document and insert a table of contents field Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertTableOfContents("\\o \\h \\z \\u"); builder.insertBreak(BreakType.PAGE_BREAK); // Insert a paragraph with a style that will be picked up as an entry in the TOC builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1); // Both these strings are on the same line and same paragraph and will therefore show up on the same TOC entry builder.write("Heading 1. "); builder.write("Will appear in the TOC. "); // Any text on a new line that does not have a heading style will not register as a TOC entry // If we insert a style separator, we can write more text on the same line // and use a different style without it showing up in the TOC // If we use a heading type style afterwards, we can draw two TOC entries from one line of document text builder.insertStyleSeparator(); builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.QUOTE); builder.write("Won't appear in the TOC. "); // This flag is set to true for such paragraphs Assert.assertTrue(doc.getFirstSection().getBody().getParagraphs().get(0).getBreakIsStyleSeparator()); // Update the TOC and save the document doc.updateFields(); doc.save(getArtifactsDir() + "Paragraph.BreakIsStyleSeparator.docx");
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.NodeCollection children = paragraph.getChildNodes(); for (Node child : (Iterable<Node>) children) { // Paragraph may contain children of various types such as runs, shapes and so on. if (child.getNodeType() == NodeType.RUN) { // Say we found the node that we want, do something useful. 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 within a CompositeNode.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1); // 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(paragraph.getText(), "Initial text. " + (char) 12); // 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(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4); // 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(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);
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 that when you create any node, it requires a document that will own the node.// 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. In this example we enumerate all paragraphs of a section body.// Get the section that we want to work on. Section section = doc.getSections().get(0); Body body = section.getBody(); // Loop starting from the first child until we reach null. for (Node node = body.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 { // Open a document. Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc"); // Invoke the recursive function that will walk the tree. traverseAllNodes(doc); } /** * A simple function that will walk through all children of a specified node recursively * and print the type of each node to the screen. */ @Test(enabled = false) public void traverseAllNodes(final CompositeNode parentNode) { // This is the most efficient way to loop through immediate children of a node. for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { // Do some useful work. System.out.println(Node.nodeTypeToString(childNode.getNodeType())); // Recurse into the node if it is a composite node. if (childNode.isComposite()) { traverseAllNodes((CompositeNode) childNode); } } }
getFrameFormat | |
public FrameFormat getFrameFormat() |
Example:
Shows how to get information about formatting properties of paragraph as frame.Document doc = new Document(getMyDir() + "Paragraph.Frame.docx"); ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs(); for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs) { if (paragraph.getFrameFormat().isFrame()) { System.out.println("Width: " + paragraph.getFrameFormat().getWidth()); System.out.println("Height: " + paragraph.getFrameFormat().getHeight()); System.out.println("HeightRule: " + paragraph.getFrameFormat().getHeightRule()); System.out.println("HorizontalAlignment: " + paragraph.getFrameFormat().getHorizontalAlignment()); System.out.println("VerticalAlignment: " + paragraph.getFrameFormat().getVerticalAlignment()); System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition()); System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition()); System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText()); System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition()); System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition()); System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText()); } }
hasChildNodes | → inherited from CompositeNode |
public boolean hasChildNodes() |
Example:
Demonstrates how to use the InsertDocument method to insert a document into a merge field during mail merge.public void insertDocumentAtMailMerge() throws Exception { // Open the main document. Document mainDoc = new Document(getMyDir() + "InsertDocument1.doc"); // Add a handler to ApiExamples.Tests.MergeField event mainDoc.getMailMerge().setFieldMergingCallback(new InsertDocumentAtMailMergeHandler()); // The main document has a merge field in it called "Document_1". // The corresponding data for this field contains fully qualified path to the document // that should be inserted to this field. mainDoc.getMailMerge().execute(new String[]{"Document_1"}, new String[]{getMyDir() + "InsertDocument2.doc"}); mainDoc.save(getArtifactsDir() + "InsertDocumentAtMailMerge.doc"); } private class InsertDocumentAtMailMergeHandler implements IFieldMergingCallback { /** * This handler makes special processing for the "Document_1" field. * The field value contains the path to load the document. * We load the document and insert it into the current merge field. */ public void fieldMerging(final FieldMergingArgs args) throws Exception { if ("Document_1".equals(args.getDocumentFieldName())) { // Use document builder to navigate to the merge field with the specified name. DocumentBuilder builder = new DocumentBuilder(args.getDocument()); builder.moveToMergeField(args.getDocumentFieldName()); // The name of the document to load and insert is stored in the field value. Document subDoc = new Document((String) args.getFieldValue()); // Insert the document. insertDocument(builder.getCurrentParagraph(), subDoc); // The paragraph that contained the merge field might be empty now and you probably want to delete it. if (!builder.getCurrentParagraph().hasChildNodes()) { builder.getCurrentParagraph().remove(); } // Indicate to the mail merge engine that we have inserted what we wanted. args.setText(null); } } public void imageFieldMerging(final ImageFieldMergingArgs args) { // Do nothing. } }
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 { // Open a document. Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc"); // Invoke the recursive function that will walk the tree. traverseAllNodes(doc); } /** * A simple function that will walk through all children of a specified node recursively * and print the type of each node to the screen. */ @Test(enabled = false) public void traverseAllNodes(final CompositeNode parentNode) { // This is the most efficient way to loop through immediate children of a node. for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { // Do some useful work. System.out.println(Node.nodeTypeToString(childNode.getNodeType())); // Recurse into the node if it is a composite node. if (childNode.isComposite()) { traverseAllNodes((CompositeNode) childNode); } } }
isDeleteRevision | |
public boolean isDeleteRevision() |
Example:
Shows how to work with revision paragraphs.// Create a blank document, populate the first paragraph with text and add two more Document doc = new Document(); Body body = doc.getFirstSection().getBody(); Paragraph para = body.getFirstParagraph(); para.appendChild(new Run(doc, "Paragraph 1. ")); body.appendParagraph("Paragraph 2. "); body.appendParagraph("Paragraph 3. "); // We have three paragraphs, none of which registered as any type of revision // If we add/remove any content in the document while tracking revisions, // they will be displayed as such in the document and can be accepted/rejected doc.startTrackRevisions("John Doe", new Date()); // This paragraph is a revision and will have the according "IsInsertRevision" flag set para = body.appendParagraph("Paragraph 4. "); Assert.assertTrue(para.isInsertRevision()); // Get the document's paragraph collection and remove a paragraph ParagraphCollection paragraphs = body.getParagraphs(); Assert.assertEquals(paragraphs.getCount(), 4); para = paragraphs.get(2); para.remove(); // Since we are tracking revisions, the paragraph still exists in the document, will have the "IsDeleteRevision" set // and will be displayed as a revision in Microsoft Word, until we accept or reject all revisions Assert.assertEquals(paragraphs.getCount(), 4); Assert.assertTrue(para.isDeleteRevision()); // The delete revision paragraph is removed once we accept changes doc.acceptAllRevisions(); Assert.assertEquals(paragraphs.getCount(), 3); Assert.assertEquals(para.getCount(), 0);
isEndOfCell | |
public boolean isEndOfCell() |
Example:
Shows how to set a table to stay together on the same page.// To keep a table from breaking across a page we need to enable KeepWithNext // for every paragraph in the table except for the last paragraphs in the last // row of the table. for (Cell cell : (Iterable<Cell>) table.getChildNodes(NodeType.CELL, true)) { for (Paragraph para : cell.getParagraphs()) { // Every paragraph that's inside a cell will have this flag set Assert.assertTrue(para.isInCell()); if (!(cell.getParentRow().isLastRow() && para.isEndOfCell())) { para.getParagraphFormat().setKeepWithNext(true); } } }
isEndOfDocument | |
public boolean isEndOfDocument() |
Example:
Shows how to insert a paragraph into the document.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Specify font formatting Font font = builder.getFont(); font.setSize(16); font.setBold(true); font.setColor(Color.BLUE); font.setName("Arial"); font.setUnderline(Underline.DASH); // Specify paragraph formatting ParagraphFormat paragraphFormat = builder.getParagraphFormat(); paragraphFormat.setFirstLineIndent(8); paragraphFormat.setAlignment(ParagraphAlignment.JUSTIFY); paragraphFormat.setAddSpaceBetweenFarEastAndAlpha(true); paragraphFormat.setAddSpaceBetweenFarEastAndDigit(true); paragraphFormat.setKeepTogether(true); builder.writeln("A whole paragraph."); // We can use this flag to ensure that we're at the end of the document Assert.assertTrue(builder.getCurrentParagraph().isEndOfDocument());
isEndOfHeaderFooter | |
public boolean isEndOfHeaderFooter() |
Example:
Creates a footer using the document object model and inserts it into a section.Document doc = new Document(); HeaderFooter header = new HeaderFooter(doc, HeaderFooterType.HEADER_PRIMARY); doc.getFirstSection().getHeadersFooters().add(header); // Add a paragraph with text to the footer. Paragraph para = header.appendParagraph("My header"); Assert.assertTrue(header.isHeader()); Assert.assertTrue(para.isEndOfHeaderFooter()); HeaderFooter footer = new HeaderFooter(doc, HeaderFooterType.FOOTER_PRIMARY); doc.getFirstSection().getHeadersFooters().add(footer); // Add a paragraph with text to the footer. para = footer.appendParagraph("My footer"); Assert.assertFalse(footer.isHeader()); Assert.assertTrue(para.isEndOfHeaderFooter()); Assert.assertEquals(para.getParentStory(), footer); Assert.assertEquals(para.getParentSection(), footer.getParentSection()); Assert.assertEquals(header.getParentSection(), footer.getParentSection()); doc.save(getArtifactsDir() + "HeaderFooter.CreateFooter.doc");
isEndOfSection | |
public boolean isEndOfSection() |
Example:
This is a method that inserts contents of one document at a specified location in another document./** * Inserts content of the external document after the specified node. * Section breaks and section formatting of the inserted document are ignored. * * @param insertAfterNode Node in the destination document after which the content * should be inserted. This node should be a block level node (paragraph or table). * @param srcDoc The document to insert. */ public static void insertDocument(Node insertAfterNode, final Document srcDoc) { // Make sure that the node is either a paragraph or table. if ((insertAfterNode.getNodeType() != NodeType.PARAGRAPH) & (insertAfterNode.getNodeType() != NodeType.TABLE)) { throw new IllegalArgumentException("The destination node should be either a paragraph or table."); } // We will be inserting into the parent of the destination paragraph. CompositeNode dstStory = insertAfterNode.getParentNode(); // This object will be translating styles and lists during the import. NodeImporter importer = new NodeImporter(srcDoc, insertAfterNode.getDocument(), ImportFormatMode.KEEP_SOURCE_FORMATTING); // Loop through all sections in the source document. for (Section srcSection : srcDoc.getSections()) { // Loop through all block level nodes (paragraphs and tables) in the body of the section. for (Node srcNode : srcSection.getBody()) { // Let's skip the node if it is a last empty paragraph in a section. if (srcNode.getNodeType() == (NodeType.PARAGRAPH)) { Paragraph para = (Paragraph) srcNode; if (para.isEndOfSection() && !para.hasChildNodes()) { continue; } } // This creates a clone of the node, suitable for insertion into the destination document. Node newNode = importer.importNode(srcNode, true); // Insert new node after the reference node. dstStory.insertAfter(newNode, insertAfterNode); insertAfterNode = newNode; } } }
isFormatRevision | |
public boolean isFormatRevision() |
Example:
Shows how to get information about whether this object was formatted in Microsoft Word while change tracking was enabledDocument doc = new Document(getMyDir() + "Paragraph.IsFormatRevision.docx"); Paragraph firstParagraph = DocumentHelper.getParagraph(doc, 0); Assert.assertTrue(firstParagraph.isFormatRevision());
isInCell | |
public boolean isInCell() |
Example:
Shows how to set a table to stay together on the same page.// To keep a table from breaking across a page we need to enable KeepWithNext // for every paragraph in the table except for the last paragraphs in the last // row of the table. for (Cell cell : (Iterable<Cell>) table.getChildNodes(NodeType.CELL, true)) { for (Paragraph para : cell.getParagraphs()) { // Every paragraph that's inside a cell will have this flag set Assert.assertTrue(para.isInCell()); if (!(cell.getParentRow().isLastRow() && para.isEndOfCell())) { para.getParagraphFormat().setKeepWithNext(true); } } }
isInsertRevision | |
public boolean isInsertRevision() |
Example:
Shows how to work with revision paragraphs.// Create a blank document, populate the first paragraph with text and add two more Document doc = new Document(); Body body = doc.getFirstSection().getBody(); Paragraph para = body.getFirstParagraph(); para.appendChild(new Run(doc, "Paragraph 1. ")); body.appendParagraph("Paragraph 2. "); body.appendParagraph("Paragraph 3. "); // We have three paragraphs, none of which registered as any type of revision // If we add/remove any content in the document while tracking revisions, // they will be displayed as such in the document and can be accepted/rejected doc.startTrackRevisions("John Doe", new Date()); // This paragraph is a revision and will have the according "IsInsertRevision" flag set para = body.appendParagraph("Paragraph 4. "); Assert.assertTrue(para.isInsertRevision()); // Get the document's paragraph collection and remove a paragraph ParagraphCollection paragraphs = body.getParagraphs(); Assert.assertEquals(paragraphs.getCount(), 4); para = paragraphs.get(2); para.remove(); // Since we are tracking revisions, the paragraph still exists in the document, will have the "IsDeleteRevision" set // and will be displayed as a revision in Microsoft Word, until we accept or reject all revisions Assert.assertEquals(paragraphs.getCount(), 4); Assert.assertTrue(para.isDeleteRevision()); // The delete revision paragraph is removed once we accept changes doc.acceptAllRevisions(); Assert.assertEquals(paragraphs.getCount(), 3); Assert.assertEquals(para.getCount(), 0);
isListItem | |
public boolean isListItem() |
Example:
Shows how to start a numbered list, add a bulleted list inside it, then return to the numbered list.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Create an outline list for the headings. List outlineList = doc.getLists().add(ListTemplate.OUTLINE_NUMBERS); builder.getListFormat().setList(outlineList); builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1); builder.writeln("This is my Chapter 1"); // Create a numbered list. List numberedList = doc.getLists().add(ListTemplate.NUMBER_DEFAULT); builder.getListFormat().setList(numberedList); builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.NORMAL); builder.writeln("Numbered list item 1."); // Every paragraph that comprises a list will have this flag Assert.assertTrue(builder.getCurrentParagraph().isListItem()); Assert.assertTrue(builder.getParagraphFormat().isListItem()); // Create a bulleted list. List bulletedList = doc.getLists().add(ListTemplate.BULLET_DEFAULT); builder.getListFormat().setList(bulletedList); builder.getParagraphFormat().setLeftIndent(72); builder.writeln("Bulleted list item 1."); builder.writeln("Bulleted list item 2."); builder.getParagraphFormat().clearFormatting(); // Revert to the numbered list. builder.getListFormat().setList(numberedList); builder.writeln("Numbered list item 2."); builder.writeln("Numbered list item 3."); // Revert to the outline list. builder.getListFormat().setList(outlineList); builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1); builder.writeln("This is my Chapter 2"); builder.getParagraphFormat().clearFormatting(); builder.getDocument().save(getArtifactsDir() + "Lists.NestedLists.docx");
isMoveFromRevision | |
public boolean isMoveFromRevision() |
Example:
Shows how to get paragraph that was moved (deleted/inserted) in Microsoft Word while change tracking was enabled.Document doc = new Document(getMyDir() + "Document.Revisions.docx"); ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs(); // There are two sets of move revisions in this document // One moves a small part of a paragraph, while the other moves a whole paragraph // Paragraph.IsMoveFromRevision/IsMoveToRevision will only be true if a whole paragraph is moved, as in the latter case for (int i = 0; i < paragraphs.getCount(); i++) { if (paragraphs.get(i).isMoveFromRevision()) System.out.println(MessageFormat.format("The paragraph {0} has been moved (deleted).", i)); if (paragraphs.get(i).isMoveToRevision()) System.out.println(MessageFormat.format("The paragraph {0} has been moved (inserted).", i)); }
isMoveToRevision | |
public boolean isMoveToRevision() |
Example:
Shows how to get paragraph that was moved (deleted/inserted) in Microsoft Word while change tracking was enabled.Document doc = new Document(getMyDir() + "Document.Revisions.docx"); ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs(); // There are two sets of move revisions in this document // One moves a small part of a paragraph, while the other moves a whole paragraph // Paragraph.IsMoveFromRevision/IsMoveToRevision will only be true if a whole paragraph is moved, as in the latter case for (int i = 0; i < paragraphs.getCount(); i++) { if (paragraphs.get(i).isMoveFromRevision()) System.out.println(MessageFormat.format("The paragraph {0} has been moved (deleted).", i)); if (paragraphs.get(i).isMoveToRevision()) System.out.println(MessageFormat.format("The paragraph {0} has been moved (inserted).", i)); }
getLastChild | → inherited from CompositeNode |
public Node getLastChild() |
Example:
Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.// Document is a CompositeNode and LastChild returns the last child node in the Document node. // Since the Document can contain only Section nodes, the last child is the last section. Node lastSection = doc.getLastChild(); // Each node knows its next and previous sibling nodes. // Previous sibling of a section is a section before the specified section. // If the node is the first child, PreviousSibling will return null. Node sectionBeforeLast = lastSection.getPreviousSibling(); if (sectionBeforeLast != null) { doc.removeChild(sectionBeforeLast); }
getListFormat | |
public ListFormat getListFormat() |
Example:
Removes bullets and numbering from all paragraphs in the main text of a section.Body body = doc.getFirstSection().getBody(); for (Paragraph paragraph : body.getParagraphs()) paragraph.getListFormat().removeNumbers();
Example:
Applies list formatting of an existing list to a collection of paragraphs.Body body = doc.getFirstSection().getBody(); List list = doc.getLists().get(0); for (Paragraph paragraph : body.getParagraphs()) { paragraph.getListFormat().setList(list); paragraph.getListFormat().setListLevelNumber(2); }
Example:
Creates new list formatting and applies it to a collection of paragraphs.List list = doc.getLists().add(ListTemplate.NUMBER_UPPERCASE_LETTER_DOT); Body body = doc.getFirstSection().getBody(); for (Paragraph paragraph : body.getParagraphs()) { paragraph.getListFormat().setList(list); paragraph.getListFormat().setListLevelNumber(1); }
Example:
Finds and outputs all paragraphs in a document that are bulleted or numbered.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()); } }
getListLabel | |
public ListLabel getListLabel() |
Example:
Shows how to extract the label of each paragraph in a list as a value or a String.Document doc = new Document(getMyDir() + "Lists.PrintOutAllLists.doc"); 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("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("Numerical Id: " + label.getLabelValue()); // Combine them together to include the list label with the text in the output. System.out.println("List label combined with text: " + label.getLabelString() + " " + paragraphText); listParaCount++; } }
getNextSibling | → inherited from Node |
public Node getNextSibling() |
Example:
Shows how to enumerate immediate child nodes of a composite node using NextSibling. In this example we enumerate all paragraphs of a section body.// Get the section that we want to work on. Section section = doc.getSections().get(0); Body body = section.getBody(); // Loop starting from the first child until we reach null. for (Node node = body.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 { // Open a document. Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc"); // Invoke the recursive function that will walk the tree. traverseAllNodes(doc); } /** * A simple function that will walk through all children of a specified node recursively * and print the type of each node to the screen. */ @Test(enabled = false) public void traverseAllNodes(final CompositeNode parentNode) { // This is the most efficient way to loop through immediate children of a node. for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { // Do some useful work. System.out.println(Node.nodeTypeToString(childNode.getNodeType())); // Recurse into the node if it is a composite node. if (childNode.isComposite()) { traverseAllNodes((CompositeNode) childNode); } } }
getNodeType | |
public int getNodeType() |
Example:
Shows how to retrieve the NodeType enumeration of nodes.Document doc = new Document(getMyDir() + "Document.doc"); // Let's pick a node that we can't be quite sure of what type it is. // In this case lets pick the first node of the first paragraph in the body of the document Node node = doc.getFirstSection().getBody().getFirstParagraph().getFirstChild(); System.out.println("NodeType of first child: " + Node.nodeTypeToString(node.getNodeType())); // This time let's pick a node that we know the type of. Create a new paragraph and a table node. Paragraph para = new Paragraph(doc); Table table = new Table(doc); // Access to NodeType for typed nodes will always return their specific NodeType. // i.e A paragraph node will always return NodeType.Paragraph, a table node will always return NodeType.Table. System.out.println("NodeType of Paragraph: " + Node.nodeTypeToString(para.getNodeType())); System.out.println("NodeType of Table: " + Node.nodeTypeToString(table.getNodeType()));
getParagraphBreakFont | |
public Font getParagraphBreakFont() |
Example:
Implements the Visitor Pattern to remove all content formatted as hidden from the document.public void removeHiddenContentFromDocument() throws Exception { // Open the document we want to remove hidden content from. Document doc = new Document(getMyDir() + "Font.Hidden.doc"); // Create an object that inherits from the DocumentVisitor class. RemoveHiddenContentVisitor hiddenContentRemover = new RemoveHiddenContentVisitor(); // This is the well known Visitor pattern. Get the model to accept a visitor. // The model will iterate through itself by calling the corresponding methods // on the visitor object (this is called visiting). // We can run it over the entire the document like so: doc.accept(hiddenContentRemover); // Or we can run it on only a specific node. Paragraph para = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 4, true); para.accept(hiddenContentRemover); // Or over a different type of node like below. Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); table.accept(hiddenContentRemover); doc.save(getArtifactsDir() + "Font.Hidden.doc"); } /** * This class when executed will remove all hidden content from the Document. Implemented as a Visitor. */ private class RemoveHiddenContentVisitor extends DocumentVisitor { /** * Called when a FieldStart node is encountered in the document. */ public int visitFieldStart(final FieldStart fieldStart) throws Exception { // If this node is hidden, then remove it. if (isHidden(fieldStart)) { fieldStart.remove(); } return VisitorAction.CONTINUE; } /** * Called when a FieldEnd node is encountered in the document. */ public int visitFieldEnd(final FieldEnd fieldEnd) throws Exception { if (isHidden(fieldEnd)) { fieldEnd.remove(); } return VisitorAction.CONTINUE; } /** * Called when a FieldSeparator node is encountered in the document. */ public int visitFieldSeparator(final FieldSeparator fieldSeparator) throws Exception { if (isHidden(fieldSeparator)) { fieldSeparator.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Run node is encountered in the document. */ public int visitRun(final Run run) throws Exception { if (isHidden(run)) { run.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Paragraph node is encountered in the document. */ public int visitParagraphStart(final Paragraph paragraph) throws Exception { if (isHidden(paragraph)) { paragraph.remove(); } return VisitorAction.CONTINUE; } /** * Called when a FormField is encountered in the document. */ public int visitFormField(final FormField field) throws Exception { if (isHidden(field)) { field.remove(); } return VisitorAction.CONTINUE; } /** * Called when a GroupShape is encountered in the document. */ public int visitGroupShapeStart(final GroupShape groupShape) throws Exception { if (isHidden(groupShape)) { groupShape.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Shape is encountered in the document. */ public int visitShapeStart(final Shape shape) throws Exception { if (isHidden(shape)) { shape.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Comment is encountered in the document. */ public int visitCommentStart(final Comment comment) throws Exception { if (isHidden(comment)) { comment.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Footnote is encountered in the document. */ public int visitFootnoteStart(final Footnote footnote) throws Exception { if (isHidden(footnote)) { footnote.remove(); } return VisitorAction.CONTINUE; } /** * Called when visiting of a Table node is ended in the document. */ public int visitTableEnd(final Table table) { // At the moment there is no way to tell if a particular Table/Row/Cell is hidden. // Instead, if the content of a table is hidden, then all inline child nodes of the table should be // hidden and thus removed by previous visits as well. This will result in the container being empty // so if this is the case we know to remove the table node. // // Note that a table which is not hidden but simply has no content will not be affected by this algorthim, // as technically they are not completely empty (for example a properly formed Cell will have at least // an empty paragraph in it) if (!table.hasChildNodes()) { table.remove(); } return VisitorAction.CONTINUE; } /** * Called when visiting of a Cell node is ended in the document. */ public int visitCellEnd(final Cell cell) { if (!cell.hasChildNodes() && cell.getParentNode() != null) { cell.remove(); } return VisitorAction.CONTINUE; } /** * Called when visiting of a Row node is ended in the document. */ public int visitRowEnd(final Row row) { if (!row.hasChildNodes() && row.getParentNode() != null) { row.remove(); } return VisitorAction.CONTINUE; } /** * Called when a SpecialCharacter is encountered in the document. */ public int visitSpecialChar(final SpecialChar character) throws Exception { if (isHidden(character)) { character.remove(); } return VisitorAction.CONTINUE; } /** * Returns true if the node passed is set as hidden, returns false if it is visible. */ private boolean isHidden(final Node node) { if (node instanceof Inline) { // If the node is Inline then cast it to retrieve the Font property which contains the hidden property Inline currentNode = (Inline) node; return currentNode.getFont().getHidden(); } else if (node.getNodeType() == NodeType.PARAGRAPH) { // If the node is a paragraph cast it to retrieve the ParagraphBreakFont which contains the hidden property Paragraph para = (Paragraph) node; return para.getParagraphBreakFont().getHidden(); } else if (node instanceof ShapeBase) { // Node is a shape or groupshape. ShapeBase shape = (ShapeBase) node; return shape.getFont().getHidden(); } else if (node instanceof InlineStory) { // Node is a comment or footnote. InlineStory inlineStory = (InlineStory) node; return inlineStory.getFont().getHidden(); } // A node that is passed to this method which does not contain a hidden property will end up here. // By default nodes are not hidden so return false. return false; } }
getParagraphFormat | |
public ParagraphFormat getParagraphFormat() |
Example:
Creates a simple document from scratch using the Aspose.Words object model.// Create an "empty" document. Note that like in Microsoft Word, // the empty document has one section, body and one paragraph in it. Document doc = new Document(); // This truly makes the document empty. No sections (not possible in Microsoft Word). doc.removeAllChildren(); // Create a new section node. // Note that the section has not yet been added to the document, // but we have to specify the parent document. 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); // As a matter of interest, you can retrieve text of the whole document and // see that \x000c is automatically appended. \x000c is the end of section character. System.out.println(doc.getText()); // Save the document. doc.save(getArtifactsDir() + "Section.CreateFromScratch.doc");
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.// Create a new empty document. It has one section. Document doc = new Document(); // The section is the first child node of the document. Node section = doc.getFirstChild(); // The section's parent node is the document. System.out.println("Section parent is the document: " + (doc == section.getParentNode()));
Example:
Shows that when you create any node, it requires a document that will own the node.// 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));
getParentSection | |
public Section getParentSection() |
Example:
Creates a footer using the document object model and inserts it into a section.Document doc = new Document(); HeaderFooter header = new HeaderFooter(doc, HeaderFooterType.HEADER_PRIMARY); doc.getFirstSection().getHeadersFooters().add(header); // Add a paragraph with text to the footer. Paragraph para = header.appendParagraph("My header"); Assert.assertTrue(header.isHeader()); Assert.assertTrue(para.isEndOfHeaderFooter()); HeaderFooter footer = new HeaderFooter(doc, HeaderFooterType.FOOTER_PRIMARY); doc.getFirstSection().getHeadersFooters().add(footer); // Add a paragraph with text to the footer. para = footer.appendParagraph("My footer"); Assert.assertFalse(footer.isHeader()); Assert.assertTrue(para.isEndOfHeaderFooter()); Assert.assertEquals(para.getParentStory(), footer); Assert.assertEquals(para.getParentSection(), footer.getParentSection()); Assert.assertEquals(header.getParentSection(), footer.getParentSection()); doc.save(getArtifactsDir() + "HeaderFooter.CreateFooter.doc");
getParentStory | |
public Story getParentStory() |
Example:
Creates a footer using the document object model and inserts it into a section.Document doc = new Document(); HeaderFooter header = new HeaderFooter(doc, HeaderFooterType.HEADER_PRIMARY); doc.getFirstSection().getHeadersFooters().add(header); // Add a paragraph with text to the footer. Paragraph para = header.appendParagraph("My header"); Assert.assertTrue(header.isHeader()); Assert.assertTrue(para.isEndOfHeaderFooter()); HeaderFooter footer = new HeaderFooter(doc, HeaderFooterType.FOOTER_PRIMARY); doc.getFirstSection().getHeadersFooters().add(footer); // Add a paragraph with text to the footer. para = footer.appendParagraph("My footer"); Assert.assertFalse(footer.isHeader()); Assert.assertTrue(para.isEndOfHeaderFooter()); Assert.assertEquals(para.getParentStory(), footer); Assert.assertEquals(para.getParentSection(), footer.getParentSection()); Assert.assertEquals(header.getParentSection(), footer.getParentSection()); doc.save(getArtifactsDir() + "HeaderFooter.CreateFooter.doc");
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
Example:
Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.// Document is a CompositeNode and LastChild returns the last child node in the Document node. // Since the Document can contain only Section nodes, the last child is the last section. Node lastSection = doc.getLastChild(); // Each node knows its next and previous sibling nodes. // Previous sibling of a section is a section before the specified section. // If the node is the first child, PreviousSibling will return null. Node sectionBeforeLast = lastSection.getPreviousSibling(); if (sectionBeforeLast != null) { doc.removeChild(sectionBeforeLast); }
getRange | → inherited from Node |
public Range getRange() |
Example:
Shows how to delete all characters of a range.// Open Word document. Document doc = new Document(getMyDir() + "Range.DeleteSection.doc"); // The document contains two sections. Each section has a paragraph of text. System.out.println(doc.getText()); // 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. System.out.println(doc.getText());
getRuns | |
public RunCollection getRuns() |
Example:
Shows how to process revision-related properties of Inline nodes.Document doc = new Document(getMyDir() + "Inline.Revisions.docx"); // This document has 6 revisions Assert.assertEquals(doc.getRevisions().getCount(), 6); // The parent node of a revision is the run that the revision concerns, which is an Inline node Run run = (Run) doc.getRevisions().get(0).getParentNode(); // Get the parent paragraph Paragraph firstParagraph = run.getParentParagraph(); RunCollection runs = firstParagraph.getRuns(); Assert.assertEquals(runs.getCount(), 6); // The text in the run at index #2 was typed after revisions were tracked, so it will count as an insert revision // The font was changed, so it will also be a format revision Assert.assertTrue(runs.get(2).isInsertRevision()); Assert.assertTrue(runs.get(2).isFormatRevision()); // If one node was moved from one place to another while changes were tracked, // the node will be placed at the departure location as a "move to revision", // and a "move from revision" node will be left behind at the origin, in case we want to reject changes // Highlighting text and dragging it to another place with the mouse and cut-and-pasting (but not copy-pasting) both count as "move revisions" // The node with the "IsMoveToRevision" flag is the arrival of the move operation, and the node with the "IsMoveFromRevision" flag is the departure point Assert.assertTrue(runs.get(1).isMoveToRevision()); Assert.assertTrue(runs.get(4).isMoveFromRevision()); // If an Inline node gets deleted while changes are being tracked, it will leave behind a node with the IsDeleteRevision flag set to true until changes are accepted Assert.assertTrue(runs.get(5).isDeleteRevision());
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.
visitor
- The visitor that will visit the nodes.Example:
Implements the Visitor Pattern to remove all content formatted as hidden from the document.public void removeHiddenContentFromDocument() throws Exception { // Open the document we want to remove hidden content from. Document doc = new Document(getMyDir() + "Font.Hidden.doc"); // Create an object that inherits from the DocumentVisitor class. RemoveHiddenContentVisitor hiddenContentRemover = new RemoveHiddenContentVisitor(); // This is the well known Visitor pattern. Get the model to accept a visitor. // The model will iterate through itself by calling the corresponding methods // on the visitor object (this is called visiting). // We can run it over the entire the document like so: doc.accept(hiddenContentRemover); // Or we can run it on only a specific node. Paragraph para = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 4, true); para.accept(hiddenContentRemover); // Or over a different type of node like below. Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); table.accept(hiddenContentRemover); doc.save(getArtifactsDir() + "Font.Hidden.doc"); } /** * This class when executed will remove all hidden content from the Document. Implemented as a Visitor. */ private class RemoveHiddenContentVisitor extends DocumentVisitor { /** * Called when a FieldStart node is encountered in the document. */ public int visitFieldStart(final FieldStart fieldStart) throws Exception { // If this node is hidden, then remove it. if (isHidden(fieldStart)) { fieldStart.remove(); } return VisitorAction.CONTINUE; } /** * Called when a FieldEnd node is encountered in the document. */ public int visitFieldEnd(final FieldEnd fieldEnd) throws Exception { if (isHidden(fieldEnd)) { fieldEnd.remove(); } return VisitorAction.CONTINUE; } /** * Called when a FieldSeparator node is encountered in the document. */ public int visitFieldSeparator(final FieldSeparator fieldSeparator) throws Exception { if (isHidden(fieldSeparator)) { fieldSeparator.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Run node is encountered in the document. */ public int visitRun(final Run run) throws Exception { if (isHidden(run)) { run.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Paragraph node is encountered in the document. */ public int visitParagraphStart(final Paragraph paragraph) throws Exception { if (isHidden(paragraph)) { paragraph.remove(); } return VisitorAction.CONTINUE; } /** * Called when a FormField is encountered in the document. */ public int visitFormField(final FormField field) throws Exception { if (isHidden(field)) { field.remove(); } return VisitorAction.CONTINUE; } /** * Called when a GroupShape is encountered in the document. */ public int visitGroupShapeStart(final GroupShape groupShape) throws Exception { if (isHidden(groupShape)) { groupShape.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Shape is encountered in the document. */ public int visitShapeStart(final Shape shape) throws Exception { if (isHidden(shape)) { shape.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Comment is encountered in the document. */ public int visitCommentStart(final Comment comment) throws Exception { if (isHidden(comment)) { comment.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Footnote is encountered in the document. */ public int visitFootnoteStart(final Footnote footnote) throws Exception { if (isHidden(footnote)) { footnote.remove(); } return VisitorAction.CONTINUE; } /** * Called when visiting of a Table node is ended in the document. */ public int visitTableEnd(final Table table) { // At the moment there is no way to tell if a particular Table/Row/Cell is hidden. // Instead, if the content of a table is hidden, then all inline child nodes of the table should be // hidden and thus removed by previous visits as well. This will result in the container being empty // so if this is the case we know to remove the table node. // // Note that a table which is not hidden but simply has no content will not be affected by this algorthim, // as technically they are not completely empty (for example a properly formed Cell will have at least // an empty paragraph in it) if (!table.hasChildNodes()) { table.remove(); } return VisitorAction.CONTINUE; } /** * Called when visiting of a Cell node is ended in the document. */ public int visitCellEnd(final Cell cell) { if (!cell.hasChildNodes() && cell.getParentNode() != null) { cell.remove(); } return VisitorAction.CONTINUE; } /** * Called when visiting of a Row node is ended in the document. */ public int visitRowEnd(final Row row) { if (!row.hasChildNodes() && row.getParentNode() != null) { row.remove(); } return VisitorAction.CONTINUE; } /** * Called when a SpecialCharacter is encountered in the document. */ public int visitSpecialChar(final SpecialChar character) throws Exception { if (isHidden(character)) { character.remove(); } return VisitorAction.CONTINUE; } /** * Returns true if the node passed is set as hidden, returns false if it is visible. */ private boolean isHidden(final Node node) { if (node instanceof Inline) { // If the node is Inline then cast it to retrieve the Font property which contains the hidden property Inline currentNode = (Inline) node; return currentNode.getFont().getHidden(); } else if (node.getNodeType() == NodeType.PARAGRAPH) { // If the node is a paragraph cast it to retrieve the ParagraphBreakFont which contains the hidden property Paragraph para = (Paragraph) node; return para.getParagraphBreakFont().getHidden(); } else if (node instanceof ShapeBase) { // Node is a shape or groupshape. ShapeBase shape = (ShapeBase) node; return shape.getFont().getHidden(); } else if (node instanceof InlineStory) { // Node is a comment or footnote. InlineStory inlineStory = (InlineStory) node; return inlineStory.getFont().getHidden(); } // A node that is passed to this method which does not contain a hidden property will end up here. // By default nodes are not hidden so return false. return false; } }
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:
Creates a simple document from scratch using the Aspose.Words object model.// Create an "empty" document. Note that like in Microsoft Word, // the empty document has one section, body and one paragraph in it. Document doc = new Document(); // This truly makes the document empty. No sections (not possible in Microsoft Word). doc.removeAllChildren(); // Create a new section node. // Note that the section has not yet been added to the document, // but we have to specify the parent document. 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); // As a matter of interest, you can retrieve text of the whole document and // see that \x000c is automatically appended. \x000c is the end of section character. System.out.println(doc.getText()); // Save the document. doc.save(getArtifactsDir() + "Section.CreateFromScratch.doc");
appendField | |
public Field appendField(int fieldType, boolean updateField) throws java.lang.Exception |
fieldType
- A updateField
- Specifies whether to update the field immediately.Example:
Shows how to insert fields in different ways.// Create a blank document and get its first paragraph Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); // Choose a field by FieldType, append it to the end of the paragraph and update it para.appendField(FieldType.FIELD_DATE, true); // Append a field with a field code created by hand para.appendField(" TIME \\@ \"HH:mm:ss\" "); // Append a field that will display a placeholder value until it is updated manually in Microsoft Word // or programmatically with Document.UpdateFields() or Field.Update() para.appendField(" QUOTE \"Real value\"", "Placeholder value"); // We can choose a node in the paragraph and insert a field // before or after that node instead of appending it to the end of a paragraph para = doc.getFirstSection().getBody().appendParagraph(""); Run run = new Run(doc); { run.setText(" My Run. "); } para.appendChild(run); // Insert a field into the paragraph and place it before the run we created doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe"); para.insertField(FieldType.FIELD_AUTHOR, true, run, false); // Insert another field designated by field code before the run para.insertField(" QUOTE \"Real value\" ", run, false); // Insert another field with a place holder value and place it after the run para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true); doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
appendField | |
public Field appendField(java.lang.String fieldCode) throws java.lang.Exception |
fieldCode
- The field code to append (without curly braces).Example:
Shows how to insert fields in different ways.// Create a blank document and get its first paragraph Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); // Choose a field by FieldType, append it to the end of the paragraph and update it para.appendField(FieldType.FIELD_DATE, true); // Append a field with a field code created by hand para.appendField(" TIME \\@ \"HH:mm:ss\" "); // Append a field that will display a placeholder value until it is updated manually in Microsoft Word // or programmatically with Document.UpdateFields() or Field.Update() para.appendField(" QUOTE \"Real value\"", "Placeholder value"); // We can choose a node in the paragraph and insert a field // before or after that node instead of appending it to the end of a paragraph para = doc.getFirstSection().getBody().appendParagraph(""); Run run = new Run(doc); { run.setText(" My Run. "); } para.appendChild(run); // Insert a field into the paragraph and place it before the run we created doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe"); para.insertField(FieldType.FIELD_AUTHOR, true, run, false); // Insert another field designated by field code before the run para.insertField(" QUOTE \"Real value\" ", run, false); // Insert another field with a place holder value and place it after the run para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true); doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
appendField | |
public Field appendField(java.lang.String fieldCode, java.lang.String fieldValue) |
fieldCode
- The field code to append (without curly braces).fieldValue
- The field value to append. Pass null for fields that do not have a value.Example:
Shows how to insert fields in different ways.// Create a blank document and get its first paragraph Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); // Choose a field by FieldType, append it to the end of the paragraph and update it para.appendField(FieldType.FIELD_DATE, true); // Append a field with a field code created by hand para.appendField(" TIME \\@ \"HH:mm:ss\" "); // Append a field that will display a placeholder value until it is updated manually in Microsoft Word // or programmatically with Document.UpdateFields() or Field.Update() para.appendField(" QUOTE \"Real value\"", "Placeholder value"); // We can choose a node in the paragraph and insert a field // before or after that node instead of appending it to the end of a paragraph para = doc.getFirstSection().getBody().appendParagraph(""); Run run = new Run(doc); { run.setText(" My Run. "); } para.appendChild(run); // Insert a field into the paragraph and place it before the run we created doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe"); para.insertField(FieldType.FIELD_AUTHOR, true, run, false); // Insert another field designated by field code before the run para.insertField(" QUOTE \"Real value\" ", run, false); // Insert another field with a place holder value and place it after the run para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true); doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
deepClone | → inherited from Node |
public Node deepClone(boolean isCloneChildren) |
Example:
Shows how to clone composite nodes with and without their child nodes.// Create a new empty document. Document doc = new Document(); // Add some text to the first paragraph Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new Run(doc, "Some text")); // Clone the paragraph and the child nodes. Node cloneWithChildren = para.deepClone(true); // Only clone the paragraph and no child nodes. Node cloneWithoutChildren = para.deepClone(false);
fetchInheritedParaAttr | |
@Deprecated public java.lang.Object fetchInheritedParaAttr(int key) |
fetchParaAttr | |
@Deprecated public java.lang.Object fetchParaAttr(int key) |
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() + "Table.NestedTables.doc"); int tableIndex = 0; for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true)) { // First lets find if any cells in the table have tables themselves as children. int count = getChildTableCount(table); System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, 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); if (tableDepth > 0) { System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth)); } else { System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex)); } tableIndex++; } } /** * 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(type); 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(type); } 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.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 test if a node is inside a field by using an XPath expression.// Let's pick a document we know has some fields in. Document doc = new Document(getMyDir() + "MailMerge.MergeImage.doc"); // Let's say we want to check if the Run below is inside a field. Run run = (Run) doc.getChild(NodeType.RUN, 5, true); // 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. for (Node node : (Iterable<Node>) resultList) { if (node == run) { System.out.println("The node is found inside a field"); break; } }
Example:
Shows how to extract a specific child node from a CompositeNode by using the GetChild method and passing the NodeType and index.Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
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 extract images from a document and save them as files.public void extractImagesToFiles() throws Exception { Document doc = new Document(getMyDir() + "Image.SampleImages.doc"); NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true); int imageIndex = 0; for (Shape shape : (Iterable<Shape>) shapes) { if (shape.hasImage()) { String imageFileName = String.format("Image.ExportImages.{0}{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType())); shape.getImageData().save(getArtifactsDir() + imageFileName); imageIndex++; } } }
Example:
Demonstrates how to remove a specified TOC from a document.public void removeTOCFromDocument() throws Exception { // Open a document which contains a TOC. Document doc = new Document(getMyDir() + "Document.TableOfContents.doc"); // Remove the first TOC from the document. Field tocField = doc.getRange().getFields().get(0); tocField.remove(); // Save the output. doc.save(getArtifactsDir() + "Document.TableOfContentsRemoveTOC.doc"); }
getDirectParaAttr | |
@Deprecated public java.lang.Object getDirectParaAttr(int key) |
getDirectRunAttr | |
@Deprecated public java.lang.Object getDirectRunAttr(int key) |
getEffectiveTabStops | |
public TabStop[] getEffectiveTabStops() |
Example:
Shows how to set custom tab stops.// Create a blank document and get the first paragraph Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); // If there are no tab stops in this collection, while we are in this paragraph // the cursor will jump 36 points each time we press the Tab key in Microsoft Word Assert.assertEquals(para.getEffectiveTabStops().length, 0); // We can add custom tab stops in Microsoft Word if we enable the ruler via the view tab // Each unit on that ruler is two default tab stops, which is 72 points // Those tab stops can be programmatically added to the paragraph like this para.getParagraphFormat().getTabStops().add(72.0, TabAlignment.LEFT, TabLeader.DOTS); para.getParagraphFormat().getTabStops().add(216.0, TabAlignment.CENTER, TabLeader.DASHES); para.getParagraphFormat().getTabStops().add(360.0, TabAlignment.RIGHT, TabLeader.LINE); // These tab stops are added to this collection, and can also be seen by enabling the ruler mentioned above Assert.assertEquals(para.getEffectiveTabStops().length, 3); // Add a Run with tab characters that will snap the text to our TabStop positions and save the document para.appendChild(new Run(doc, "\tTab 1\tTab 2\tTab 3")); doc.save(getArtifactsDir() + "Paragraph.TabStops.docx");
getText | |
public java.lang.String getText() |
The text of all child nodes is concatenated and the end of paragraph character is appended as follows:
The returned string includes all control and special characters as described in
Example:
Shows how to add, update and delete child nodes from within a CompositeNode.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1); // 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(paragraph.getText(), "Initial text. " + (char) 12); // 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(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4); // 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(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);
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.doc"); // 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. int index = body.getChildNodes().indexOf(body.getLastParagraph());
Example:
Retrieves the index of a row in a table.int rowIndex = table.indexOf(row);
Example:
Retrieves the index of a cell in a row.int cellIndex = row.indexOf(cell);
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 add, update and delete child nodes from within a CompositeNode.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1); // 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(paragraph.getText(), "Initial text. " + (char) 12); // 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(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4); // 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(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);
Example:
Shows how to replace all textboxes with images.Document doc = new Document(getMyDir() + "Shape.ReplaceTextboxesWithImages.doc"); // 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() + "Hammer.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.doc");
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 within a CompositeNode.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1); // 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(paragraph.getText(), "Initial text. " + (char) 12); // 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(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4); // 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(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);
insertField | |
public Field insertField(int fieldType, boolean updateField, Node refNode, boolean isAfter) throws java.lang.Exception |
fieldType
- A updateField
- Specifies whether to update the field immediately.refNode
- Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).isAfter
- Whether to insert the field after or before reference node.Example:
Shows how to insert fields in different ways.// Create a blank document and get its first paragraph Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); // Choose a field by FieldType, append it to the end of the paragraph and update it para.appendField(FieldType.FIELD_DATE, true); // Append a field with a field code created by hand para.appendField(" TIME \\@ \"HH:mm:ss\" "); // Append a field that will display a placeholder value until it is updated manually in Microsoft Word // or programmatically with Document.UpdateFields() or Field.Update() para.appendField(" QUOTE \"Real value\"", "Placeholder value"); // We can choose a node in the paragraph and insert a field // before or after that node instead of appending it to the end of a paragraph para = doc.getFirstSection().getBody().appendParagraph(""); Run run = new Run(doc); { run.setText(" My Run. "); } para.appendChild(run); // Insert a field into the paragraph and place it before the run we created doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe"); para.insertField(FieldType.FIELD_AUTHOR, true, run, false); // Insert another field designated by field code before the run para.insertField(" QUOTE \"Real value\" ", run, false); // Insert another field with a place holder value and place it after the run para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true); doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
insertField | |
public Field insertField(java.lang.String fieldCode, Node refNode, boolean isAfter) throws java.lang.Exception |
fieldCode
- The field code to insert (without curly braces).refNode
- Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).isAfter
- Whether to insert the field after or before reference node.Example:
Shows how to insert fields in different ways.// Create a blank document and get its first paragraph Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); // Choose a field by FieldType, append it to the end of the paragraph and update it para.appendField(FieldType.FIELD_DATE, true); // Append a field with a field code created by hand para.appendField(" TIME \\@ \"HH:mm:ss\" "); // Append a field that will display a placeholder value until it is updated manually in Microsoft Word // or programmatically with Document.UpdateFields() or Field.Update() para.appendField(" QUOTE \"Real value\"", "Placeholder value"); // We can choose a node in the paragraph and insert a field // before or after that node instead of appending it to the end of a paragraph para = doc.getFirstSection().getBody().appendParagraph(""); Run run = new Run(doc); { run.setText(" My Run. "); } para.appendChild(run); // Insert a field into the paragraph and place it before the run we created doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe"); para.insertField(FieldType.FIELD_AUTHOR, true, run, false); // Insert another field designated by field code before the run para.insertField(" QUOTE \"Real value\" ", run, false); // Insert another field with a place holder value and place it after the run para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true); doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
insertField | |
public Field insertField(java.lang.String fieldCode, java.lang.String fieldValue, Node refNode, boolean isAfter) |
fieldCode
- The field code to insert (without curly braces).fieldValue
- The field value to insert. Pass null for fields that do not have a value.refNode
- Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).isAfter
- Whether to insert the field after or before reference node.Example:
Shows how to insert fields in different ways.// Create a blank document and get its first paragraph Document doc = new Document(); Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); // Choose a field by FieldType, append it to the end of the paragraph and update it para.appendField(FieldType.FIELD_DATE, true); // Append a field with a field code created by hand para.appendField(" TIME \\@ \"HH:mm:ss\" "); // Append a field that will display a placeholder value until it is updated manually in Microsoft Word // or programmatically with Document.UpdateFields() or Field.Update() para.appendField(" QUOTE \"Real value\"", "Placeholder value"); // We can choose a node in the paragraph and insert a field // before or after that node instead of appending it to the end of a paragraph para = doc.getFirstSection().getBody().appendParagraph(""); Run run = new Run(doc); { run.setText(" My Run. "); } para.appendChild(run); // Insert a field into the paragraph and place it before the run we created doc.getBuiltInDocumentProperties().get("Author").setValue("John Doe"); para.insertField(FieldType.FIELD_AUTHOR, true, run, false); // Insert another field designated by field code before the run para.insertField(" QUOTE \"Real value\" ", run, false); // Insert another field with a place holder value and place it after the run para.insertField(" QUOTE \"Real value\"", " Placeholder value. ", run, true); doc.save(getArtifactsDir() + "Paragraph.InsertField.docx");
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.NodeCollection children = paragraph.getChildNodes(); for (Node child : (Iterable<Node>) children) { // Paragraph may contain children of various types such as runs, shapes and so on. if (child.getNodeType() == NodeType.RUN) { // Say we found the node that we want, do something useful. Run run = (Run) child; System.out.println(run.getText()); } }
joinRunsWithSameFormatting | |
public int joinRunsWithSameFormatting() |
Example:
Shows how to simplify paragraphs by merging superfluous runs.// Create a blank Document and insert a few short Runs into the first Paragraph // Having many small runs with the same formatting can happen if, for instance, // we edit a document extensively in Microsoft Word Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Run 1. "); builder.write("Run 2. "); builder.write("Run 3. "); builder.write("Run 4. "); // The Paragraph may look like it's in once piece in Microsoft Word, // but under the surface it is fragmented into several Runs, which leaves room for optimization Paragraph para = builder.getCurrentParagraph(); Assert.assertEquals(para.getRuns().getCount(), 4); // Change the style of the last run to something different from the first three para.getRuns().get(3).getFont().setStyleIdentifier(StyleIdentifier.EMPHASIS); // We can run the JoinRunsWithSameFormatting() method to merge similar Runs // This method also returns the number of joins that occured during the merge // Two merges occured to combine Runs 1-3, while Run 4 was left out because it has an incompatible style Assert.assertEquals(para.joinRunsWithSameFormatting(), 2); // The paragraph has been simplified to two runs Assert.assertEquals(para.getRuns().getCount(), 2); Assert.assertEquals(para.getRuns().get(0).getText(), "Run 1. Run 2. Run 3. "); Assert.assertEquals(para.getRuns().get(1).getText(), "Run 4. ");
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.Node curNode = doc; while (curNode != null) { Node nextNode = curNode.nextPreOrder(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; }
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 within a CompositeNode.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1); // 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(paragraph.getText(), "Initial text. " + (char) 12); // 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(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4); // 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(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);
previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.remove | → inherited from Node |
public void remove() |
Example:
Shows how to remove all nodes of a specific type from a composite node. In this example we remove tables from a section body.// Get the section that we want to work on. Section section = doc.getSections().get(0); Body body = section.getBody(); // Select the first child node in the body. Node curNode = body.getFirstChild(); while (curNode != null) { // Save the pointer to the next sibling node because if the current // node is removed from the parent in the next step, we will have // no way of finding the next node to continue the loop. 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; }
Example:
Shows how to delete all images from a document.// 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(); }
removeAllChildren | → inherited from CompositeNode |
public void removeAllChildren() |
Example:
Creates a simple document from scratch using the Aspose.Words object model.// Create an "empty" document. Note that like in Microsoft Word, // the empty document has one section, body and one paragraph in it. Document doc = new Document(); // This truly makes the document empty. No sections (not possible in Microsoft Word). doc.removeAllChildren(); // Create a new section node. // Note that the section has not yet been added to the document, // but we have to specify the parent document. 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); // As a matter of interest, you can retrieve text of the whole document and // see that \x000c is automatically appended. \x000c is the end of section character. System.out.println(doc.getText()); // Save the document. doc.save(getArtifactsDir() + "Section.CreateFromScratch.doc");
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:
Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.// Document is a CompositeNode and LastChild returns the last child node in the Document node. // Since the Document can contain only Section nodes, the last child is the last section. Node lastSection = doc.getLastChild(); // Each node knows its next and previous sibling nodes. // Previous sibling of a section is a section before the specified section. // If the node is the first child, PreviousSibling will return null. Node sectionBeforeLast = lastSection.getPreviousSibling(); if (sectionBeforeLast != null) { doc.removeChild(sectionBeforeLast); }
removeSmartTags | → inherited from CompositeNode |
public void removeSmartTags() |
Example:
Removes all smart tags from descendant nodes of the composite node.Document doc = new Document(getMyDir() + "Document.doc"); // Remove smart tags from the first paragraph in the document. doc.getFirstSection().getBody().getFirstParagraph().removeSmartTags();
Example:
Shows how to remove all smart tags from a document.Document doc = new Document(getMyDir() + "Document.doc"); doc.removeSmartTags();
selectNodes | → inherited from CompositeNode |
public NodeList selectNodes(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.Example:
Shows how to test if a node is inside a field by using an XPath expression.// Let's pick a document we know has some fields in. Document doc = new Document(getMyDir() + "MailMerge.MergeImage.doc"); // Let's say we want to check if the Run below is inside a field. Run run = (Run) doc.getChild(NodeType.RUN, 5, true); // 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. for (Node node : (Iterable<Node>) resultList) { if (node == run) { System.out.println("The node is found inside a field"); break; } }
Example:
Shows how to select certain nodes by using an XPath expression.Document doc = new Document(getMyDir() + "Table.Document.doc"); // 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"); // This expression will select any paragraphs that are direct children of any body node in the document. nodeList = doc.selectNodes("//Body/Paragraph"); // Use SelectSingleNode to select the first result of the same expression as above. Node node = doc.selectSingleNode("//Body/Paragraph");
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() + "Table.Document.doc"); // 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"); // This expression will select any paragraphs that are direct children of any body node in the document. nodeList = doc.selectNodes("//Body/Paragraph"); // Use SelectSingleNode to select the first result of the same expression as above. Node node = doc.selectSingleNode("//Body/Paragraph");
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 using custom specified options.Document doc = new Document(getMyDir() + "Document.doc"); // Extract the last paragraph in the document to convert to HTML. Node node = doc.getLastSection().getBody().getLastParagraph(); // Create an instance of HtmlSaveOptions and set a few options. HtmlSaveOptions saveOptions = new HtmlSaveOptions(); saveOptions.setExportHeadersFootersMode(ExportHeadersFootersMode.PER_SECTION); saveOptions.setExportRelativeFontSize(true); // Convert the document to HTML and return as a string. Pass the instance of HtmlSaveOptions to // to use the specified options during the conversion. String nodeAsHtml = 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() + "Lists.PrintOutAllLists.doc"); 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("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("Numerical Id: " + label.getLabelValue()); // Combine them together to include the list label with the text in the output. System.out.println("List label combined with text: " + label.getLabelString() + " " + paragraphText); listParaCount++; } }
Example:
Shows the difference between calling the GetText and ToString methods on a node.Document doc = new Document(); // Enter a dummy field into the document. DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField("MERGEFIELD Field"); // GetText will retrieve all field codes and special characters System.out.println("GetText() Result: " + doc.getText()); // ToString will export the node to the specified format. When converted to text it will not retrieve fields code // or special characters, but will still contain some natural formatting characters such as paragraph markers etc. // This is the same as "viewing" the document as if it was opened in a text editor. System.out.println("ToString() Result: " + doc.toString(SaveFormat.TEXT));
Example:
Exports the content of a node to string in HTML format using default options.Document doc = new Document(getMyDir() + "Document.doc"); // Extract the last paragraph in the document to convert to HTML. Node node = doc.getLastSection().getBody().getLastParagraph(); // When ToString is called using the SaveFormat overload then conversion is executed using default save options. // When saving to HTML using default options the following settings are set: // ExportImagesAsBase64 = true // CssStyleSheetType = CssStyleSheetType.Inline // ExportFontResources = false String nodeAsHtml = node.toString(SaveFormat.HTML);