com.aspose.words
Class DocumentBase

java.lang.Object
  Node
      CompositeNode
          com.aspose.words.DocumentBase

All Implemented Interfaces:

java.lang.Iterable, java.lang.Cloneable, java.lang.Iterable

Direct Known Subclasses:

Document, GlossaryDocument

public abstract class DocumentBase 
extends CompositeNode

See Also:

Document, DocumentBase

public FontInfoCollection getFontInfos()

Provides access to properties of fonts used in this document.

This collection of font definitions is loaded as is from the document. Font definitions might be optional, missing or incomplete in some documents.

Do not rely on this collection to ascertain that a particular font is used in the document. You should only use this collection to get information about fonts that might be used in the document.

See Also:

FontInfoCollection, FontInfo

public StyleCollection getStyles()

Returns a collection of styles defined in the document.

For more information see the description of the StyleCollection class.

Example:

Shows how to get access to the collection of styles defined in the document.

Document doc = new Document();
StyleCollection styles = doc.getStyles();

for (Style style : styles)
    System.out.println(style.getName());

Example:

Shows how to create and use a paragraph style with list formatting.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create a paragraph style and specify some formatting for it.
Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1");
style.getFont().setSize(24);
style.getFont().setName("Verdana");
style.getParagraphFormat().setSpaceAfter(12);

// Create a list and make sure the paragraphs that use this style will use this list.
style.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DEFAULT));
style.getListFormat().setListLevelNumber(0);

// Apply the paragraph style to the current paragraph in the document and add some text.
builder.getParagraphFormat().setStyle(style);
builder.writeln("Hello World: MyStyle1, bulleted.");

// Change to a paragraph style that has no list formatting.
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
builder.writeln("Hello World: Normal.");

builder.getDocument().save(getMyDir() + "Lists.ParagraphStyleBulleted Out.doc");

See Also:

StyleCollection, Style

public ListCollection getLists()

Provides access to the list formatting used in the document.

For more information see the description of the ListCollection class.

Example:

Shows how to specify list level number when building a list using DocumentBuilder.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create a numbered list based on one of the Microsoft Word list templates and
// apply it to the current paragraph in the document builder.
builder.getListFormat().setList(doc.getLists().add(ListTemplate.NUMBER_ARABIC_DOT));

// There are 9 levels in this list, lets try them all.
for (int i = 0; i < 9; i++)
{
    builder.getListFormat().setListLevelNumber(i);
    builder.writeln("Level " + i);
}


// Create a bulleted list based on one of the Microsoft Word list templates
// and apply it to the current paragraph in the document builder.
builder.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DIAMONDS));

// There are 9 levels in this list, lets try them all.
for (int i = 0; i < 9; i++)
{
    builder.getListFormat().setListLevelNumber(i);
    builder.writeln("Level " + i);
}

// This is a way to stop list formatting.
builder.getListFormat().setList(null);

builder.getDocument().save(getMyDir() + "Lists.SpecifyListLevel Out.doc");

See Also:

ListCollection, List, ListFormat

public boolean isComposite()

Returns true as this node can have child nodes.

public boolean hasChildNodes()

Returns true if this node has any child nodes.

public NodeCollection getChildNodes()

Gets all immediate child nodes of this node.

Note, ChildNodes is equivalent to calling 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<Node> children = paragraph.getChildNodes();
for (Node child : 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());
    }
}

public Node getFirstChild()

Gets the first child of the node.

If there is no first child node, a null is returned.

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.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);
}

/// <summary>
/// A simple function that will walk through all children of a specified node recursively
/// and print the type of each node to the screen.
/// </summary>
private void traverseAllNodes(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(childNode.getNodeType());

        // Recurse into the node if it is a composite node.
        if (childNode.isComposite())
            traverseAllNodes((CompositeNode)childNode);
    }
}

public Node getLastChild()

Gets the last child of the node.

If there is no last child node, a null is returned.

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);

public int getCount()

Gets the number of immediate children of this node.

