com.aspose.words

Class StructuredDocumentTagRangeStart

  • java.lang.Object
    • Node
      • com.aspose.words.StructuredDocumentTagRangeStart
  • All Implemented Interfaces:
    java.lang.Cloneable
    public class StructuredDocumentTagRangeStart 
    extends Node

Represents a start of ranged structured document tag which accepts multi-sections content. See also StructuredDocumentTagRangeEnd.
Can be immediate child of Body node only.

Example:

Shows how to get multi-section structured document tags properties.
Document doc = new Document(getMyDir() + "Multi-section structured document tags.docx");

// Note that these nodes can be a child of NodeType.Body node only and all properties of these nodes are read-only.
StructuredDocumentTagRangeStart rangeStartTag = (StructuredDocumentTagRangeStart) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true).get(0);
StructuredDocumentTagRangeEnd rangeEndTag = (StructuredDocumentTagRangeEnd) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, true).get(0);

System.out.println("StructuredDocumentTagRangeStart values:");
System.out.println("\t|Id: {rangeStartTag.Id}");
System.out.println("\t|Title: {rangeStartTag.Title}");
System.out.println("\t|IsShowingPlaceholderText: {rangeStartTag.IsShowingPlaceholderText}");
System.out.println("\t|LockContentControl: {rangeStartTag.LockContentControl}");
System.out.println("\t|LockContents: {rangeStartTag.LockContents}");
System.out.println("\t|Level: {rangeStartTag.Level}");
System.out.println("\t|NodeType: {rangeStartTag.NodeType}");
System.out.println("\t|RangeEnd: {rangeStartTag.RangeEnd}");
System.out.println("\t|SdtType: {rangeStartTag.SdtType}");
System.out.println("\t|Tag: {rangeStartTag.Tag}\n");

System.out.println("StructuredDocumentTagRangeEnd values:");
System.out.println("\t|Id: {rangeEndTag.Id}");
System.out.println("\t|NodeType: {rangeEndTag.NodeType}");

Property Getters/Setters Summary
java.awt.ColorgetColor()
void
setColor(java.awt.Colorvalue)
           Gets or sets the color of the structured document tag.
intgetCustomNodeId()
void
setCustomNodeId(intvalue)
           Specifies custom node identifier.
DocumentBasegetDocument()
Gets the document to which this node belongs.
intgetId()

Specifies a unique read-only persistent numerical Id for this structured document tag.

booleanisComposite()
Returns true if this node can contain other nodes.
booleanisShowingPlaceholderText()
void
          

Specifies whether the content of this structured document tag shall be interpreted to contain placeholder text (as opposed to regular text contents within the structured document tag).

if set to true, this state shall be resumed (showing placeholder text) upon opening this document.

NodegetLastChild()
Gets the last child in the stdContent range.
intgetLevel()
Gets the level at which this structured document tag range start occurs in the document tree. The value of the property is MarkupLevel integer constant.
booleangetLockContentControl()
void
setLockContentControl(booleanvalue)
           When set to true, this property will prohibit a user from deleting this structured document tag.
booleangetLockContents()
void
setLockContents(booleanvalue)
           When set to true, this property will prohibit a user from editing the contents of this structured document tag.
NodegetNextSibling()
Gets the node immediately following this node.
intgetNodeType()
The value of the property is NodeType integer constant.
CompositeNodegetParentNode()
Gets the immediate parent of this node.
BuildingBlockgetPlaceholder()
Gets the BuildingBlock containing placeholder text which should be displayed when this structured document tag run contents are empty, the associated mapped XML element is empty as specified via the XmlMapping element or the IsShowingPlaceholderText element is true.
java.lang.StringgetPlaceholderName()
void
setPlaceholderName(java.lang.Stringvalue)
          

Gets or sets Name of the BuildingBlock containing placeholder text.

BuildingBlock with this name BuildingBlock.Name has to be present in the Document.GlossaryDocument otherwise System.InvalidOperationException will occur.

NodegetPreviousSibling()
Gets the node immediately preceding this node.
RangegetRange()
Returns a Range object that represents the portion of a document that is contained in this node.
StructuredDocumentTagRangeEndgetRangeEnd()
Specifies end of range if the StructuredDocumentTag is a ranged structured document tag. Otherwise returns null.
intgetSdtType()
Gets type of this structured document tag. The value of the property is SdtType integer constant.
java.lang.StringgetTag()
void
setTag(java.lang.Stringvalue)
           Specifies a tag associated with the current structured document tag node. Can not be null.
java.lang.StringgetTitle()
void
setTitle(java.lang.Stringvalue)
           Specifies the friendly name associated with this structured document tag. Can not be null.
XmlMappinggetXmlMapping()
Gets an object that represents the mapping of this structured document tag range to XML data in a custom XML part of the current document.
 