public abstract int getNodeType()

Gets the type of this node. The value of the property is NodeType integer constant.

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.getNodeType());
}

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;
}

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 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.
Assert.assertEquals(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.
Assert.assertNull(para.getParentNode());

// But the paragraph node knows its document.
Assert.assertEquals(doc, para.getDocument());

// 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 paragaph to the main text of the first section.
doc.getFirstSection().getBody().appendChild(para);

// The paragraph node is now a child of the Body node.
Assert.assertNotNull(para.getParentNode());

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 yed 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.
Assert.assertNull(para.getParentNode());

// But the paragraph node knows its document.
Assert.assertEquals(doc, para.getDocument());

// 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 paragaph to the main text of the first section.
doc.getFirstSection().getBody().appendChild(para);

// The paragraph node is now a child of the Body node.
Assert.assertNotNull(para.getParentNode());

public Node getPreviousSibling()

Gets the node immediately preceding this node.

If there is no preceding node, a null is returned.

Note: Calculating the value of this property iterates from the first child node of ParenNode to this node.

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);

public Node getNextSibling()

Gets the node immediately following this node.

If there is no next node, a null is returned.

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.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);
}

/// <summary>
/// A simple function that will walk through all children of a specified node recursively
/// and print the type of each node to the screen.
/// </summary>
private void traverseAllNodes(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(childNode.getNodeType());

        // Recurse into the node if it is a composite node.
        if (childNode.isComposite())
            traverseAllNodes((CompositeNode)childNode);
    }
}

public Range getRange()

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

public Node deepClone(boolean isCloneChildren)
              throws java.lang.Exception

Creates a duplicate of the document.

If you need to generate many documents from a single document, just load the document into memory once, clone it and populate the cloned document with your data. This speeds up generation of documents because there is no need to load and parse the document from file every time.

Parameters:

isCloneChildren - True to recursively clone the content of the document; false to clone only the document node and document-wide objects such as styles and lists.

Returns:

The cloned document.

public Node importNode(Node srcNode, boolean isImportChildren)
               throws java.lang.Exception

Imports a node from another document to the current document.

This method uses the ImportFormatMode.USE_DESTINATION_STYLES option to resolve formatting.

Importing a node creates a copy of the source node belonging to the importing document. The returned node has no parent. The source node is not altered or removed from the original document.

Before a node from another document can be inserted into this document, it must be imported. During import, document-specific properties such as references to styles and lists are translated from the original to the importing document. After the node was imported, it can be inserted into the appropriate place in the document using insertBefore(com.aspose.words.Node, com.aspose.words.Node) or insertAfter(com.aspose.words.Node, com.aspose.words.Node).

If the source node already belongs to the destination document, then simply a deep clone of the source node is created.

Parameters:

srcNode - The node being imported.

isImportChildren - True to import all child nodes recursively; otherwise, false.

Returns:

The cloned node that belongs to the current document.

See Also:

NodeImporter

public Node importNode(Node srcNode, boolean isImportChildren, int importFormatMode)
               throws java.lang.Exception

Imports a node from another document to the current document with an option to control formatting.

This overload is useful to control how styles and list formatting are imported.

Importing a node creates a copy of the source node belonging to the importing document. The returned node has no parent. The source node is not altered or removed from the original document.

Before a node from another document can be inserted into this document, it must be imported. During import, document-specific properties such as references to styles and lists are translated from the original to the importing document. After the node was imported, it can be inserted into the appropriate place in the document using insertBefore(com.aspose.words.Node, com.aspose.words.Node) or insertAfter(com.aspose.words.Node, com.aspose.words.Node).

If the source node already belongs to the destination document, then simply a deep clone of the source node is created.

Parameters:

srcNode - The node to imported.

isImportChildren - True to import all child nodes recursively; otherwise, false.

importFormatMode - A ImportFormatMode value. Specifies how to merge style formatting that clashes.

Returns:

The cloned, imported node. The node belongs to the destination document, but has no parent.

See Also:

ImportFormatMode, NodeImporter

Example:

Combines two documents into one.

public void combineDocuments() throws Exception
{
    // Open the destination document.
    Document dstDoc = new Document(getMyDir() + "Section.CombineDocuments1.doc");

    // Open the source document.
    Document srcDoc = new Document(getMyDir() + "Section.CombineDocuments2.doc");

    // For a twist, let's say I want the second document to start on the same page where
    // the first document ends. This is controlled by a property of the first section.
    srcDoc.getFirstSection().getPageSetup().setSectionStart(SectionStart.CONTINUOUS);

    // Combine the documents, see the function below.
    appendDoc(dstDoc, srcDoc);

    // Save the finished document.
    dstDoc.save(getMyDir() + "Section.CombineDocuments Out.doc");
}

/// <summary>
/// A useful function that you can use to easily append one document to another.
/// </summary>
/// <param name="dstDoc">The destination document where to append to.</param>
/// <param name="srcDoc">The source document.</param>
private void appendDoc(Document dstDoc, Document srcDoc) throws Exception
{
    // Loop through all sections in the source document.
    // Section nodes are immediate children of the Document node so we can just enumerate the Document.
    for (Section srcSection : srcDoc.getSections())
    {
        // Because we are copying a section from one document to another,
        // it is required to import the Section node into the destination document.
        // This adjusts any document-specific references to styles, lists, etc.
        //
        // Importing a node creates a copy of the original node, but the copy
        // is ready to be inserted into the destination document.
        Node dstSection = dstDoc.importNode(srcSection, true, ImportFormatMode.KEEP_SOURCE_FORMATTING);

        // Now the new section node can be appended to the destination document.
        dstDoc.appendChild(dstSection);
    }
}

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.

public NodeCollection getChildNodes(int nodeType, boolean isDeep)

Returns a live collection of child nodes that match the specified type.

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.

Parameters:

nodeType - A NodeType value. Specifies the type of nodes to select.

isDeep - True to select from all child nodes recursively. False to select only among immediate children.

Returns:

A live collection of child nodes of the specified type.

public NodeCollection getChildNodes(int nodeType, boolean isDeep, boolean isLive)

Returns a "live" or "snapshot" collection of child node that match the specified type.

Snapshot collections require less resources than live collections because a snapshot collection of nodes is not updated when the document is changed.

Snapshot collections are useful for tasks, that do not require immediate update of the collection when the document is changed. For example, select all shapes and delete them is more efficient using a snapshot collection.

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.

Parameters:

nodeType - A NodeType value. Specifies the type of nodes to select.

isDeep - True to select from all child nodes recursively. False to select only among immediate children.

isLive - True to return a live collection; false to return a snapshot collection.

Returns:

A collection of child nodes of the specified type.

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<Shape> shapes = doc.getChildNodes(NodeType.SHAPE, true, false);
    int imageIndex = 0;
    for(Shape shape :  shapes)
    {
        if (shape.hasImage())
        {
            String extension = imageTypeToExtension(shape.getImageData().getImageType());
            String imageFileName = MessageFormat.format("Image.ExportImages.{0} Out.{1}", imageIndex, extension);
            shape.getImageData().save(getMyDir() + imageFileName);
            imageIndex++;

        }
    }
}

private static String imageTypeToExtension(int imageType) throws Exception
{
    switch (imageType)
    {
        case ImageType.BMP:
            return "bmp";
        case ImageType.EMF:
            return "emf";
        case ImageType.JPEG:
            return "jpeg";
        case ImageType.PICT:
            return "pict";
        case ImageType.PNG:
            return "png";
        case ImageType.WMF:
            return "wmf";
        default:
            throw new Exception("Unknown image type.");
    }
}

public Node getChild(int nodeType, int index, boolean isDeep)

Returns an Nth child node that matches the specified type.

If index is out of range, a null is returned.

Parameters:

nodeType - A NodeType value. Specifies the type of the child node.

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.