Method Summary
booleanaccept(DocumentVisitor visitor)
NodeappendChild(Node newChild)
Adds the specified node to the end of the stdContent range.
NodedeepClone(boolean isCloneChildren)
Creates a duplicate of the node.
CompositeNodegetAncestor(int ancestorType)
Gets the first ancestor of the specified NodeType.
CompositeNodegetAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.
java.lang.StringgetText()
Gets the text of this node and of all its children.
NodenextPreOrder(Node rootNode)
Gets next node according to the pre-order tree traversal algorithm.
NodepreviousPreOrder(Node rootNode)
Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()
Removes itself from the parent.
java.lang.StringtoString(SaveOptions saveOptions)
Exports the content of the node into a string using the specified save options.
java.lang.StringtoString(int saveFormat)
Exports the content of the node into a string in the specified format.
 

    • Property Getters/Setters Detail

      • getColor/setColor

        public java.awt.Color getColor() / public void setColor(java.awt.Color value)
        
        Gets or sets the color of the structured document tag.
      • getCustomNodeId/setCustomNodeId

        public int getCustomNodeId() / public void setCustomNodeId(int value)
        
        Specifies custom node identifier.

        Default is zero.

        This identifier can be set and used arbitrarily. For example, as a key to get external data.

      • getDocument

        public DocumentBase getDocument()
        
        Gets the document to which this node belongs.

        The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.

        Example:

        Shows how to create a node and set its owning document.
        Document doc = new Document();
        Paragraph para = new Paragraph(doc);
        para.appendChild(new Run(doc, "Hello world!"));
        
        // We have not yet appended this paragraph as a child to any composite node.
        Assert.assertNull(para.getParentNode());
        
        // If a node is an appropriate child node type of another composite node,
        // we can attach it as a child only if both nodes have the same owner document.
        // The owner document is the document we passed to the node's constructor.
        // We have not attached this paragraph to the document, so the document does not contain its text.
        Assert.assertEquals(para.getDocument(), doc);
        Assert.assertEquals("", doc.getText().trim());
        
        // Since the document owns this paragraph, we can apply one of its styles to the paragraph's contents.
        para.getParagraphFormat().setStyleName("Heading 1");
        
        // Add this node to the document, and then verify its contents.
        doc.getFirstSection().getBody().appendChild(para);
        
        Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
        Assert.assertEquals("Hello world!", doc.getText().trim());
      • getId

        public int getId()
        

        Specifies a unique read-only persistent numerical Id for this structured document tag.

        Id attribute shall follow these rules:

        • The document shall retain structured document tag ids only if the whole document is cloned Document.deepClone().
        • During DocumentBase.importNode(com.aspose.words.Node,boolean) Id shall be retained if import does not cause conflicts with other structured document tag Ids in the target document.
        • If multiple structured document tag nodes specify the same decimal number value for the Id attribute, then the first structured document tag in the document shall maintain this original Id, and all subsequent structured document tag nodes shall have new identifiers assigned to them when the document is loaded.
        • During standalone structured document tag Clone operation new unique ID will be generated for the cloned structured document tag node.
        • If Id is not specified in the source document, then the structured document tag node shall have a new unique identifier assigned to it when the document is loaded.

        Example:

        Shows how to get multi-section structured document tags properties.
        Document doc = new Document(getMyDir() + "Multi-section structured document tags.docx");
        
        // Note that these nodes can be a child of NodeType.Body node only and all properties of these nodes are read-only.
        StructuredDocumentTagRangeStart rangeStartTag = (StructuredDocumentTagRangeStart) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true).get(0);
        StructuredDocumentTagRangeEnd rangeEndTag = (StructuredDocumentTagRangeEnd) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, true).get(0);
        
        System.out.println("StructuredDocumentTagRangeStart values:");
        System.out.println("\t|Id: {rangeStartTag.Id}");
        System.out.println("\t|Title: {rangeStartTag.Title}");
        System.out.println("\t|IsShowingPlaceholderText: {rangeStartTag.IsShowingPlaceholderText}");
        System.out.println("\t|LockContentControl: {rangeStartTag.LockContentControl}");
        System.out.println("\t|LockContents: {rangeStartTag.LockContents}");
        System.out.println("\t|Level: {rangeStartTag.Level}");
        System.out.println("\t|NodeType: {rangeStartTag.NodeType}");
        System.out.println("\t|RangeEnd: {rangeStartTag.RangeEnd}");
        System.out.println("\t|SdtType: {rangeStartTag.SdtType}");
        System.out.println("\t|Tag: {rangeStartTag.Tag}\n");
        
        System.out.println("StructuredDocumentTagRangeEnd values:");
        System.out.println("\t|Id: {rangeEndTag.Id}");
        System.out.println("\t|NodeType: {rangeEndTag.NodeType}");
      • isComposite

        public boolean isComposite()
        
        Returns true if this node can contain other nodes. This method returns false as Node cannot have child nodes.

        Example:

        Shows how to traverse a composite node's tree of child nodes.
        public void recurseChildren() throws Exception {
            Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
            // Any node that can contain child nodes, such as the document itself, is composite.
            Assert.assertTrue(doc.isComposite());
        
            // Invoke the recursive function that will go through and print all the child nodes of a composite node.
            traverseAllNodes(doc, 0);
        }
        
        /// <summary>
        /// Recursively traverses a node tree while printing the type of each node
        /// with an indent depending on depth as well as the contents of all inline nodes.
        /// </summary>
        @Test(enabled = false)
        public void traverseAllNodes(CompositeNode parentNode, int depth) {
            for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
                System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));
        
                // Recurse into the node if it is a composite node. Otherwise, print its contents if it is an inline node.
                if (childNode.isComposite()) {
                    System.out.println();
                    traverseAllNodes((CompositeNode) childNode, depth + 1);
                } else if (childNode instanceof Inline) {
                    System.out.println(" - \"{childNode.GetText().Trim()}\"");
                } else {
                    System.out.println();
                }
            }
        }
      • isShowingPlaceholderText/isShowingPlaceholderText

        public boolean isShowingPlaceholderText() / public void isShowingPlaceholderText(boolean value)
        

        Specifies whether the content of this structured document tag shall be interpreted to contain placeholder text (as opposed to regular text contents within the structured document tag).

        if set to true, this state shall be resumed (showing placeholder text) upon opening this document.

        Example:

        Shows how to get multi-section structured document tags properties.
        Document doc = new Document(getMyDir() + "Multi-section structured document tags.docx");
        
        // Note that these nodes can be a child of NodeType.Body node only and all properties of these nodes are read-only.
        StructuredDocumentTagRangeStart rangeStartTag = (StructuredDocumentTagRangeStart) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true).get(0);
        StructuredDocumentTagRangeEnd rangeEndTag = (StructuredDocumentTagRangeEnd) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, true).get(0);
        
        System.out.println("StructuredDocumentTagRangeStart values:");
        System.out.println("\t|Id: {rangeStartTag.Id}");
        System.out.println("\t|Title: {rangeStartTag.Title}");
        System.out.println("\t|IsShowingPlaceholderText: {rangeStartTag.IsShowingPlaceholderText}");
        System.out.println("\t|LockContentControl: {rangeStartTag.LockContentControl}");
        System.out.println("\t|LockContents: {rangeStartTag.LockContents}");
        System.out.println("\t|Level: {rangeStartTag.Level}");
        System.out.println("\t|NodeType: {rangeStartTag.NodeType}");
        System.out.println("\t|RangeEnd: {rangeStartTag.RangeEnd}");
        System.out.println("\t|SdtType: {rangeStartTag.SdtType}");
        System.out.println("\t|Tag: {rangeStartTag.Tag}\n");
        
        System.out.println("StructuredDocumentTagRangeEnd values:");
        System.out.println("\t|Id: {rangeEndTag.Id}");
        System.out.println("\t|NodeType: {rangeEndTag.NodeType}");
      • getLastChild

        public Node getLastChild()
        
        Gets the last child in the stdContent range. If there is no last child node, a null is returned.
      • getLevel

        public int getLevel()
        
        Gets the level at which this structured document tag range start occurs in the document tree. The value of the property is MarkupLevel integer constant.

        Example:

        Shows how to get multi-section structured document tags properties.
        Document doc = new Document(getMyDir() + "Multi-section structured document tags.docx");
        
        // Note that these nodes can be a child of NodeType.Body node only and all properties of these nodes are read-only.
        StructuredDocumentTagRangeStart rangeStartTag = (StructuredDocumentTagRangeStart) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true).get(0);
        StructuredDocumentTagRangeEnd rangeEndTag = (StructuredDocumentTagRangeEnd) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, true).get(0);
        
        System.out.println("StructuredDocumentTagRangeStart values:");
        System.out.println("\t|Id: {rangeStartTag.Id}");
        System.out.println("\t|Title: {rangeStartTag.Title}");
        System.out.println("\t|IsShowingPlaceholderText: {rangeStartTag.IsShowingPlaceholderText}");
        System.out.println("\t|LockContentControl: {rangeStartTag.LockContentControl}");
        System.out.println("\t|LockContents: {rangeStartTag.LockContents}");
        System.out.println("\t|Level: {rangeStartTag.Level}");
        System.out.println("\t|NodeType: {rangeStartTag.NodeType}");
        System.out.println("\t|RangeEnd: {rangeStartTag.RangeEnd}");
        System.out.println("\t|SdtType: {rangeStartTag.SdtType}");
        System.out.println("\t|Tag: {rangeStartTag.Tag}\n");
        
        System.out.println("StructuredDocumentTagRangeEnd values:");
        System.out.println("\t|Id: {rangeEndTag.Id}");
        System.out.println("\t|NodeType: {rangeEndTag.NodeType}");
      • getLockContentControl/setLockContentControl

        public boolean getLockContentControl() / public void setLockContentControl(boolean value)
        
        When set to true, this property will prohibit a user from deleting this structured document tag.

        Example:

        Shows how to get multi-section structured document tags properties.
        Document doc = new Document(getMyDir() + "Multi-section structured document tags.docx");
        
        // Note that these nodes can be a child of NodeType.Body node only and all properties of these nodes are read-only.
        StructuredDocumentTagRangeStart rangeStartTag = (StructuredDocumentTagRangeStart) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true).get(0);
        StructuredDocumentTagRangeEnd rangeEndTag = (StructuredDocumentTagRangeEnd) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, true).get(0);
        
        System.out.println("StructuredDocumentTagRangeStart values:");
        System.out.println("\t|Id: {rangeStartTag.Id}");
        System.out.println("\t|Title: {rangeStartTag.Title}");
        System.out.println("\t|IsShowingPlaceholderText: {rangeStartTag.IsShowingPlaceholderText}");
        System.out.println("\t|LockContentControl: {rangeStartTag.LockContentControl}");
        System.out.println("\t|LockContents: {rangeStartTag.LockContents}");
        System.out.println("\t|Level: {rangeStartTag.Level}");
        System.out.println("\t|NodeType: {rangeStartTag.NodeType}");
        System.out.println("\t|RangeEnd: {rangeStartTag.RangeEnd}");
        System.out.println("\t|SdtType: {rangeStartTag.SdtType}");
        System.out.println("\t|Tag: {rangeStartTag.Tag}\n");
        
        System.out.println("StructuredDocumentTagRangeEnd values:");
        System.out.println("\t|Id: {rangeEndTag.Id}");
        System.out.println("\t|NodeType: {rangeEndTag.NodeType}");
      • getLockContents/setLockContents

        public boolean getLockContents() / public void setLockContents(boolean value)
        
        When set to true, this property will prohibit a user from editing the contents of this structured document tag.

        Example:

        Shows how to get multi-section structured document tags properties.
        Document doc = new Document(getMyDir() + "Multi-section structured document tags.docx");
        
        // Note that these nodes can be a child of NodeType.Body node only and all properties of these nodes are read-only.
        StructuredDocumentTagRangeStart rangeStartTag = (StructuredDocumentTagRangeStart) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true).get(0);
        StructuredDocumentTagRangeEnd rangeEndTag = (StructuredDocumentTagRangeEnd) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, true).get(0);
        
        System.out.println("StructuredDocumentTagRangeStart values:");
        System.out.println("\t|Id: {rangeStartTag.Id}");
        System.out.println("\t|Title: {rangeStartTag.Title}");
        System.out.println("\t|IsShowingPlaceholderText: {rangeStartTag.IsShowingPlaceholderText}");
        System.out.println("\t|LockContentControl: {rangeStartTag.LockContentControl}");
        System.out.println("\t|LockContents: {rangeStartTag.LockContents}");
        System.out.println("\t|Level: {rangeStartTag.Level}");
        System.out.println("\t|NodeType: {rangeStartTag.NodeType}");
        System.out.println("\t|RangeEnd: {rangeStartTag.RangeEnd}");
        System.out.println("\t|SdtType: {rangeStartTag.SdtType}");
        System.out.println("\t|Tag: {rangeStartTag.Tag}\n");
        
        System.out.println("StructuredDocumentTagRangeEnd values:");
        System.out.println("\t|Id: {rangeEndTag.Id}");
        System.out.println("\t|NodeType: {rangeEndTag.NodeType}");
      • getNextSibling

        public Node getNextSibling()
        
        Gets the node immediately following this node. If there is no next node, a null is returned.

        Example:

        Shows how to use a node's NextSibling property to enumerate through its immediate children.
        Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
        for (Node node = doc.getFirstSection().getBody().getFirstChild(); node != null; node = node.getNextSibling()) {
            System.out.println(Node.nodeTypeToString(node.getNodeType()));
        }

        Example:

        Shows how to traverse a composite node's tree of child nodes.
        public void recurseChildren() throws Exception {
            Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
            // Any node that can contain child nodes, such as the document itself, is composite.
            Assert.assertTrue(doc.isComposite());
        
            // Invoke the recursive function that will go through and print all the child nodes of a composite node.
            traverseAllNodes(doc, 0);
        }
        
        /// <summary>
        /// Recursively traverses a node tree while printing the type of each node
        /// with an indent depending on depth as well as the contents of all inline nodes.
        /// </summary>
        @Test(enabled = false)
        public void traverseAllNodes(CompositeNode parentNode, int depth) {
            for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
                System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));
        
                // Recurse into the node if it is a composite node. Otherwise, print its contents if it is an inline node.
                if (childNode.isComposite()) {
                    System.out.println();
                    traverseAllNodes((CompositeNode) childNode, depth + 1);
                } else if (childNode instanceof Inline) {
                    System.out.println(" - \"{childNode.GetText().Trim()}\"");
                } else {
                    System.out.println();
                }
            }
        }
      • getNodeType

        public int getNodeType()
        
        The value of the property is NodeType integer constant.
      • getParentNode

        public CompositeNode getParentNode()
        
        Gets the immediate parent of this node.

        If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.

        Example:

        Shows how to access a node's parent node.
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        
        // Append a child Run node to the document's first paragraph.
        Run run = new Run(doc, "Hello world!");
        para.appendChild(run);
        
        // The paragraph is the parent node of the run node. We can trace this lineage
        // all the way to the document node, which is the root of the document's node tree.
        Assert.assertEquals(para, run.getParentNode());
        Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
        Assert.assertEquals(doc.getFirstSection(), doc.getFirstSection().getBody().getParentNode());
        Assert.assertEquals(doc, doc.getFirstSection().getParentNode());

        Example:

        Shows how to create a node and set its owning document.
        Document doc = new Document();
        Paragraph para = new Paragraph(doc);
        para.appendChild(new Run(doc, "Hello world!"));
        
        // We have not yet appended this paragraph as a child to any composite node.
        Assert.assertNull(para.getParentNode());
        
        // If a node is an appropriate child node type of another composite node,
        // we can attach it as a child only if both nodes have the same owner document.
        // The owner document is the document we passed to the node's constructor.
        // We have not attached this paragraph to the document, so the document does not contain its text.
        Assert.assertEquals(para.getDocument(), doc);
        Assert.assertEquals("", doc.getText().trim());
        
        // Since the document owns this paragraph, we can apply one of its styles to the paragraph's contents.
        para.getParagraphFormat().setStyleName("Heading 1");
        
        // Add this node to the document, and then verify its contents.
        doc.getFirstSection().getBody().appendChild(para);
        
        Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
        Assert.assertEquals("Hello world!", doc.getText().trim());
      • getPlaceholder

        public BuildingBlock getPlaceholder()
        
        Gets the BuildingBlock containing placeholder text which should be displayed when this structured document tag run contents are empty, the associated mapped XML element is empty as specified via the XmlMapping element or the IsShowingPlaceholderText element is true. Can be null, meaning that the placeholder is not applicable for this structured document tag.
      • getPlaceholderName/setPlaceholderName

        public java.lang.String getPlaceholderName() / public void setPlaceholderName(java.lang.String value)
        

        Gets or sets Name of the BuildingBlock containing placeholder text.

        BuildingBlock with this name BuildingBlock.Name has to be present in the Document.GlossaryDocument otherwise System.InvalidOperationException will occur.

      • getPreviousSibling

        public Node getPreviousSibling()
        
        Gets the node immediately preceding this node. If there is no preceding node, a null is returned.

        Example:

        Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Section 1 text.");
        builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
        builder.writeln("Section 2 text.");
        
        // Both sections are siblings of each other.
        Section lastSection = (Section) doc.getLastChild();
        Section firstSection = (Section) lastSection.getPreviousSibling();
        
        // Remove a section based on its sibling relationship with another section.
        if (lastSection.getPreviousSibling() != null)
            doc.removeChild(firstSection);
        
        // The section we removed was the first one, leaving the document with only the second.
        Assert.assertEquals("Section 2 text.", doc.getText().trim());
      • getRange

        public Range getRange()
        
        Returns a Range object that represents the portion of a document that is contained in this node.

        Example:

        Shows how to delete all the nodes from a range.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Add text to the first section in the document, and then add another section.
        builder.write("Section 1. ");
        builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
        builder.write("Section 2.");
        
        Assert.assertEquals("Section 1. \fSection 2.", doc.getText().trim());
        
        // Remove the first section entirely by removing all of the nodes
        // within its range, including the section itself.
        doc.getSections().get(0).getRange().delete();
        
        Assert.assertEquals(1, doc.getSections().getCount());
        Assert.assertEquals("Section 2.", doc.getText().trim());
      • getRangeEnd

        public StructuredDocumentTagRangeEnd getRangeEnd()
        
        Specifies end of range if the StructuredDocumentTag is a ranged structured document tag. Otherwise returns null.

        Example:

        Shows how to get multi-section structured document tags properties.
        Document doc = new Document(getMyDir() + "Multi-section structured document tags.docx");
        
        // Note that these nodes can be a child of NodeType.Body node only and all properties of these nodes are read-only.
        StructuredDocumentTagRangeStart rangeStartTag = (StructuredDocumentTagRangeStart) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true).get(0);
        StructuredDocumentTagRangeEnd rangeEndTag = (StructuredDocumentTagRangeEnd) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, true).get(0);
        
        System.out.println("StructuredDocumentTagRangeStart values:");
        System.out.println("\t|Id: {rangeStartTag.Id}");
        System.out.println("\t|Title: {rangeStartTag.Title}");
        System.out.println("\t|IsShowingPlaceholderText: {rangeStartTag.IsShowingPlaceholderText}");
        System.out.println("\t|LockContentControl: {rangeStartTag.LockContentControl}");
        System.out.println("\t|LockContents: {rangeStartTag.LockContents}");
        System.out.println("\t|Level: {rangeStartTag.Level}");
        System.out.println("\t|NodeType: {rangeStartTag.NodeType}");
        System.out.println("\t|RangeEnd: {rangeStartTag.RangeEnd}");
        System.out.println("\t|SdtType: {rangeStartTag.SdtType}");
        System.out.println("\t|Tag: {rangeStartTag.Tag}\n");
        
        System.out.println("StructuredDocumentTagRangeEnd values:");
        System.out.println("\t|Id: {rangeEndTag.Id}");
        System.out.println("\t|NodeType: {rangeEndTag.NodeType}");
      • getSdtType

        public int getSdtType()
        
        Gets type of this structured document tag. The value of the property is SdtType integer constant.

        Example:

        Shows how to get multi-section structured document tags properties.
        Document doc = new Document(getMyDir() + "Multi-section structured document tags.docx");
        
        // Note that these nodes can be a child of NodeType.Body node only and all properties of these nodes are read-only.
        StructuredDocumentTagRangeStart rangeStartTag = (StructuredDocumentTagRangeStart) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true).get(0);
        StructuredDocumentTagRangeEnd rangeEndTag = (StructuredDocumentTagRangeEnd) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, true).get(0);
        
        System.out.println("StructuredDocumentTagRangeStart values:");
        System.out.println("\t|Id: {rangeStartTag.Id}");
        System.out.println("\t|Title: {rangeStartTag.Title}");
        System.out.println("\t|IsShowingPlaceholderText: {rangeStartTag.IsShowingPlaceholderText}");
        System.out.println("\t|LockContentControl: {rangeStartTag.LockContentControl}");
        System.out.println("\t|LockContents: {rangeStartTag.LockContents}");
        System.out.println("\t|Level: {rangeStartTag.Level}");
        System.out.println("\t|NodeType: {rangeStartTag.NodeType}");
        System.out.println("\t|RangeEnd: {rangeStartTag.RangeEnd}");
        System.out.println("\t|SdtType: {rangeStartTag.SdtType}");
        System.out.println("\t|Tag: {rangeStartTag.Tag}\n");
        
        System.out.println("StructuredDocumentTagRangeEnd values:");
        System.out.println("\t|Id: {rangeEndTag.Id}");
        System.out.println("\t|NodeType: {rangeEndTag.NodeType}");
      • getTag/setTag

        public java.lang.String getTag() / public void setTag(java.lang.String value)
        
        Specifies a tag associated with the current structured document tag node. Can not be null. A tag is an arbitrary string which applications can associate with structured document tag in order to identify it without providing a visible friendly name.

        Example:

        Shows how to get multi-section structured document tags properties.
        Document doc = new Document(getMyDir() + "Multi-section structured document tags.docx");
        
        // Note that these nodes can be a child of NodeType.Body node only and all properties of these nodes are read-only.
        StructuredDocumentTagRangeStart rangeStartTag = (StructuredDocumentTagRangeStart) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true).get(0);
        StructuredDocumentTagRangeEnd rangeEndTag = (StructuredDocumentTagRangeEnd) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, true).get(0);
        
        System.out.println("StructuredDocumentTagRangeStart values:");
        System.out.println("\t|Id: {rangeStartTag.Id}");
        System.out.println("\t|Title: {rangeStartTag.Title}");
        System.out.println("\t|IsShowingPlaceholderText: {rangeStartTag.IsShowingPlaceholderText}");
        System.out.println("\t|LockContentControl: {rangeStartTag.LockContentControl}");
        System.out.println("\t|LockContents: {rangeStartTag.LockContents}");
        System.out.println("\t|Level: {rangeStartTag.Level}");
        System.out.println("\t|NodeType: {rangeStartTag.NodeType}");
        System.out.println("\t|RangeEnd: {rangeStartTag.RangeEnd}");
        System.out.println("\t|SdtType: {rangeStartTag.SdtType}");
        System.out.println("\t|Tag: {rangeStartTag.Tag}\n");
        
        System.out.println("StructuredDocumentTagRangeEnd values:");
        System.out.println("\t|Id: {rangeEndTag.Id}");
        System.out.println("\t|NodeType: {rangeEndTag.NodeType}");
      • getTitle/setTitle

        public java.lang.String getTitle() / public void setTitle(java.lang.String value)
        
        Specifies the friendly name associated with this structured document tag. Can not be null.

        Example:

        Shows how to get multi-section structured document tags properties.
        Document doc = new Document(getMyDir() + "Multi-section structured document tags.docx");
        
        // Note that these nodes can be a child of NodeType.Body node only and all properties of these nodes are read-only.
        StructuredDocumentTagRangeStart rangeStartTag = (StructuredDocumentTagRangeStart) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true).get(0);
        StructuredDocumentTagRangeEnd rangeEndTag = (StructuredDocumentTagRangeEnd) doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, true).get(0);
        
        System.out.println("StructuredDocumentTagRangeStart values:");
        System.out.println("\t|Id: {rangeStartTag.Id}");
        System.out.println("\t|Title: {rangeStartTag.Title}");
        System.out.println("\t|IsShowingPlaceholderText: {rangeStartTag.IsShowingPlaceholderText}");
        System.out.println("\t|LockContentControl: {rangeStartTag.LockContentControl}");
        System.out.println("\t|LockContents: {rangeStartTag.LockContents}");
        System.out.println("\t|Level: {rangeStartTag.Level}");
        System.out.println("\t|NodeType: {rangeStartTag.NodeType}");
        System.out.println("\t|RangeEnd: {rangeStartTag.RangeEnd}");
        System.out.println("\t|SdtType: {rangeStartTag.SdtType}");
        System.out.println("\t|Tag: {rangeStartTag.Tag}\n");
        
        System.out.println("StructuredDocumentTagRangeEnd values:");
        System.out.println("\t|Id: {rangeEndTag.Id}");
        System.out.println("\t|NodeType: {rangeEndTag.NodeType}");
    • Method Detail

      • accept

        public boolean accept(DocumentVisitor visitor)
                      throws java.lang.Exception
      • appendChild

        public Node appendChild(Node newChild)
                        throws java.lang.Exception
        Adds the specified node to the end of the stdContent range.
        Parameters:
        newChild - The node to add.
        Returns:
        The node added.
      • deepClone

        public Node deepClone(boolean isCloneChildren)
        Creates a duplicate of the node.

        This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.

        This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.

        Parameters:
        isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.
        Returns:
        The cloned node.

        Example:

        Shows how to clone a composite node.
        Document doc = new Document();
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        para.appendChild(new Run(doc, "Hello world!"));
        
        // Below are two ways of cloning a composite node.
        // 1 -  Create a clone of a node, and create a clone of each of its child nodes as well.
        Node cloneWithChildren = para.deepClone(true);
        
        Assert.assertTrue(((CompositeNode) cloneWithChildren).hasChildNodes());
        Assert.assertEquals("Hello world!", cloneWithChildren.getText().trim());
        
        // 2 -  Create a clone of a node just by itself without any children.
        Node cloneWithoutChildren = para.deepClone(false);
        
        Assert.assertFalse(((CompositeNode) cloneWithoutChildren).hasChildNodes());
        Assert.assertEquals("", cloneWithoutChildren.getText().trim());
      • getAncestor

        public CompositeNode getAncestor(int ancestorType)
        Gets the first ancestor of the specified NodeType.
        Parameters:
        ancestorType - A NodeType value. The node type of the ancestor to retrieve.
        Returns:
        The ancestor of the specified type or null if no ancestor of this type was found.

        Example:

        Shows how to find out if a table contains another table or if the table itself is nested inside another table.
        public void calculateDepthOfNestedTables() throws Exception {
            Document doc = new Document(getMyDir() + "Nested tables.docx");
            NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
        
            for (int i = 0; i < tables.getCount(); i++) {
                // First lets find if any cells in the table have tables themselves as children
                int count = getChildTableCount((Table) tables.get(i));
                System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count));
        
                // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth
                int tableDepth = getNestedDepthOfTable((Table) tables.get(i));
        
                if (tableDepth > 0)
                    System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth));
                else
                    System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i));
            }
        }
        
        /**
         * Calculates what level a table is nested inside other tables.
         *
         * @returns An integer containing the level the table is nested at.
         * 0 = Table is not nested inside any other table
         * 1 = Table is nested within one parent table
         * 2 = Table is nested within two parent tables etc..
         */
        private static int getNestedDepthOfTable(final Table table) {
            int depth = 0;
        
            int type = table.getNodeType();
            // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table
            Node parent = table.getAncestor(table.getNodeType());
        
            while (parent != null) {
                // Every time we find a table a level up we increase the depth counter and then try to find an
                // ancestor of type table from the parent
                depth++;
                parent = parent.getAncestor(Table.class);
            }
        
            return depth;
        }
        
        /**
         * Determines if a table contains any immediate child table within its cells.
         * Does not recursively traverse through those tables to check for further tables.
         *
         * @returns Returns true if at least one child cell contains a table.
         * Returns false if no cells in the table contains a table.
         */
        private static int getChildTableCount(final Table table) {
            int tableCount = 0;
            // Iterate through all child rows in the table
            for (Row row : table.getRows()) {
                // Iterate through all child cells in the row
                for (Cell cell : row.getCells()) {
                    // Retrieve the collection of child tables of this cell
                    TableCollection childTables = cell.getTables();
        
                    // If this cell has a table as a child then return true
                    if (childTables.getCount() > 0) tableCount++;
                }
            }
        
            // No cell contains a table
            return tableCount;
        }
      • getAncestor

        public CompositeNode getAncestor(java.lang.Class ancestorType)
        Gets the first ancestor of the specified object type.

        The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

        Parameters:
        ancestorType - The object type of the ancestor to retrieve.
        Returns:
        The ancestor of the specified type or null if no ancestor of this type was found.

        Example:

        Shows how to find out if a table contains another table or if the table itself is nested inside another table.
        public void calculateDepthOfNestedTables() throws Exception {
            Document doc = new Document(getMyDir() + "Nested tables.docx");
            NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
        
            for (int i = 0; i < tables.getCount(); i++) {
                // First lets find if any cells in the table have tables themselves as children
                int count = getChildTableCount((Table) tables.get(i));
                System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, count));
        
                // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth
                int tableDepth = getNestedDepthOfTable((Table) tables.get(i));
        
                if (tableDepth > 0)
                    System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth));
                else
                    System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i));
            }
        }
        
        /**
         * Calculates what level a table is nested inside other tables.
         *
         * @returns An integer containing the level the table is nested at.
         * 0 = Table is not nested inside any other table
         * 1 = Table is nested within one parent table
         * 2 = Table is nested within two parent tables etc..
         */
        private static int getNestedDepthOfTable(final Table table) {
            int depth = 0;
        
            int type = table.getNodeType();
            // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table
            Node parent = table.getAncestor(table.getNodeType());
        
            while (parent != null) {
                // Every time we find a table a level up we increase the depth counter and then try to find an
                // ancestor of type table from the parent
                depth++;
                parent = parent.getAncestor(Table.class);
            }
        
            return depth;
        }
        
        /**
         * Determines if a table contains any immediate child table within its cells.
         * Does not recursively traverse through those tables to check for further tables.
         *
         * @returns Returns true if at least one child cell contains a table.
         * Returns false if no cells in the table contains a table.
         */
        private static int getChildTableCount(final Table table) {
            int tableCount = 0;
            // Iterate through all child rows in the table
            for (Row row : table.getRows()) {
                // Iterate through all child cells in the row
                for (Cell cell : row.getCells()) {
                    // Retrieve the collection of child tables of this cell
                    TableCollection childTables = cell.getTables();
        
                    // If this cell has a table as a child then return true
                    if (childTables.getCount() > 0) tableCount++;
                }
            }
        
            // No cell contains a table
            return tableCount;
        }
      • getText

        public java.lang.String getText()
        Gets the text of this node and of all its children.

        The returned string includes all control and special characters as described in ControlChar.

        Example:

        Shows how to construct an Aspose.Words document by hand.
        Document doc = new Document();
        
        // A blank document contains one section, one body and one paragraph.
        // Call the "RemoveAllChildren" method to remove all those nodes,
        // and end up with a document node with no children.
        doc.removeAllChildren();
        
        // This document now has no composite child nodes that we can add content to.
        // If we wish to edit it, we will need to repopulate its node collection.
        // First, create a new section, and then append it as a child to the root document node.
        Section section = new Section(doc);
        doc.appendChild(section);
        
        // Set some page setup properties for the section.
        section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
        section.getPageSetup().setPaperSize(PaperSize.LETTER);
        
        // A section needs a body, which will contain and display all of its contents
        // on the page between the section's header and footer.
        Body body = new Body(doc);
        section.appendChild(body);
        
        // Create a paragraph, set some formatting properties, and then append it as a child to the body.
        Paragraph para = new Paragraph(doc);
        
        para.getParagraphFormat().setStyleName("Heading 1");
        para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        
        body.appendChild(para);
        
        // Finally, add some content to do the document by creating a run,
        // setting its text contents and appearance, and appending it as a child to the paragraph.
        Run run = new Run(doc);
        run.setText("Hello World!");
        run.getFont().setColor(Color.RED);
        para.appendChild(run);
        
        Assert.assertEquals("Hello World!", doc.getText().trim());
        
        doc.save(getArtifactsDir() + "Section.CreateManually.docx");

        Example:

        Shows how to use control characters.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert paragraphs with text with DocumentBuilder.
        builder.writeln("Hello world!");
        builder.writeln("Hello again!");
        
        // Converting the document to text form reveals that control characters
        // represent some of the document's structural elements, such as page breaks.
        Assert.assertEquals(MessageFormat.format("Hello world!{0}", ControlChar.CR) +
                MessageFormat.format("Hello again!{0}", ControlChar.CR) +
                ControlChar.PAGE_BREAK, doc.getText());
        
        // When converting a document to string form,
        // we can omit some of the control characters with the Trim method.
        Assert.assertEquals(MessageFormat.format("Hello world!{0}", ControlChar.CR) +
                "Hello again!", doc.getText().trim());
      • nextPreOrder

        public Node nextPreOrder(Node rootNode)
        Gets next node according to the pre-order tree traversal algorithm.
        Parameters:
        rootNode - The top node (limit) of traversal.
        Returns:
        Next node in pre-order order. Null if reached the rootNode.
      • previousPreOrder

        public Node previousPreOrder(Node rootNode)
        Gets the previous node according to the pre-order tree traversal algorithm.
        Parameters:
        rootNode - The top node (limit) of traversal.
        Returns:
        Previous node in pre-order order. Null if reached the rootNode.
      • remove

        public void remove()
        Removes itself from the parent.

        Example:

        Shows how to remove all child nodes of a specific type from a composite node.
        Document doc = new Document(getMyDir() + "Tables.docx");
        
        Assert.assertEquals(2, doc.getChildNodes(NodeType.TABLE, true).getCount());
        
        Node curNode = doc.getFirstSection().getBody().getFirstChild();
        
        while (curNode != null) {
            // Save the next sibling node as a variable in case we want to move to it after deleting this node.
            Node nextNode = curNode.getNextSibling();
        
            // A section body can contain Paragraph and Table nodes.
            // If the node is a Table, remove it from the parent.
            if (curNode.getNodeType() == NodeType.TABLE) {
                curNode.remove();
            }
        
            curNode = nextNode;
        }
        
        Assert.assertEquals(0, doc.getChildNodes(NodeType.TABLE, true).getCount());
      • toString

        public java.lang.String toString(SaveOptions saveOptions)
                       throws java.lang.Exception
        Exports the content of the node into a string using the specified save options.
        Parameters:
        saveOptions - Specifies the options that control how the node is saved.
        Returns:
        The content of the node in the specified format.

        Example:

        Exports the content of a node to String in HTML format.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When we call the ToString method using the html SaveFormat overload,
        // it converts the node's contents to their raw html representation.
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(SaveFormat.HTML));
        
        // We can also modify the result of this conversion using a SaveOptions object.
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setExportRelativeFontSize(true);
        
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(saveOptions));
      • toString

        public java.lang.String toString(int saveFormat)
                       throws java.lang.Exception
        Exports the content of the node into a string in the specified format.
        Returns:
        The content of the node in the specified format.
        Parameters:
        saveFormat - A SaveFormat value.

        Example:

        Shows how to extract the label of each paragraph in a list as a value or a String.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        doc.updateListLabels();
        int listParaCount = 1;
        
        for (Paragraph paragraph : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
            // Find if we have the paragraph list. In our document our list uses plain arabic numbers,
            // which start at three and ends at six
            if (paragraph.getListFormat().isListItem()) {
                System.out.println(MessageFormat.format("List item paragraph #{0}", listParaCount));
        
                // This is the text we get when actually getting when we output this node to text format
                // The list labels are not included in this text output. Trim any paragraph formatting characters
                String paragraphText = paragraph.toString(SaveFormat.TEXT).trim();
                System.out.println("Exported Text: " + paragraphText);
        
                ListLabel label = paragraph.getListLabel();
                // This gets the position of the paragraph in current level of the list. If we have a list with multiple level then this
                // will tell us what position it is on that particular level
                System.out.println("\tNumerical Id: " + label.getLabelValue());
        
                // Combine them together to include the list label with the text in the output
                System.out.println("\tList label combined with text: " + label.getLabelString() + " " + paragraphText);
        
                listParaCount++;
            }
        }

        Example:

        Exports the content of a node to String in HTML format.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When we call the ToString method using the html SaveFormat overload,
        // it converts the node's contents to their raw html representation.
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(SaveFormat.HTML));
        
        // We can also modify the result of this conversion using a SaveOptions object.
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setExportRelativeFontSize(true);
        
        Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
                "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
                "</p>", node.toString(saveOptions));

        Example:

        Shows the difference between calling the GetText and ToString methods on a node.
        Document doc = new Document();
        
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertField("MERGEFIELD Field");
        
        // GetText will retrieve the visible text as well as field codes and special characters.
        Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());
        
        // ToString will give us the document's appearance if saved to a passed save format.
        Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));