Returns:

The child node that matches the criteria or null if no matching node is found.

public NodeList selectNodes(java.lang.String xpath)

Selects a list of nodes matching the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:

xpath - The XPath expression.

Returns:

A list of nodes matching the XPath query.

Example:

Finds all hyperlinks in a Word document and changes their URL and display name.

import com.aspose.words.*;
import java.lang.Exception;
import java.text.MessageFormat;
import java.util.regex.Pattern;
import java.util.regex.Matcher;

/// <summary>
/// Shows how to replace hyperlinks in a Word document.
/// </summary>
public class ExReplaceHyperlinks extends ExBase
{
    /// <summary>
    /// Finds all hyperlinks in a Word document and changes their URL and display name.
    /// </summary>
    public void replaceHyperlinks() throws Exception
    {
        // Specify your document name here.
        Document doc = new Document(getMyDir() + "ReplaceHyperlinks.doc");

        // Hyperlinks in a Word documents are fields, select all field start nodes so we can find the hyperlinks.
        NodeList fieldStarts = doc.selectNodes("//FieldStart");
        for (Node fieldStartNode : fieldStarts)
        {
            FieldStart fieldStart = (FieldStart) fieldStartNode;
            if (fieldStart.getFieldType() == FieldType.FIELD_HYPERLINK)
            {
                // The field is a hyperlink field, use the "facade" class to help to deal with the field.
                Hyperlink hyperlink = new Hyperlink(fieldStart);

                // Some hyperlinks can be local (links to bookmarks inside the document), ignore these.
                if (hyperlink.isLocal())
                    continue;

                // The Hyperlink class allows to set the target URL and the display name
                // of the link easily by setting the properties.
                hyperlink.setTarget(NewUrl);
                hyperlink.setName(NewName);
            }
        }

        doc.save(getMyDir() + "ReplaceHyperlinks Out.doc");
    }

    private final String NewUrl = "http://www.aspose.com";
    private final String NewName = "Aspose - The .NET & Java Component Publisher";
}

/// <summary>
/// This "facade" class makes it easier to work with a hyperlink field in a Word document.
///
/// A hyperlink is represented by a HYPERLINK field in a Word document. A field in Aspose.Words
/// consists of several nodes and it might be difficult to work with all those nodes directly.
/// Note this is a simple implementation and will work only if the hyperlink code and name
/// each consist of one Run only.
///
/// [FieldStart][Run - field code][FieldSeparator][Run - field result][FieldEnd]
///
/// The field code contains a string in one of these formats:
/// HYPERLINK "url"
/// HYPERLINK \l "bookmark name"
///
/// The field result contains text that is displayed to the user.
/// </summary>
class Hyperlink
{
    Hyperlink(FieldStart fieldStart) throws Exception
    {
        if (fieldStart == null)
            throw new Exception("Argument 'fieldStart' is null");
        if (fieldStart.getFieldType() != FieldType.FIELD_HYPERLINK)
            throw new Exception("Field start type must be FieldHyperlink.");

        mFieldStart = fieldStart;

        // Find the field separator node.
        mFieldSeparator = findNextSibling(mFieldStart, NodeType.FIELD_SEPARATOR);
        if (mFieldSeparator == null)
            throw new Exception("Cannot find field separator.");

        // Find the field end node. Normally field end will always be found, but in the example document
        // there happens to be a paragraph break included in the hyperlink and this puts the field end
        // in the next paragraph. It will be much more complicated to handle fields which span several
        // paragraphs correctly, but in this case allowing field end to be null is enough for our purposes.
        mFieldEnd = findNextSibling(mFieldSeparator, NodeType.FIELD_END);

        // Field code looks something like [ HYPERLINK "http:\\www.myurl.com" ], but it can consist of several runs.
        String fieldCode = getTextSameParent(mFieldStart.getNextSibling(), mFieldSeparator);
        Matcher match = gRegex.matcher(fieldCode.trim());
        if (match.matches())
        {
            mIsLocal = match.group(1) != null;    //The link is local if \l is present in the field code.
            mTarget = match.group(2);
        }
    }

    /// <summary>
    /// Gets or sets the display name of the hyperlink.
    /// </summary>
    public String getName() throws Exception
    {
        return getTextSameParent(mFieldSeparator, mFieldEnd);
    }

    public void setName(String value) throws Exception
    {
        // Hyperlink display name is stored in the field result which is a Run
        // node between field separator and field end.
        Run fieldResult = (Run)mFieldSeparator.getNextSibling();
        fieldResult.setText(value);

        // But sometimes the field result can consist of more than one run, delete these runs.
        removeSameParent(fieldResult.getNextSibling(), mFieldEnd);
    }

    /// <summary>
    /// Gets or sets the target url or bookmark name of the hyperlink.
    /// </summary>
    public String getTarget()
    {
        return mTarget;
    }

    public void setTarget(String value) throws Exception
    {
        mTarget = value;
        updateFieldCode();
    }

    /// <summary>
    /// True if the hyperlink's target is a bookmark inside the document. False if the hyperlink is a url.
    /// </summary>
    public boolean isLocal()
    {
        return mIsLocal;
    }

    public void isLocal(boolean value) throws Exception
    {
        mIsLocal = value;
        updateFieldCode();
    }

    private void updateFieldCode() throws Exception
    {
        // Field code is stored in a Run node between field start and field separator.
        Run fieldCode = (Run)mFieldStart.getNextSibling();
        fieldCode.setText(MessageFormat.format("HYPERLINK {0}\"{1}\"", ((mIsLocal) ? "\\l " : ""), mTarget));

        // But sometimes the field code can consist of more than one run, delete these runs.
        removeSameParent(fieldCode.getNextSibling(), mFieldSeparator);
    }

    /// <summary>
    /// Goes through siblings starting from the start node until it finds a node of the specified type or null.
    /// </summary>
    private static Node findNextSibling(Node startNode, int nodeType)
    {
        for (Node node = startNode; node != null; node = node.getNextSibling())
        {
            if (node.getNodeType() == nodeType)
                return node;
        }
        return null;
    }

    /// <summary>
    /// Retrieves text from start up to but not including the end node.
    /// </summary>
    private static String getTextSameParent(Node startNode, Node endNode) throws Exception
    {
        if ((endNode != null) && (startNode.getParentNode() != endNode.getParentNode()))
            throw new Exception("Start and end nodes are expected to have the same parent.");

        StringBuilder builder = new StringBuilder();
        for (Node child = startNode; child != endNode; child = child.getNextSibling())
            builder.append(child.getText());
        
        return builder.toString();
    }

    /// <summary>
    /// Removes nodes from start up to but not including the end node.
    /// Start and end are assumed to have the same parent.
    /// </summary>
    private static void removeSameParent(Node startNode, Node endNode) throws Exception
    {
        if ((endNode != null) && (startNode.getParentNode() != endNode.getParentNode()))
            throw new Exception("Start and end nodes are expected to have the same parent.");

        Node curChild = startNode;
        while ((curChild != null) && (curChild != endNode))
        {
            Node nextChild = curChild.getNextSibling();
            curChild.remove();
            curChild = nextChild;
        }
    }

    private final Node mFieldStart;
    private final Node mFieldSeparator;
    private final Node mFieldEnd;
    private boolean mIsLocal;
    private String mTarget;

    /// <summary>
    /// RK I am notoriously bad at regexes. It seems I don't understand their way of thinking.
    /// </summary>
    private static Pattern gRegex = Pattern.compile(
        "\\S+" +            // one or more non spaces HYPERLINK or other word in other languages
        "\\s+" +            // one or more spaces
        "(?:\"\"\\s+)?" +    // non capturing optional "" and one or more spaces, found in one of the customers files.
        "(\\\\l\\s+)?" +    // optional \l flag followed by one or more spaces
        "\"" +                // one apostrophe
        "([^\"]+)" +        // one or more chars except apostrophe (hyperlink target)
        "\""                // one closing apostrophe
        );
}

public Node selectSingleNode(java.lang.String xpath)

Selects the first Node that matches the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:

xpath - The XPath expression.

Returns:

The first Node that matches the XPath query or null if no matching node is found.

public java.util.Iterator iterator()

Provides support for the for each style iteration over the child nodes of this node.

Example:

Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.

NodeCollection<Node> children = paragraph.getChildNodes();
for (Node child : 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());
    }
}

public Node appendChild(Node newChild)
                throws java.lang.Exception

Adds the specified node to the end of the list of child nodes for this node.

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 importNode(com.aspose.words.Node, boolean, int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:

newChild - The node to add.

Returns:

The node added.

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 pararagraph 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 \u000c is automatically appended. \u000c is the end of section character.
Assert.assertEquals("Hello World!\u000c", doc.getText());

// Save the document.
doc.save(getMyDir() + "Section.CreateFromScratch Out.doc");

public Node prependChild(Node newChild)
                 throws java.lang.Exception

Adds the specified node to the beginning of the list of child nodes for this node.

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 importNode(com.aspose.words.Node, boolean, int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:

newChild - The node to add.

Returns:

The node added.

public Node insertAfter(Node newChild, Node refChild)
                throws java.lang.Exception

Inserts the specified node immediately after the specified reference node.

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 importNode(com.aspose.words.Node, boolean, int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:

newChild - The Node to insert.

refChild - The Node that is the reference node. The newNode is placed after the refNode.

Returns:

The inserted node.

public Node insertBefore(Node newChild, Node refChild)
                 throws java.lang.Exception

Inserts the specified node immediately before the specified reference node.

If refChild is null, inserts newChild at the end of the list of child nodes.

Note: InsertBefore could be slower than InsertAfter because it needs to iterate over all nodes from the first child to the reference node.

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 importNode(com.aspose.words.Node, boolean, int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:

newChild - The Node to insert.

refChild - The Node that is the reference node. The newChild is placed before this node.

Returns:

The inserted node.

public Node removeChild(Node oldChild)
                throws java.lang.Exception

Removes the specified child node.

The parent of oldChild is set to null after the node is removed.

Parameters:

oldChild - The node to remove.

Returns:

The removed node.

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);

public void removeAllChildren()
                      throws java.lang.Exception

Removes all the child nodes of the current node.

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 pararagraph 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 \u000c is automatically appended. \u000c is the end of section character.
Assert.assertEquals("Hello World!\u000c", doc.getText());

// Save the document.
doc.save(getMyDir() + "Section.CreateFromScratch Out.doc");

public int indexOf(Node child)

Returns the index of the specified child node in the child node array.

Returns -1 if the node is not found in the child nodes.

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

Accepts a visitor.

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.

Parameters:

visitor - The visitor that will visit the nodes.

Returns:

True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

public Node 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.

public Node 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.

public void remove()
           throws java.lang.Exception

Removes itself from the parent.

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;
}

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.

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.canHaveImage())
            shape.remove();
    }

    curNode = nextNode;
}

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.

public java.lang.String toTxt()
            throws java.lang.Exception

Exports the content of the node into a string in plain text format.

This method removes field codes and Microsoft Word control characters, uses CrLf (or any other) combination of characters to mark ends of paragraphs in the resulting string. It produces a different result from getText() which just gets the text from the node without removing field codes or special characters.

Returns:

The content of the node in plain text format.

See Also:

SaveOptions.TxtExportParagraphBreak, SaveOptions.TxtExportHeadersFooters

public void addNodeChangedEventHandler(NodeChangedEventHandler newListener)

Adds the NodeChangedEventHandler to the list of subscribed listeners of one of Node Changed event.

public void removeNodeChangedEventHandler(NodeChangedEventHandler oldListener)

Removes the NodeChangedEventHandler from the list of subscribed listeners of Node Changed event.