com.aspose.words

  • All Implemented Interfaces:
    java.lang.Iterable, java.lang.Cloneable
    public class Shape 
    extends ShapeBase

Represents an object in the drawing layer, such as an AutoShape, textbox, freeform, OLE object, ActiveX control, or picture.

Using the Shape class you can create or modify shapes in a Microsoft Word document.

An important property of a shape is its ShapeType. Shapes of different types can have different capabilities in a Word document. For example, only image and OLE shapes can have images inside them. Most of the shapes can have text, but not all.

Shapes that can have text, can contain Paragraph and Table nodes as children.

Example:

Shows how to delete all shapes from a document.
// Here we get all shapes from the document node, but you can do this for any smaller
// node too, for example delete shapes from a single section or a paragraph.
NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
shapes.clear();

// There could also be group shapes, they have different node type, remove them all too.
NodeCollection groupShapes = doc.getChildNodes(NodeType.GROUP_SHAPE, true);
groupShapes.clear();

Example:

Shows how to extract images from a document and save them as files.
public void extractImagesToFiles() throws Exception
{
    Document doc = new Document(getMyDir() + "Image.SampleImages.doc");

    NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
    int imageIndex = 0;
    for (Shape shape : (Iterable<Shape>) shapes)
    {
        if (shape.hasImage())
        {
            String imageFileName = java.text.MessageFormat.format("\\Artifacts\\Image.ExportImages.{0} Out{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
            shape.getImageData().save(getMyDir() + imageFileName);
            imageIndex++;
        }
    }
}

Example:

Shows how to insert a floating image in the middle of a page.
// This creates a builder and also an empty document inside the builder.
DocumentBuilder builder = new DocumentBuilder();

// By default, the image is inline.
Shape shape = builder.insertImage(getMyDir() + "\\Images\\Aspose.Words.gif");

// Make the image float, put it behind text and center on the page.
shape.setWrapType(WrapType.NONE);
shape.setBehindText(true);
shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
shape.setHorizontalAlignment(HorizontalAlignment.CENTER);
shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
shape.setVerticalAlignment(VerticalAlignment.CENTER);

builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPageCenter.doc");
See Also:
ShapeBase, GroupShape

Constructor Summary
Shape(DocumentBase doc, intshapeType)
Creates a new shape object.
 
Property Getters/Setters Summary
booleangetAllowOverlap()
void
setAllowOverlap(booleanvalue)
           Gets or sets a value that specifies whether this shape can overlap other shapes.
java.lang.StringgetAlternativeText()
void
setAlternativeText(java.lang.Stringvalue)
           Defines alternative text to be displayed instead of a graphic.
booleangetAnchorLocked()
void
setAnchorLocked(booleanvalue)
           Specifies whether the shape's anchor is locked.
booleangetAspectRatioLocked()
void
setAspectRatioLocked(booleanvalue)
           Specifies whether the shape's aspect ratio is locked.
booleangetBehindText()
void
setBehindText(booleanvalue)
           Specifies whether the shape is below or above text.
doublegetBottom()
Gets the position of the bottom edge of the containing block of the shape.
java.awt.geom.Rectangle2D.FloatgetBounds()
void
setBounds(java.awt.geom.Rectangle2D.Floatvalue)
           Gets or sets the location and size of the containing block of the shape.
java.awt.geom.Rectangle2D.FloatgetBoundsInPoints()
Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape.
java.awt.geom.Rectangle2D.FloatgetBoundsWithEffects()
Gets final extent that this shape object has after applying drawing effects. Value is measured in points.
booleancanHaveImage()
Returns true if the shape type allows the shape to have an image.
ChartgetChart()
Provides access to the chart properties if this shape has a Chart.
NodeCollectiongetChildNodes()
Gets all immediate child nodes of this node.
java.awt.PointgetCoordOrigin()
void
setCoordOrigin(java.awt.Pointvalue)
           The coordinates at the top-left corner of the containing block of this shape.
java.awt.DimensiongetCoordSize()
void
setCoordSize(java.awt.Dimensionvalue)
           The width and height of the coordinate space inside the containing block of this shape.
intgetCount()
Gets the number of immediate children of this node.
doublegetDistanceBottom()
void
setDistanceBottom(doublevalue)
           Returns or sets the distance (in points) between the document text and the bottom edge of the shape.
doublegetDistanceLeft()
void
setDistanceLeft(doublevalue)
           Returns or sets the distance (in points) between the document text and the left edge of the shape.
doublegetDistanceRight()
void
setDistanceRight(doublevalue)
           Returns or sets the distance (in points) between the document text and the right edge of the shape.
doublegetDistanceTop()
void
setDistanceTop(doublevalue)
           Returns or sets the distance (in points) between the document text and the top edge of the shape.
DocumentBasegetDocument()
Gets the document to which this node belongs.
booleangetExtrusionEnabled()
Returns true if an extrusion effect is enabled.
FillgetFill()
Defines a fill for a shape.
java.awt.ColorgetFillColor()
void
setFillColor(java.awt.Colorvalue)
           Defines the brush color that fills the closed path of the shape.
booleangetFilled()
void
setFilled(booleanvalue)
           Determines whether the closed path of the shape will be filled.
NodegetFirstChild()
Gets the first child of the node.
ParagraphgetFirstParagraph()
Gets the first paragraph in the shape.
intgetFlipOrientation()
void
           Switches the orientation of a shape. The value of the property is FlipOrientation integer constant.
FontgetFont()
Provides access to the font formatting of this object.
booleanhasChart()
Returns true if this Shape has a Chart.
booleanhasChildNodes()
Returns true if this node has any child nodes.
booleanhasImage()
Returns true if the shape has image bytes or links an image.
doublegetHeight()
void
setHeight(doublevalue)
           Gets or sets the height of the containing block of the shape.
intgetHorizontalAlignment()
void
           Specifies how the shape is positioned horizontally. The value of the property is HorizontalAlignment integer constant.
java.lang.StringgetHRef()
void
setHRef(java.lang.Stringvalue)
           Gets or sets the full hyperlink address for a shape.
ImageDatagetImageData()
Provides access to the image of the shape. Returns null if the shape cannot have an image.
booleanisComposite()
Returns true as this node can have child nodes.
booleanisDeleteRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisGroup()
Returns true if this is a group shape.
booleanisHorizontalRule()
Returns true if this shape is a horizontal rule.
booleanisImage()
Returns true if this shape is an image shape.
booleanisInline()
A quick way to determine if this shape is positioned inline with text.
booleanisInsertRevision()
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
booleanisLayoutInCell()
void
isLayoutInCell(booleanvalue)
           Gets or sets a flag indicating whether the shape is displayed inside a table or outside of it.
booleanisMoveFromRevision()
Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
booleanisMoveToRevision()
Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
booleanisSignatureLine()
Indicates that shape is a SignatureLine.
booleanisTopLevel()
Returns true if this shape is not a child of a group shape.
booleanisWordArt()
Returns true if this shape is a WordArt object.
NodegetLastChild()
Gets the last child of the node.
ParagraphgetLastParagraph()
Gets the last paragraph in the shape.
doublegetLeft()
void
setLeft(doublevalue)
           Gets or sets the position of the left edge of the containing block of the shape.
bytegetMarkupLanguage()
Gets MarkupLanguage used for this graphic object. The value of the property is ShapeMarkupLanguage integer constant.
java.lang.StringgetName()
void
setName(java.lang.Stringvalue)
           Gets or sets the optional shape name.
NodegetNextSibling()
Gets the node immediately following this node.
intgetNodeType()
Returns NodeType.SHAPE. The value of the property is NodeType integer constant.
OleFormatgetOleFormat()
Provides access to the OLE data of a shape. For a shape that is not an OLE object or ActiveX control, returns null.
CompositeNodegetParentNode()
Gets the immediate parent of this node.
ParagraphgetParentParagraph()
Returns the immediate parent paragraph.
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.
intgetRelativeHorizontalPosition()
void
           Specifies relative to what the shape is positioned horizontally. The value of the property is RelativeHorizontalPosition integer constant.
intgetRelativeVerticalPosition()
void
           Specifies relative to what the shape is positioned vertically. The value of the property is RelativeVerticalPosition integer constant.
doublegetRight()
Gets the position of the right edge of the containing block of the shape.
doublegetRotation()
void
setRotation(doublevalue)
           Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle.
java.lang.StringgetScreenTip()
void
setScreenTip(java.lang.Stringvalue)
           Defines the text displayed when the mouse pointer moves over the shape.
booleangetShadowEnabled()
Returns true if a shadow effect is enabled.
intgetShapeType()
Gets the shape type. The value of the property is ShapeType integer constant.
SignatureLinegetSignatureLine()
Gets SignatureLine object if the shape is a signature line. Returns null otherwise.
java.awt.DimensiongetSizeInPoints()
Gets the size of the shape in points.
intgetStoryType()
Returns StoryType.TEXTBOX. The value of the property is StoryType integer constant.
StrokegetStroke()
Defines a stroke for a shape.
java.awt.ColorgetStrokeColor()
void
setStrokeColor(java.awt.Colorvalue)
           Defines the color of a stroke.
booleangetStroked()
void
setStroked(booleanvalue)
           Defines whether the path will be stroked.
doublegetStrokeWeight()
void
setStrokeWeight(doublevalue)
           Defines the brush thickness that strokes the path of a shape in points.
java.lang.StringgetTarget()
void
setTarget(java.lang.Stringvalue)
           Gets or sets the target frame for the shape hyperlink.
TextBoxgetTextBox()
Defines attributes that specify how text is displayed in a shape.
TextPathgetTextPath()
Defines the text of the text path (of a WordArt object).
java.lang.StringgetTitle()
void
setTitle(java.lang.Stringvalue)
           Gets or sets the title (caption) of the current shape object.
doublegetTop()
void
setTop(doublevalue)
           Gets or sets the position of the top edge of the containing block of the shape.
intgetVerticalAlignment()
void
           Specifies how the shape is positioned vertically. The value of the property is VerticalAlignment integer constant.
doublegetWidth()
void
setWidth(doublevalue)
           Gets or sets the width of the containing block of the shape.
intgetWrapSide()
void
setWrapSide(intvalue)
           Specifies how the text is wrapped around the shape. The value of the property is WrapSide integer constant.
intgetWrapType()
void
setWrapType(intvalue)
           Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape. The value of the property is WrapType integer constant.
intgetZOrder()
void
setZOrder(intvalue)
           Determines the display order of overlapping shapes.
 
Method Summary
booleanaccept(DocumentVisitor visitor)
Accepts a visitor.
java.awt.geom.Rectangle2D.FloatadjustWithEffects(java.awt.geom.Rectangle2D.Float source)
Adds to the source rectangle values of the effect extent and returns the final rectangle.
NodeappendChild(Node newChild)
Adds the specified node to the end of the list of child nodes for this node.
NodedeepClone(boolean isCloneChildren)
java.lang.ObjectfetchInheritedShapeAttr(int key)
Reserved for internal use.
java.lang.ObjectfetchShapeAttr(int key)
Reserved for internal use.
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.
NodegetChild(int nodeType, int index, boolean isDeep)
Returns an Nth child node that matches the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep)
Returns a live collection of child nodes that match the specified type.
java.lang.ObjectgetDirectShapeAttr(int key)
Reserved for internal use.
ShapeRenderergetShapeRenderer()
Creates and returns an object that can be used to render this shape into an image.
java.awt.geom.Point2D.FloatgetSizeInPoints()
Gets the size of the shape in points.
java.lang.StringgetText()
Gets the text of this node and of all its children.
intindexOf(Node child)
Returns the index of the specified child node in the child node array.
NodeinsertAfter(Node newChild, Node refChild)
Inserts the specified node immediately after the specified reference node.
NodeinsertBefore(Node newChild, Node refChild)
Inserts the specified node immediately before the specified reference node.
java.util.Iterator<Node>iterator()
Provides support for the for each style iteration over the child nodes of this node.
java.awt.geom.Point2D.FloatlocalToParent(java.awt.geom.Point2D.Float value)
Converts a value from the local coordinate space into the coordinate space of the parent shape.
NodenextPreOrder(Node rootNode)
Gets next node according to the pre-order tree traversal algorithm.
NodeprependChild(Node newChild)
Adds the specified node to the beginning of the list of child nodes for this node.
NodepreviousPreOrder(Node rootNode)
Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()
Removes itself from the parent.
voidremoveAllChildren()
Removes all the child nodes of the current node.
NoderemoveChild(Node oldChild)
Removes the specified child node.
voidremoveShapeAttr(int key)
Reserved for internal use.
voidremoveSmartTags()
Removes all SmartTag descendant nodes of the current node.
NodeListselectNodes(java.lang.String xpath)
Selects a list of nodes matching the XPath expression.
NodeselectSingleNode(java.lang.String xpath)
Selects the first Node that matches the XPath expression.
voidsetShapeAttr(int key, java.lang.Object value)
Reserved for internal use.
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.
 

    • Constructor Detail

      • Shape

        public Shape(DocumentBase doc, int shapeType)
        Creates a new shape object.

        You should specify desired shape properties after you created a shape.

        Parameters:
        doc - The owner document.
        shapeType - A ShapeType value. The type of the shape to create.

        Example:

        Creates a textbox with some text and different formatting options in a new document.
        // Create a blank document.
        Document doc = new Document();
        
        // Create a new shape of type TextBox
        Shape textBox = new Shape(doc, ShapeType.TEXT_BOX);
        
        // Set some settings of the textbox itself.
        // Set the wrap of the textbox to inline
        textBox.setWrapType(WrapType.NONE);
        // Set the horizontal and vertical alignment of the text inside the shape.
        textBox.setHorizontalAlignment(HorizontalAlignment.CENTER);
        textBox.setVerticalAlignment(VerticalAlignment.TOP);
        
        // Set the textbox height and width.
        textBox.setHeight(50);
        textBox.setWidth(200);
        
        // Set the textbox in front of other shapes with a lower ZOrder
        textBox.setZOrder(2);
        
        // Let's create a new paragraph for the textbox manually and align it in the center. Make sure we add the new nodes to the textbox as well.
        textBox.appendChild(new Paragraph(doc));
        Paragraph para = textBox.getFirstParagraph();
        para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        
        // Add some text to the paragraph.
        Run run = new Run(doc);
        run.setText("Content in textbox");
        para.appendChild(run);
        
        // Append the textbox to the first paragraph in the body.
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(textBox);
        
        // Save the output
        doc.save(getMyDir() + "\\Artifacts\\Shape.CreateTextBox.doc");

        Example:

        Shows how to create and add an image to a document without using document builder.
        Document doc = new Document();
        
        Shape shape = new Shape(doc, ShapeType.IMAGE);
        shape.getImageData().setImage(getMyDir() + "\\Images\\Hammer.wmf");
        shape.setWidth(100);
        shape.setHeight(100);
        
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(shape);
        
        doc.save(getMyDir() + "\\Artifacts\\Image.CreateImageDirectly.doc");
    • Property Getters/Setters Detail

      • getAllowOverlap/setAllowOverlap

        public boolean getAllowOverlap() / public void setAllowOverlap(boolean value)
        
        Gets or sets a value that specifies whether this shape can overlap other shapes.

        This property affects behavior of the shape in Microsoft Word. Aspose.Words ignores the value of this property.

        This property is applicable only to top level shapes.

        The default value is true.

      • getAlternativeText/setAlternativeText

        public java.lang.String getAlternativeText() / public void setAlternativeText(java.lang.String value)
        
        Defines alternative text to be displayed instead of a graphic.

        The default value is an empty string.

      • getAnchorLocked/setAnchorLocked

        public boolean getAnchorLocked() / public void setAnchorLocked(boolean value)
        
        Specifies whether the shape's anchor is locked.

        The default value is false.

        Has effect only for top level shapes.

        This property affects behavior of the shape's anchor in Microsoft Word. When the anchor is not locked, moving the shape in Microsoft Word can move the shape's anchor too.

      • getAspectRatioLocked/setAspectRatioLocked

        public boolean getAspectRatioLocked() / public void setAspectRatioLocked(boolean value)
        
        Specifies whether the shape's aspect ratio is locked.

        The default value depends on the ShapeType, for the ShapeType.Image it is true but for the other shape types it is false.

        Has effect for top level shapes only.

        Example:

        Shows how to set "AspectRatioLocked" for the shape object
        Document doc = new Document(getMyDir() + "Shape.ActiveXObject.docx");
        
        // Get shape object from the document and set AspectRatioLocked(it is possible to get/set AspectRatioLocked for child shapes (mimic MS Word behavior), 
        // but AspectRatioLocked has effect only for top level shapes!)
        Shape shape = (Shape) doc.getChild(NodeType.SHAPE, 0, true);
        shape.setAspectRatioLocked(isLocked);
      • getBehindText/setBehindText

        public boolean getBehindText() / public void setBehindText(boolean value)
        
        Specifies whether the shape is below or above text.

        Has effect only for top level shapes.

        The default value is false.

        Example:

        Shows how to insert a floating image in the middle of a page.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inline.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Aspose.Words.gif");
        
        // Make the image float, put it behind text and center on the page.
        shape.setWrapType(WrapType.NONE);
        shape.setBehindText(true);
        shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        shape.setHorizontalAlignment(HorizontalAlignment.CENTER);
        shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        shape.setVerticalAlignment(VerticalAlignment.CENTER);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPageCenter.doc");
        See Also:
        ZOrder
      • getBottom

        public double getBottom()
        
        Gets the position of the bottom edge of the containing block of the shape.

        For a top-level shape, the value is in points and relative to the shape anchor.

        For shapes in a group, the value is in the coordinate space and units of the parent group.

      • getBounds/setBounds

        public java.awt.geom.Rectangle2D.Float getBounds() / public void setBounds(java.awt.geom.Rectangle2D.Float value)
        
        Gets or sets the location and size of the containing block of the shape. Ignores aspect ratio lock upon setting.

        For a top-level shape, the value is in points and relative to the shape anchor.

        For shapes in a group, the value is in the coordinate space and units of the parent group.

        Example:

        Creates two line shapes. One line goes from top left to bottom right. Another line goes from bottom left to top right.
        Document doc = new Document();
        
        // The lines will cross the whole page.
        float pageWidth = (float) doc.getFirstSection().getPageSetup().getPageWidth();
        float pageHeight = (float) doc.getFirstSection().getPageSetup().getPageHeight();
        
        // This line goes from top left to bottom right by default.
        Shape lineA = new Shape(doc, ShapeType.LINE);
        lineA.setBounds(new Rectangle2D.Float(0, 0, pageWidth, pageHeight));
        lineA.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        lineA.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(lineA);
        
        // This line goes from bottom left to top right because we flipped it.
        Shape lineB = new Shape(doc, ShapeType.LINE);
        lineB.setBounds(new Rectangle2D.Float(0, 0, pageWidth, pageHeight));
        lineB.setFlipOrientation(FlipOrientation.HORIZONTAL);
        lineB.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        lineB.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(lineB);
        
        doc.save(getMyDir() + "\\Artifacts\\Shape.LineFlipOrientation.doc");
      • getBoundsInPoints

        public java.awt.geom.Rectangle2D.Float getBoundsInPoints()
        
        Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape.
      • getBoundsWithEffects

        public java.awt.geom.Rectangle2D.Float getBoundsWithEffects()
        
        Gets final extent that this shape object has after applying drawing effects. Value is measured in points.
      • canHaveImage

        public boolean canHaveImage()
        
        Returns true if the shape type allows the shape to have an image.

        Although Microsoft Word has a special shape type for images, it appears that in Microsoft Word documents any shape except a group shape can have an image, therefore this property returns true for all shapes except GroupShape.

      • getChart

        public Chart getChart()
        
        Provides access to the chart properties if this shape has a Chart. This property will return the Chart object only if HasChart property is true for this Shape, and will throw an exception otherwise.
      • getChildNodes

        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 children = paragraph.getChildNodes();
        for (Node child : (Iterable<Node>) children)
        {
            // Paragraph may contain children of various types such as runs, shapes and so on.
            if (child.getNodeType() == NodeType.RUN)
            {
                // Say we found the node that we want, do something useful.
                Run run = (Run) child;
                System.out.println(run.getText());
            }
        }
      • getCoordOrigin/setCoordOrigin

        public java.awt.Point getCoordOrigin() / public void setCoordOrigin(java.awt.Point value)
        
        The coordinates at the top-left corner of the containing block of this shape.

        The default value is (0,0).

      • getCoordSize/setCoordSize

        public java.awt.Dimension getCoordSize() / public void setCoordSize(java.awt.Dimension value)
        
        The width and height of the coordinate space inside the containing block of this shape.

        The default value is (1000, 1000).

      • getCount

        public int getCount()
        
        Gets the number of immediate children of this node.
      • getDistanceBottom/setDistanceBottom

        public double getDistanceBottom() / public void setDistanceBottom(double value)
        
        Returns or sets the distance (in points) between the document text and the bottom edge of the shape.

        The default value is 0.

        Has effect only for top level shapes.

      • getDistanceLeft/setDistanceLeft

        public double getDistanceLeft() / public void setDistanceLeft(double value)
        
        Returns or sets the distance (in points) between the document text and the left edge of the shape.

        The default value is 1/8 inch.

        Has effect only for top level shapes.

      • getDistanceRight/setDistanceRight

        public double getDistanceRight() / public void setDistanceRight(double value)
        
        Returns or sets the distance (in points) between the document text and the right edge of the shape.

        The default value is 1/8 inch.

        Has effect only for top level shapes.

      • getDistanceTop/setDistanceTop

        public double getDistanceTop() / public void setDistanceTop(double value)
        
        Returns or sets the distance (in points) between the document text and the top edge of the shape.

        The default value is 0.

        Has effect only for top level shapes.

      • 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 that when you create any node, it requires a document that will own the node.
        // Open a file from disk.
        Document doc = new Document();
        
        // Creating a new node of any type requires a document passed into the constructor.
        Paragraph para = new Paragraph(doc);
        
        // The new paragraph node does not yet have a parent.
        System.out.println("Paragraph has no parent node: " + (para.getParentNode() == null));
        
        // But the paragraph node knows its document.
        System.out.println("Both nodes' documents are the same: " + (para.getDocument() == doc));
        
        // The fact that a node always belongs to a document allows us to access and modify
        // properties that reference the document-wide data such as styles or lists.
        para.getParagraphFormat().setStyleName("Heading 1");
        
        // Now add the paragraph to the main text of the first section.
        doc.getFirstSection().getBody().appendChild(para);
        
        // The paragraph node is now a child of the Body node.
        System.out.println("Paragraph has a parent node: " + (para.getParentNode() != null));
      • getExtrusionEnabled

        public boolean getExtrusionEnabled()
        
        Returns true if an extrusion effect is enabled.
      • getFill

        public Fill getFill()
        
        Defines a fill for a shape.

        Example:

        Demonstrates how to create shapes with fill.
        DocumentBuilder builder = new DocumentBuilder();
        
        builder.writeln();
        builder.writeln();
        builder.writeln();
        builder.write("Some text under the shape.");
        
        // Create a red balloon, semitransparent.
        // The shape is floating and its coordinates are (0,0) by default, relative to the current paragraph.
        Shape shape = new Shape(builder.getDocument(), ShapeType.BALLOON);
        shape.setFillColor(Color.RED);
        shape.getFill().setOpacity(0.3);
        shape.setWidth(100);
        shape.setHeight(100);
        shape.setTop(-100);
        builder.insertNode(shape);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Shape.Fill.doc");
      • getFillColor/setFillColor

        public java.awt.Color getFillColor() / public void setFillColor(java.awt.Color value)
        
        Defines the brush color that fills the closed path of the shape.

        This is a shortcut to the Fill.Color property.

        The default value is java.awt.Color.WHITE.

        Example:

        Demonstrates how to create shapes with fill.
        DocumentBuilder builder = new DocumentBuilder();
        
        builder.writeln();
        builder.writeln();
        builder.writeln();
        builder.write("Some text under the shape.");
        
        // Create a red balloon, semitransparent.
        // The shape is floating and its coordinates are (0,0) by default, relative to the current paragraph.
        Shape shape = new Shape(builder.getDocument(), ShapeType.BALLOON);
        shape.setFillColor(Color.RED);
        shape.getFill().setOpacity(0.3);
        shape.setWidth(100);
        shape.setHeight(100);
        shape.setTop(-100);
        builder.insertNode(shape);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Shape.Fill.doc");
      • getFilled/setFilled

        public boolean getFilled() / public void setFilled(boolean value)
        
        Determines whether the closed path of the shape will be filled.

        This is a shortcut to the Fill.On property.

        The default value is true.

      • getFirstChild

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

        Example:

        Shows how to efficiently visit all direct and indirect children of a composite node.
        public void recurseAllNodes() throws Exception
        {
            // Open a document.
            Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc");
        
            // Invoke the recursive function that will walk the tree.
            traverseAllNodes(doc);
        }
        
        /**
         * A simple function that will walk through all children of a specified node recursively
         * and print the type of each node to the screen.
         */
        public 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(Node.nodeTypeToString(childNode.getNodeType()));
        
                // Recurse into the node if it is a composite node.
                if (childNode.isComposite()) traverseAllNodes((CompositeNode) childNode);
            }
        }
      • getFirstParagraph

        public Paragraph getFirstParagraph()
        
        Gets the first paragraph in the shape.

        Example:

        Creates a textbox with some text and different formatting options in a new document.
        // Create a blank document.
        Document doc = new Document();
        
        // Create a new shape of type TextBox
        Shape textBox = new Shape(doc, ShapeType.TEXT_BOX);
        
        // Set some settings of the textbox itself.
        // Set the wrap of the textbox to inline
        textBox.setWrapType(WrapType.NONE);
        // Set the horizontal and vertical alignment of the text inside the shape.
        textBox.setHorizontalAlignment(HorizontalAlignment.CENTER);
        textBox.setVerticalAlignment(VerticalAlignment.TOP);
        
        // Set the textbox height and width.
        textBox.setHeight(50);
        textBox.setWidth(200);
        
        // Set the textbox in front of other shapes with a lower ZOrder
        textBox.setZOrder(2);
        
        // Let's create a new paragraph for the textbox manually and align it in the center. Make sure we add the new nodes to the textbox as well.
        textBox.appendChild(new Paragraph(doc));
        Paragraph para = textBox.getFirstParagraph();
        para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        
        // Add some text to the paragraph.
        Run run = new Run(doc);
        run.setText("Content in textbox");
        para.appendChild(run);
        
        // Append the textbox to the first paragraph in the body.
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(textBox);
        
        // Save the output
        doc.save(getMyDir() + "\\Artifacts\\Shape.CreateTextBox.doc");
      • getFlipOrientation/setFlipOrientation

        public int getFlipOrientation() / public void setFlipOrientation(int value)
        
        Switches the orientation of a shape. The value of the property is FlipOrientation integer constant.

        The default value is FlipOrientation.NONE.

        Example:

        Creates two line shapes. One line goes from top left to bottom right. Another line goes from bottom left to top right.
        Document doc = new Document();
        
        // The lines will cross the whole page.
        float pageWidth = (float) doc.getFirstSection().getPageSetup().getPageWidth();
        float pageHeight = (float) doc.getFirstSection().getPageSetup().getPageHeight();
        
        // This line goes from top left to bottom right by default.
        Shape lineA = new Shape(doc, ShapeType.LINE);
        lineA.setBounds(new Rectangle2D.Float(0, 0, pageWidth, pageHeight));
        lineA.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        lineA.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(lineA);
        
        // This line goes from bottom left to top right because we flipped it.
        Shape lineB = new Shape(doc, ShapeType.LINE);
        lineB.setBounds(new Rectangle2D.Float(0, 0, pageWidth, pageHeight));
        lineB.setFlipOrientation(FlipOrientation.HORIZONTAL);
        lineB.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        lineB.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(lineB);
        
        doc.save(getMyDir() + "\\Artifacts\\Shape.LineFlipOrientation.doc");
      • getFont

        public Font getFont()
        
        Provides access to the font formatting of this object.
      • hasChart

        public boolean hasChart()
        
        Returns true if this Shape has a Chart.
      • hasChildNodes

        public boolean hasChildNodes()
        
        Returns true if this node has any child nodes.

        Example:

        Demonstrates how to use the InsertDocument method to insert a document into a merge field during mail merge.
        public void insertDocumentAtMailMerge() throws Exception
        {
            // Open the main document.
            Document mainDoc = new Document(getMyDir() + "InsertDocument1.doc");
        
            // Add a handler to MergeField event
            mainDoc.getMailMerge().setFieldMergingCallback(new InsertDocumentAtMailMergeHandler());
        
            // The main document has a merge field in it called "Document_1".
            // The corresponding data for this field contains fully qualified path to the document
            // that should be inserted to this field.
            mainDoc.getMailMerge().execute(new String[]{"Document_1"}, new String[]{getMyDir() + "InsertDocument2.doc"});
        
            mainDoc.save(getMyDir() + "\\Artifacts\\InsertDocumentAtMailMerge.doc");
        }
        
        private class InsertDocumentAtMailMergeHandler implements IFieldMergingCallback
        {
            /**
             * This handler makes special processing for the "Document_1" field.
             * The field value contains the path to load the document.
             * We load the document and insert it into the current merge field.
             */
            public void fieldMerging(FieldMergingArgs e) throws Exception
            {
                if ("Document_1".equals(e.getDocumentFieldName()))
                {
                    // Use document builder to navigate to the merge field with the specified name.
                    DocumentBuilder builder = new DocumentBuilder(e.getDocument());
                    builder.moveToMergeField(e.getDocumentFieldName());
        
                    // The name of the document to load and insert is stored in the field value.
                    Document subDoc = new Document((String) e.getFieldValue());
        
                    // Insert the document.
                    insertDocument(builder.getCurrentParagraph(), subDoc);
        
                    // The paragraph that contained the merge field might be empty now and you probably want to delete it.
                    if (!builder.getCurrentParagraph().hasChildNodes()) builder.getCurrentParagraph().remove();
        
                    // Indicate to the mail merge engine that we have inserted what we wanted.
                    e.setText(null);
                }
            }
        
            public void imageFieldMerging(ImageFieldMergingArgs args)
            {
                // Do nothing.
            }
        }
      • hasImage

        public boolean hasImage()
        
        Returns true if the shape has image bytes or links an image.

        Example:

        Shows how to extract images from a document and save them as files.
        public void extractImagesToFiles() throws Exception
        {
            Document doc = new Document(getMyDir() + "Image.SampleImages.doc");
        
            NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
            int imageIndex = 0;
            for (Shape shape : (Iterable<Shape>) shapes)
            {
                if (shape.hasImage())
                {
                    String imageFileName = java.text.MessageFormat.format("\\Artifacts\\Image.ExportImages.{0} Out{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
                    shape.getImageData().save(getMyDir() + imageFileName);
                    imageIndex++;
                }
            }
        }

        Example:

        Shows how to delete all images from a document.
        // Here we get all shapes from the document node, but you can do this for any smaller
        // node too, for example delete shapes from a single section or a paragraph.
        NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
        
        // We cannot delete shape nodes while we enumerate through the collection.
        // One solution is to add nodes that we want to delete to a temporary array and delete afterwards.
        ArrayList shapesToDelete = new ArrayList();
        for (Shape shape : (Iterable<Shape>) shapes)
        {
            // Several shape types can have an image including image shapes and OLE objects.
            if (shape.hasImage()) shapesToDelete.add(shape);
        }
        
        // Now we can delete shapes.
        for (Shape shape : (Iterable<Shape>) shapesToDelete)
            shape.remove();
      • getHeight/setHeight

        public double getHeight() / public void setHeight(double value)
        
        Gets or sets the height of the containing block of the shape.

        For a top-level shape, the value is in points.

        For shapes in a group, the value is in the coordinate space and units of the parent group.

        The default value is 0.

        Example:

        Shows how to resize an image shape.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inserted at 100% scale.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Aspose.Words.gif");
        
        // It is easy to change the shape size. In this case, make it 50% relative to the current shape size.
        shape.setWidth(shape.getWidth() * 0.5);
        shape.setHeight(shape.getHeight() * 0.5);
        
        // However, we can also go back to the original image size and scale from there, say 110%.
        ImageSize imageSize = shape.getImageData().getImageSize();
        shape.setWidth(imageSize.getWidthPoints() * 1.1);
        shape.setHeight(imageSize.getHeightPoints() * 1.1);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.ScaleImage.doc");

        Example:

        Shows how to insert a floating image and specify its position and size.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inline.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Hammer.wmf");
        
        // Make the image float, put it behind text and center on the page.
        shape.setWrapType(WrapType.NONE);
        
        // Make position relative to the page.
        shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        
        // Make the shape occupy a band 50 points high at the very top of the page.
        shape.setLeft(0);
        shape.setTop(0);
        shape.setWidth(builder.getCurrentSection().getPageSetup().getPageWidth());
        shape.setHeight(50);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPositionSize.doc");
      • getHorizontalAlignment/setHorizontalAlignment

        public int getHorizontalAlignment() / public void setHorizontalAlignment(int value)
        
        Specifies how the shape is positioned horizontally. The value of the property is HorizontalAlignment integer constant.

        The default value is HorizontalAlignment.NONE.

        Has effect only for top level floating shapes.

        Example:

        Shows how to insert a floating image in the middle of a page.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inline.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Aspose.Words.gif");
        
        // Make the image float, put it behind text and center on the page.
        shape.setWrapType(WrapType.NONE);
        shape.setBehindText(true);
        shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        shape.setHorizontalAlignment(HorizontalAlignment.CENTER);
        shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        shape.setVerticalAlignment(VerticalAlignment.CENTER);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPageCenter.doc");
      • getHRef/setHRef

        public java.lang.String getHRef() / public void setHRef(java.lang.String value)
        
        Gets or sets the full hyperlink address for a shape.

        The default value is an empty string.

        Below are examples of valid values for this property:

        Full URI: https://www.aspose.com/.

        Full file name: C:\\My Documents\\SalesReport.doc.

        Relative URI: ../../../resource.txt

        Relative file name: ..\\My Documents\\SalesReport.doc.

        Bookmark within another document: https://www.aspose.com/Products/Default.aspx#Suites

        Bookmark within this document: #BookmakName.

        Example:

        Shows how to insert an image with a hyperlink.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Hammer.wmf");
        shape.setHRef("http://www.aspose.com/Community/Forums/75/ShowForum.aspx");
        shape.setScreenTip("Aspose.Words Support Forums");
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.InsertImageWithHyperlink.doc");
      • getImageData

        public ImageData getImageData()
        
        Provides access to the image of the shape. Returns null if the shape cannot have an image.

        Example:

        Shows how to extract images from a document and save them as files.
        public void extractImagesToFiles() throws Exception
        {
            Document doc = new Document(getMyDir() + "Image.SampleImages.doc");
        
            NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
            int imageIndex = 0;
            for (Shape shape : (Iterable<Shape>) shapes)
            {
                if (shape.hasImage())
                {
                    String imageFileName = java.text.MessageFormat.format("\\Artifacts\\Image.ExportImages.{0} Out{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
                    shape.getImageData().save(getMyDir() + imageFileName);
                    imageIndex++;
                }
            }
        }

        Example:

        Shows how to insert a linked image into a document.
        DocumentBuilder builder = new DocumentBuilder();
        
        String imageFileName = getMyDir() + "\\Images\\Hammer.wmf";
        
        builder.write("Image linked, not stored in the document: ");
        
        Shape linkedOnly = new Shape(builder.getDocument(), ShapeType.IMAGE);
        linkedOnly.setWrapType(WrapType.INLINE);
        linkedOnly.getImageData().setSourceFullName(imageFileName);
        
        builder.insertNode(linkedOnly);
        builder.writeln();
        
        builder.write("Image linked and stored in the document: ");
        
        Shape linkedAndStored = new Shape(builder.getDocument(), ShapeType.IMAGE);
        linkedAndStored.setWrapType(WrapType.INLINE);
        linkedAndStored.getImageData().setSourceFullName(imageFileName);
        linkedAndStored.getImageData().setImage(imageFileName);
        
        builder.insertNode(linkedAndStored);
        builder.writeln();
        
        builder.write("Image stored in the document, but not linked: ");
        
        Shape stored = new Shape(builder.getDocument(), ShapeType.IMAGE);
        stored.setWrapType(WrapType.INLINE);
        stored.getImageData().setImage(imageFileName);
        
        builder.insertNode(stored);
        builder.writeln();
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateLinkedImage.doc");
      • isComposite

        public boolean isComposite()
        
        Returns true as this node can have child nodes.

        Example:

        Shows how to efficiently visit all direct and indirect children of a composite node.
        public void recurseAllNodes() throws Exception
        {
            // Open a document.
            Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc");
        
            // Invoke the recursive function that will walk the tree.
            traverseAllNodes(doc);
        }
        
        /**
         * A simple function that will walk through all children of a specified node recursively
         * and print the type of each node to the screen.
         */
        public 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(Node.nodeTypeToString(childNode.getNodeType()));
        
                // Recurse into the node if it is a composite node.
                if (childNode.isComposite()) traverseAllNodes((CompositeNode) childNode);
            }
        }
      • isDeleteRevision

        public boolean isDeleteRevision()
        
        Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
      • isGroup

        public boolean isGroup()
        
        Returns true if this is a group shape.
      • isHorizontalRule

        public boolean isHorizontalRule()
        
        Returns true if this shape is a horizontal rule.
      • isImage

        public boolean isImage()
        
        Returns true if this shape is an image shape.
      • isInline

        public boolean isInline()
        
        A quick way to determine if this shape is positioned inline with text.

        Has effect only for top level shapes.

        Example:

        Shows how to test if a shape in the document is inline or floating.
        Document doc = new Document(getMyDir() + "Shape.DeleteAllShapes.doc");
        
        for (Shape shape : (Iterable<Shape>) doc.getChildNodes(NodeType.SHAPE, true))
        {
            if (shape.isInline()) System.out.println("Shape is inline.");
            else System.out.println("Shape is floating.");
        }
      • isInsertRevision

        public boolean isInsertRevision()
        
        Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
      • isLayoutInCell/isLayoutInCell

        public boolean isLayoutInCell() / public void isLayoutInCell(boolean value)
        
        Gets or sets a flag indicating whether the shape is displayed inside a table or outside of it.

        The default value is true.

        Has effect only for top level shapes, the property WrapType of which is set to value other than Inline.

      • isMoveFromRevision

        public boolean isMoveFromRevision()
        
        Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
      • isMoveToRevision

        public boolean isMoveToRevision()
        
        Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
      • isSignatureLine

        public boolean isSignatureLine()
        
        Indicates that shape is a SignatureLine.
      • isTopLevel

        public boolean isTopLevel()
        
        Returns true if this shape is not a child of a group shape.
      • isWordArt

        public boolean isWordArt()
        
        Returns true if this shape is a WordArt object.
      • getLastChild

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

        public Paragraph getLastParagraph()
        
        Gets the last paragraph in the shape.
      • getLeft/setLeft

        public double getLeft() / public void setLeft(double value)
        
        Gets or sets the position of the left edge of the containing block of the shape.

        For a top-level shape, the value is in points and relative to the shape anchor.

        For shapes in a group, the value is in the coordinate space and units of the parent group.

        The default value is 0.

        Has effect only for floating shapes.

        Example:

        Shows how to insert a floating image and specify its position and size.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inline.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Hammer.wmf");
        
        // Make the image float, put it behind text and center on the page.
        shape.setWrapType(WrapType.NONE);
        
        // Make position relative to the page.
        shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        
        // Make the shape occupy a band 50 points high at the very top of the page.
        shape.setLeft(0);
        shape.setTop(0);
        shape.setWidth(builder.getCurrentSection().getPageSetup().getPageWidth());
        shape.setHeight(50);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPositionSize.doc");
      • getMarkupLanguage

        public byte getMarkupLanguage()
        
        Gets MarkupLanguage used for this graphic object. The value of the property is ShapeMarkupLanguage integer constant.

        Example:

        Shows how get markup language for shape object in document
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Shape image = builder.insertImage(getImageDir() + "dotnet-logo.png");
        
        // Loop through all single shapes inside document.
        for (Shape shape : (Iterable<Shape>) doc.getChildNodes(NodeType.SHAPE, true))
        {
            Assert.assertEquals(shape.getMarkupLanguage(), ShapeMarkupLanguage.DML);
        
            System.out.println("Shape: " + shape.getMarkupLanguage());
            System.out.println("ShapeSize: " + shape.getSizeInPoints());
        }
      • getName/setName

        public java.lang.String getName() / public void setName(java.lang.String value)
        
        Gets or sets the optional shape name.

        Default is empty string.

        Cannot be null, but can be an empty string.

      • 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 enumerate immediate child nodes of a composite node using NextSibling. In this example we enumerate all paragraphs of a section body.
        // Get the section that we want to work on.
        Section section = doc.getSections().get(0);
        Body body = section.getBody();
        
        // Loop starting from the first child until we reach null.
        for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling())
        {
            // Output the types of the nodes that we come across.
            System.out.println(Node.nodeTypeToString(node.getNodeType()));
        }

        Example:

        Shows how to efficiently visit all direct and indirect children of a composite node.
        public void recurseAllNodes() throws Exception
        {
            // Open a document.
            Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc");
        
            // Invoke the recursive function that will walk the tree.
            traverseAllNodes(doc);
        }
        
        /**
         * A simple function that will walk through all children of a specified node recursively
         * and print the type of each node to the screen.
         */
        public 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(Node.nodeTypeToString(childNode.getNodeType()));
        
                // Recurse into the node if it is a composite node.
                if (childNode.isComposite()) traverseAllNodes((CompositeNode) childNode);
            }
        }
      • getNodeType

        public int getNodeType()
        
        Returns NodeType.SHAPE. The value of the property is NodeType integer constant.

        Example:

        Shows how to retrieve the NodeType enumeration of nodes.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // Let's pick a node that we can't be quite sure of what type it is.
        // In this case lets pick the first node of the first paragraph in the body of the document
        Node node = doc.getFirstSection().getBody().getFirstParagraph().getFirstChild();
        System.out.println("NodeType of first child: " + Node.nodeTypeToString(node.getNodeType()));
        
        // This time let's pick a node that we know the type of. Create a new paragraph and a table node.
        Paragraph para = new Paragraph(doc);
        Table table = new Table(doc);
        
        // Access to NodeType for typed nodes will always return their specific NodeType.
        // i.e A paragraph node will always return NodeType.Paragraph, a table node will always return NodeType.Table.
        System.out.println("NodeType of Paragraph: " + Node.nodeTypeToString(para.getNodeType()));
        System.out.println("NodeType of Table: " + Node.nodeTypeToString(table.getNodeType()));
      • getOleFormat

        public OleFormat getOleFormat()
        
        Provides access to the OLE data of a shape. For a shape that is not an OLE object or ActiveX control, returns null.
      • 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 the parent node.
        // Create a new empty document. It has one section.
        Document doc = new Document();
        
        // The section is the first child node of the document.
        Node section = doc.getFirstChild();
        
        // The section's parent node is the document.
        System.out.println("Section parent is the document: " + (doc == section.getParentNode()));

        Example:

        Shows that when you create any node, it requires a document that will own the node.
        // Open a file from disk.
        Document doc = new Document();
        
        // Creating a new node of any type requires a document passed into the constructor.
        Paragraph para = new Paragraph(doc);
        
        // The new paragraph node does not yet have a parent.
        System.out.println("Paragraph has no parent node: " + (para.getParentNode() == null));
        
        // But the paragraph node knows its document.
        System.out.println("Both nodes' documents are the same: " + (para.getDocument() == doc));
        
        // The fact that a node always belongs to a document allows us to access and modify
        // properties that reference the document-wide data such as styles or lists.
        para.getParagraphFormat().setStyleName("Heading 1");
        
        // Now add the paragraph to the main text of the first section.
        doc.getFirstSection().getBody().appendChild(para);
        
        // The paragraph node is now a child of the Body node.
        System.out.println("Paragraph has a parent node: " + (para.getParentNode() != null));
      • getParentParagraph

        public Paragraph getParentParagraph()
        
        Returns the immediate parent paragraph. For child shapes of a group shape always returns null.
      • getPreviousSibling

        public Node getPreviousSibling()
        
        Gets the node immediately preceding this node. If there is no preceding 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);
      • 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 characters of a range.
        // Open Word document.
        Document doc = new Document(getMyDir() + "Range.DeleteSection.doc");
        
        // The document contains two sections. Each section has a paragraph of text.
        System.out.println(doc.getText());
        
        // Delete the first section from the document.
        doc.getSections().get(0).getRange().delete();
        
        // Check the first section was deleted by looking at the text of the whole document again.
        System.out.println(doc.getText());
      • getRelativeHorizontalPosition/setRelativeHorizontalPosition

        public int getRelativeHorizontalPosition() / public void setRelativeHorizontalPosition(int value)
        
        Specifies relative to what the shape is positioned horizontally. The value of the property is RelativeHorizontalPosition integer constant.

        The default value is RelativeHorizontalPosition.COLUMN.

        Has effect only for top level floating shapes.

        Example:

        Shows how to insert a floating image in the middle of a page.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inline.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Aspose.Words.gif");
        
        // Make the image float, put it behind text and center on the page.
        shape.setWrapType(WrapType.NONE);
        shape.setBehindText(true);
        shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        shape.setHorizontalAlignment(HorizontalAlignment.CENTER);
        shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        shape.setVerticalAlignment(VerticalAlignment.CENTER);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPageCenter.doc");
      • getRelativeVerticalPosition/setRelativeVerticalPosition

        public int getRelativeVerticalPosition() / public void setRelativeVerticalPosition(int value)
        
        Specifies relative to what the shape is positioned vertically. The value of the property is RelativeVerticalPosition integer constant.

        The default value is RelativeVerticalPosition.PARAGRAPH.

        Has effect only for top level floating shapes.

        Example:

        Shows how to insert a floating image in the middle of a page.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inline.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Aspose.Words.gif");
        
        // Make the image float, put it behind text and center on the page.
        shape.setWrapType(WrapType.NONE);
        shape.setBehindText(true);
        shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        shape.setHorizontalAlignment(HorizontalAlignment.CENTER);
        shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        shape.setVerticalAlignment(VerticalAlignment.CENTER);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPageCenter.doc");
      • getRight

        public double getRight()
        
        Gets the position of the right edge of the containing block of the shape.

        For a top-level shape, the value is in points and relative to the shape anchor.

        For shapes in a group, the value is in the coordinate space and units of the parent group.

      • getRotation/setRotation

        public double getRotation() / public void setRotation(double value)
        
        Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle.

        The default value is 0.

      • getScreenTip/setScreenTip

        public java.lang.String getScreenTip() / public void setScreenTip(java.lang.String value)
        
        Defines the text displayed when the mouse pointer moves over the shape.

        The default value is an empty string.

        Example:

        Shows how to insert an image with a hyperlink.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Hammer.wmf");
        shape.setHRef("http://www.aspose.com/Community/Forums/75/ShowForum.aspx");
        shape.setScreenTip("Aspose.Words Support Forums");
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.InsertImageWithHyperlink.doc");
      • getShadowEnabled

        public boolean getShadowEnabled()
        
        Returns true if a shadow effect is enabled.
      • getShapeType

        public int getShapeType()
        
        Gets the shape type. The value of the property is ShapeType integer constant.
      • getSizeInPoints

        public java.awt.Dimension getSizeInPoints()
        
        Gets the size of the shape in points.
      • getStroke

        public Stroke getStroke()
        
        Defines a stroke for a shape.
      • getStrokeColor/setStrokeColor

        public java.awt.Color getStrokeColor() / public void setStrokeColor(java.awt.Color value)
        
        Defines the color of a stroke.

        This is a shortcut to the Stroke.Color property.

        The default value is java.awt.Color.BLACK.

      • getStroked/setStroked

        public boolean getStroked() / public void setStroked(boolean value)
        
        Defines whether the path will be stroked.

        This is a shortcut to the Stroke.On property.

        The default value is true.

      • getStrokeWeight/setStrokeWeight

        public double getStrokeWeight() / public void setStrokeWeight(double value)
        
        Defines the brush thickness that strokes the path of a shape in points.

        This is a shortcut to the Stroke.Weight property.

        The default value is 0.75.

      • getTarget/setTarget

        public java.lang.String getTarget() / public void setTarget(java.lang.String value)
        
        Gets or sets the target frame for the shape hyperlink.

        The default value is an empty string.

      • getTextBox

        public TextBox getTextBox()
        
        Defines attributes that specify how text is displayed in a shape.
      • getTextPath

        public TextPath getTextPath()
        
        Defines the text of the text path (of a WordArt object).
      • getTitle/setTitle

        public java.lang.String getTitle() / public void setTitle(java.lang.String value)
        
        Gets or sets the title (caption) of the current shape object.

        Default is empty string.

        Cannot be null, but can be an empty string.

        Example:

        Shows how to get or set title of shape object.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create test shape.
        Shape shape = new Shape(doc, ShapeType.CUBE);
        shape.setWidth(431.5);
        shape.setHeight(346.35);
        shape.setTitle("Alt Text Title");
        
        builder.insertNode(shape);
        
        ByteArrayOutputStream dstStream = new ByteArrayOutputStream();
        doc.save(dstStream, SaveFormat.DOCX);
        
        shape = (Shape) doc.getChild(NodeType.SHAPE, 0, true);
        System.out.println("Shape text: " + shape.getTitle());
      • getTop/setTop

        public double getTop() / public void setTop(double value)
        
        Gets or sets the position of the top edge of the containing block of the shape.

        For a top-level shape, the value is in points and relative to the shape anchor.

        For shapes in a group, the value is in the coordinate space and units of the parent group.

        The default value is 0.

        Has effect only for floating shapes.

        Example:

        Shows how to insert a floating image and specify its position and size.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inline.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Hammer.wmf");
        
        // Make the image float, put it behind text and center on the page.
        shape.setWrapType(WrapType.NONE);
        
        // Make position relative to the page.
        shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        
        // Make the shape occupy a band 50 points high at the very top of the page.
        shape.setLeft(0);
        shape.setTop(0);
        shape.setWidth(builder.getCurrentSection().getPageSetup().getPageWidth());
        shape.setHeight(50);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPositionSize.doc");
      • getVerticalAlignment/setVerticalAlignment

        public int getVerticalAlignment() / public void setVerticalAlignment(int value)
        
        Specifies how the shape is positioned vertically. The value of the property is VerticalAlignment integer constant.

        The default value is VerticalAlignment.NONE.

        Has effect only for top level floating shapes.

        Example:

        Shows how to insert a floating image in the middle of a page.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inline.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Aspose.Words.gif");
        
        // Make the image float, put it behind text and center on the page.
        shape.setWrapType(WrapType.NONE);
        shape.setBehindText(true);
        shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        shape.setHorizontalAlignment(HorizontalAlignment.CENTER);
        shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        shape.setVerticalAlignment(VerticalAlignment.CENTER);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPageCenter.doc");
      • getWidth/setWidth

        public double getWidth() / public void setWidth(double value)
        
        Gets or sets the width of the containing block of the shape.

        For a top-level shape, the value is in points.

        For shapes in a group, the value is in the coordinate space and units of the parent group.

        The default value is 0.

        Example:

        Shows how to resize an image shape.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inserted at 100% scale.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Aspose.Words.gif");
        
        // It is easy to change the shape size. In this case, make it 50% relative to the current shape size.
        shape.setWidth(shape.getWidth() * 0.5);
        shape.setHeight(shape.getHeight() * 0.5);
        
        // However, we can also go back to the original image size and scale from there, say 110%.
        ImageSize imageSize = shape.getImageData().getImageSize();
        shape.setWidth(imageSize.getWidthPoints() * 1.1);
        shape.setHeight(imageSize.getHeightPoints() * 1.1);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.ScaleImage.doc");

        Example:

        Shows how to insert a floating image and specify its position and size.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inline.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Hammer.wmf");
        
        // Make the image float, put it behind text and center on the page.
        shape.setWrapType(WrapType.NONE);
        
        // Make position relative to the page.
        shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        
        // Make the shape occupy a band 50 points high at the very top of the page.
        shape.setLeft(0);
        shape.setTop(0);
        shape.setWidth(builder.getCurrentSection().getPageSetup().getPageWidth());
        shape.setHeight(50);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPositionSize.doc");
      • getWrapSide/setWrapSide

        public int getWrapSide() / public void setWrapSide(int value)
        
        Specifies how the text is wrapped around the shape. The value of the property is WrapSide integer constant.

        The default value is WrapSide.BOTH.

        Has effect only for top level shapes.

        Example:

        Shows how to replace all textboxes with images.
        Document doc = new Document(getMyDir() + "Shape.ReplaceTextboxesWithImages.doc");
        
        // This gets a live collection of all shape nodes in the document.
        NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);
        
        // Since we will be adding/removing nodes, it is better to copy all collection
        // into a fixed size array, otherwise iterator will be invalidated.
        Node[] shapes = shapeCollection.toArray();
        
        for (Node node : shapes)
        {
            Shape shape = (Shape) node;
            // Filter out all shapes that we don't need.
            if (shape.getShapeType() == ShapeType.TEXT_BOX)
            {
                // Create a new shape that will replace the existing shape.
                Shape image = new Shape(doc, ShapeType.IMAGE);
        
                // Load the image into the new shape.
                image.getImageData().setImage(getImageDir() + "Hammer.wmf");
        
                // Make new shape's position to match the old shape.
                image.setLeft(shape.getLeft());
                image.setTop(shape.getTop());
                image.setWidth(shape.getWidth());
                image.setHeight(shape.getHeight());
                image.setRelativeHorizontalPosition(shape.getRelativeHorizontalPosition());
                image.setRelativeVerticalPosition(shape.getRelativeVerticalPosition());
                image.setHorizontalAlignment(shape.getHorizontalAlignment());
                image.setVerticalAlignment(shape.getVerticalAlignment());
                image.setWrapType(shape.getWrapType());
                image.setWrapSide(shape.getWrapSide());
        
                // Insert new shape after the old shape and remove the old shape.
                shape.getParentNode().insertAfter(image, shape);
                shape.remove();
            }
        }
        
        doc.save(getMyDir() + "\\Artifacts\\Shape.ReplaceTextboxesWithImages.doc");
      • getWrapType/setWrapType

        public int getWrapType() / public void setWrapType(int value)
        
        Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape. The value of the property is WrapType integer constant.

        The default value is WrapType.NONE.

        Has effect only for top level shapes.

        Example:

        Shows how to insert a floating image in the middle of a page.
        // This creates a builder and also an empty document inside the builder.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inline.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Aspose.Words.gif");
        
        // Make the image float, put it behind text and center on the page.
        shape.setWrapType(WrapType.NONE);
        shape.setBehindText(true);
        shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
        shape.setHorizontalAlignment(HorizontalAlignment.CENTER);
        shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
        shape.setVerticalAlignment(VerticalAlignment.CENTER);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateFloatingPageCenter.doc");

        Example:

        Creates a textbox with some text and different formatting options in a new document.
        // Create a blank document.
        Document doc = new Document();
        
        // Create a new shape of type TextBox
        Shape textBox = new Shape(doc, ShapeType.TEXT_BOX);
        
        // Set some settings of the textbox itself.
        // Set the wrap of the textbox to inline
        textBox.setWrapType(WrapType.NONE);
        // Set the horizontal and vertical alignment of the text inside the shape.
        textBox.setHorizontalAlignment(HorizontalAlignment.CENTER);
        textBox.setVerticalAlignment(VerticalAlignment.TOP);
        
        // Set the textbox height and width.
        textBox.setHeight(50);
        textBox.setWidth(200);
        
        // Set the textbox in front of other shapes with a lower ZOrder
        textBox.setZOrder(2);
        
        // Let's create a new paragraph for the textbox manually and align it in the center. Make sure we add the new nodes to the textbox as well.
        textBox.appendChild(new Paragraph(doc));
        Paragraph para = textBox.getFirstParagraph();
        para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        
        // Add some text to the paragraph.
        Run run = new Run(doc);
        run.setText("Content in textbox");
        para.appendChild(run);
        
        // Append the textbox to the first paragraph in the body.
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(textBox);
        
        // Save the output
        doc.save(getMyDir() + "\\Artifacts\\Shape.CreateTextBox.doc");
      • getZOrder/setZOrder

        public int getZOrder() / public void setZOrder(int value)
        
        Determines the display order of overlapping shapes.

        Has effect only for top level shapes.

        The default value is 0.

        The number represents the stacking precedence. A shape with a higher number will be displayed as if it were overlapping (in "front" of) a shape with a lower number.

        The order of overlapping shapes is independent for shapes in the header and in the main text of the document.

        The display order of child shapes in a group shape is determined by their order inside the group shape.

        Example:

        Creates a textbox with some text and different formatting options in a new document.
        // Create a blank document.
        Document doc = new Document();
        
        // Create a new shape of type TextBox
        Shape textBox = new Shape(doc, ShapeType.TEXT_BOX);
        
        // Set some settings of the textbox itself.
        // Set the wrap of the textbox to inline
        textBox.setWrapType(WrapType.NONE);
        // Set the horizontal and vertical alignment of the text inside the shape.
        textBox.setHorizontalAlignment(HorizontalAlignment.CENTER);
        textBox.setVerticalAlignment(VerticalAlignment.TOP);
        
        // Set the textbox height and width.
        textBox.setHeight(50);
        textBox.setWidth(200);
        
        // Set the textbox in front of other shapes with a lower ZOrder
        textBox.setZOrder(2);
        
        // Let's create a new paragraph for the textbox manually and align it in the center. Make sure we add the new nodes to the textbox as well.
        textBox.appendChild(new Paragraph(doc));
        Paragraph para = textBox.getFirstParagraph();
        para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        
        // Add some text to the paragraph.
        Run run = new Run(doc);
        run.setText("Content in textbox");
        para.appendChild(run);
        
        // Append the textbox to the first paragraph in the body.
        doc.getFirstSection().getBody().getFirstParagraph().appendChild(textBox);
        
        // Save the output
        doc.save(getMyDir() + "\\Artifacts\\Shape.CreateTextBox.doc");
        See Also:
        BehindText
    • Method Detail

      • adjustWithEffects

        public java.awt.geom.Rectangle2D.Float adjustWithEffects(java.awt.geom.Rectangle2D.Float source)
        Adds to the source rectangle values of the effect extent and returns the final rectangle.
      • appendChild

        public Node appendChild(Node newChild)
        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 DocumentBase.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 paragraph in the document.
        // The document is valid and can be saved, but lets add some text before saving.
        // Create a new run of text and add it to our paragraph.
        Run run = new Run(doc);
        run.setText("Hello World!");
        run.getFont().setColor(Color.RED);
        para.appendChild(run);
        
        // As a matter of interest, you can retrieve text of the whole document and
        // see that \x000c is automatically appended. \x000c is the end of section character.
        System.out.println(doc.getText());
        
        // Save the document.
        doc.save(getMyDir() + "\\Artifacts\\Section.CreateFromScratch.doc");
      • deepClone

        public Node deepClone(boolean isCloneChildren)

        Example:

        Shows how to clone composite nodes with and without their child nodes.
        // Create a new empty document.
        Document doc = new Document();
        
        // Add some text to the first paragraph
        Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
        para.appendChild(new Run(doc, "Some text"));
        
        // Clone the paragraph and the child nodes.
        Node cloneWithChildren = para.deepClone(true);
        // Only clone the paragraph and no child nodes.
        Node cloneWithoutChildren = para.deepClone(false);
      • fetchInheritedShapeAttr

        public java.lang.Object fetchInheritedShapeAttr(int key)
        Reserved for internal use.
      • fetchShapeAttr

        public java.lang.Object fetchShapeAttr(int key)
        Reserved for internal use.
      • 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() + "Table.NestedTables.doc");
            int tableIndex = 0;
        
            for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true))
            {
                // First lets find if any cells in the table have tables themselves as children.
                int count = getChildTableCount(table);
                System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count));
        
                // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth.
                int tableDepth = getNestedDepthOfTable(table);
        
                if (tableDepth > 0)
                    System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth));
                else
                    System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex));
        
                tableIndex++;
            }
        }
        
        /**
         * Calculates what level a table is nested inside other tables.
         *
         * @returns An integer containing the level the table is nested at.
         * 0 = Table is not nested inside any other table
         * 1 = Table is nested within one parent table
         * 2 = Table is nested within two parent tables etc..
         */
        private static int getNestedDepthOfTable(Table table)
        {
            int depth = 0;
        
            int type = table.getNodeType();
            // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table
            Node parent = table.getAncestor(type);
        
            while (parent != null)
            {
                // Every time we find a table a level up we increase the depth counter and then try to find an
                // ancestor of type table from the parent.
                depth++;
                parent = parent.getAncestor(type);
            }
        
            return depth;
        }
        
        /**
         * Determines if a table contains any immediate child table within its cells.
         * Does not recursively traverse through those tables to check for further tables.
         *
         * @returns Returns true if at least one child cell contains a table.
         * Returns false if no cells in the table contains a table.
         */
        private static int getChildTableCount(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.
      • getChild

        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.

        Note that markup nodes (NodeType.STRUCTURED_DOCUMENT_TAG and NodeType.SMART_TAG) are traversed even when isDeep = false and GetChild is invoked for non-markup node type. For example if the first run in a para is wrapped in a StructuredDocumentTag, it will still be returned by GetChild(NodeType.Run, 0, false).
        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. See remarks for more info.
        Returns:
        The child node that matches the criteria or null if no matching node is found.

        Example:

        Shows how to test if a node is inside a field by using an XPath expression.
        // Let's pick a document we know has some fields in.
        Document doc = new Document(getMyDir() + "MailMerge.MergeImage.doc");
        
        // Let's say we want to check if the Run below is inside a field.
        Run run = (Run) doc.getChild(NodeType.RUN, 5, true);
        
        // Evaluate the XPath expression. The resulting NodeList will contain all nodes found inside a field a field (between FieldStart
        // and FieldEnd exclusive). There can however be FieldStart and FieldEnd nodes in the list if there are nested fields
        // in the path. Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs.
        NodeList resultList = doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]");
        
        // Check if the specified run is one of the nodes that are inside the field.
        for (Node node : (Iterable<Node>) resultList)
        {
            if (node == run)
            {
                System.out.println("The node is found inside a field");
                break;
            }
        }

        Example:

        Shows how to extract a specific child node from a CompositeNode by using the GetChild method and passing the NodeType and index.
        Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
      • getChildNodes

        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.

        Example:

        Shows how to extract images from a document and save them as files.
        public void extractImagesToFiles() throws Exception
        {
            Document doc = new Document(getMyDir() + "Image.SampleImages.doc");
        
            NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
            int imageIndex = 0;
            for (Shape shape : (Iterable<Shape>) shapes)
            {
                if (shape.hasImage())
                {
                    String imageFileName = java.text.MessageFormat.format("\\Artifacts\\Image.ExportImages.{0} Out{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
                    shape.getImageData().save(getMyDir() + imageFileName);
                    imageIndex++;
                }
            }
        }

        Example:

        Demonstrates how to remove a specified TOC from a document.
        public void removeTOCFromDocument() throws Exception
        {
            // Open a document which contains a TOC.
            Document doc = new Document(getMyDir() + "Document.TableOfContents.doc");
        
            // Remove the first TOC from the document.
            Field tocField = doc.getRange().getFields().get(0);
            tocField.remove();
        
            // Save the output.
            doc.save(getMyDir() + "\\Artifacts\\Document.TableOfContentsRemoveTOC.doc");
        }
      • getDirectShapeAttr

        public java.lang.Object getDirectShapeAttr(int key)
        Reserved for internal use.
      • getShapeRenderer

        public ShapeRenderer getShapeRenderer()
                                      throws java.lang.Exception
        Creates and returns an object that can be used to render this shape into an image.

        This method just invokes the ShapeRenderer constructor and passes this object as a parameter.

        Returns:
        The renderer object for this shape.
      • getSizeInPoints

        public java.awt.geom.Point2D.Float getSizeInPoints()
        Gets the size of the shape in points.

        Point2D.Float is used as return type because we need in float dimension values here. One should to assume that Point2D's x == width and y == height.

      • 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 the difference between calling the GetText and ToString methods on a node.
        Document doc = new Document();
        
        // Enter a dummy field into the document.
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertField("MERGEFIELD Field");
        
        // GetText will retrieve all field codes and special characters
        System.out.println("GetText() Result: " + doc.getText());
        
        // ToString will export the node to the specified format. When converted to text it will not retrieve fields code
        // or special characters, but will still contain some natural formatting characters such as paragraph markers etc.
        // This is the same as "viewing" the document as if it was opened in a text editor.
        System.out.println("ToString() Result: " + doc.toString(SaveFormat.TEXT));

        Example:

        Finds and outputs all paragraphs in a document that are bulleted or numbered.
        NodeCollection paras = doc.getChildNodes(NodeType.PARAGRAPH, true);
        for (Paragraph para : (Iterable<Paragraph>) paras)
        {
            if (para.getListFormat().isListItem())
            {
                System.out.println(java.text.MessageFormat.format("*** A paragraph belongs to list {0}", para.getListFormat().getList().getListId()));
                System.out.println(para.getText());
            }
        }
      • indexOf

        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.

        Example:

        Shows how to get the index of a given child node from its parent.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // Get the body of the first section in the document.
        Body body = doc.getFirstSection().getBody();
        // Retrieve the index of the last paragraph in the body.
        int index = body.getChildNodes().indexOf(body.getLastParagraph());

        Example:

        Retrieves the index of a row in a table.
        int rowIndex = table.indexOf(row);

        Example:

        Retrieves the index of a cell in a row.
        int cellIndex = row.indexOf(cell);
      • insertAfter

        public Node insertAfter(Node newChild, Node refChild)
        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 DocumentBase.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.

        Example:

        Shows how to replace all textboxes with images.
        Document doc = new Document(getMyDir() + "Shape.ReplaceTextboxesWithImages.doc");
        
        // This gets a live collection of all shape nodes in the document.
        NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);
        
        // Since we will be adding/removing nodes, it is better to copy all collection
        // into a fixed size array, otherwise iterator will be invalidated.
        Node[] shapes = shapeCollection.toArray();
        
        for (Node node : shapes)
        {
            Shape shape = (Shape) node;
            // Filter out all shapes that we don't need.
            if (shape.getShapeType() == ShapeType.TEXT_BOX)
            {
                // Create a new shape that will replace the existing shape.
                Shape image = new Shape(doc, ShapeType.IMAGE);
        
                // Load the image into the new shape.
                image.getImageData().setImage(getImageDir() + "Hammer.wmf");
        
                // Make new shape's position to match the old shape.
                image.setLeft(shape.getLeft());
                image.setTop(shape.getTop());
                image.setWidth(shape.getWidth());
                image.setHeight(shape.getHeight());
                image.setRelativeHorizontalPosition(shape.getRelativeHorizontalPosition());
                image.setRelativeVerticalPosition(shape.getRelativeVerticalPosition());
                image.setHorizontalAlignment(shape.getHorizontalAlignment());
                image.setVerticalAlignment(shape.getVerticalAlignment());
                image.setWrapType(shape.getWrapType());
                image.setWrapSide(shape.getWrapSide());
        
                // Insert new shape after the old shape and remove the old shape.
                shape.getParentNode().insertAfter(image, shape);
                shape.remove();
            }
        }
        
        doc.save(getMyDir() + "\\Artifacts\\Shape.ReplaceTextboxesWithImages.doc");
      • insertBefore

        public Node insertBefore(Node newChild, Node refChild)
        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.

        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 DocumentBase.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.
      • iterator

        public java.util.Iterator<Node> 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 children = paragraph.getChildNodes();
        for (Node child : (Iterable<Node>) children)
        {
            // Paragraph may contain children of various types such as runs, shapes and so on.
            if (child.getNodeType() == NodeType.RUN)
            {
                // Say we found the node that we want, do something useful.
                Run run = (Run) child;
                System.out.println(run.getText());
            }
        }
      • localToParent

        public java.awt.geom.Point2D.Float localToParent(java.awt.geom.Point2D.Float value)
        Converts a value from the local coordinate space into the coordinate space of the parent shape.
      • 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.

        Example:

        Shows how to delete all images from a document using pre-order tree traversal.
        Node curNode = doc;
        while (curNode != null)
        {
            Node nextNode = curNode.nextPreOrder(doc);
        
            if (curNode.getNodeType() == NodeType.SHAPE)
            {
                Shape shape = (Shape) curNode;
        
                // Several shape types can have an image including image shapes and OLE objects.
                if (shape.hasImage()) shape.remove();
            }
        
            curNode = nextNode;
        }
      • prependChild

        public Node prependChild(Node newChild)
        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 DocumentBase.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:

        Shows how to manually prepend the content from one document to the beginning of another document.
        public static void prependDocumentMain() throws Exception
        {
            Document dstDoc = new Document(gDataDir + "TestFile.Destination.doc");
            Document srcDoc = new Document(gDataDir + "TestFile.Source.doc");
        
            // Append the source document to the destination document. This causes the result to have line spacing problems.
            dstDoc.appendDocument(srcDoc, ImportFormatMode.KEEP_SOURCE_FORMATTING);
        
            // Instead prepend the content of the destination document to the start of the source document.
            // This results in the same joined document but with no line spacing issues.
            prependDocument(srcDoc, dstDoc, ImportFormatMode.KEEP_SOURCE_FORMATTING);
        }
        
        
        /**
         * A modified version of the AppendDocument method which prepends the content of one document to the start
         * of another.
         *
         * @param dstDoc The destination document where to prepend the source document to.
         * @param srcDoc The source document.
         */
        public static void prependDocument(Document dstDoc, Document srcDoc, int mode) 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.
            ArrayList sections = (ArrayList)Arrays.asList(srcDoc.getSections().toArray());
        
            // Reverse the order of the sections so they are prepended to start of the destination document in the correct order.
            Collections.reverse(sections);
        
            for (Section srcSection : (Iterable<Section>) sections)
            {
                // Import the nodes from the source document.
                Node dstSection = dstDoc.importNode(srcSection, true, mode);
        
                // Now the new section node can be prepended to the destination document.
                // Note how PrependChild is used instead of AppendChild. This is the only line changed compared
                // to the original method.
                dstDoc.prependChild(dstSection);
            }
        }
      • 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 nodes of a specific type from a composite node. In this example we remove tables from a section body.
        // Get the section that we want to work on.
        Section section = doc.getSections().get(0);
        Body body = section.getBody();
        
        // Select the first child node in the body.
        Node curNode = body.getFirstChild();
        
        while (curNode != null)
        {
            // Save the pointer to the next sibling node because if the current
            // node is removed from the parent in the next step, we will have
            // no way of finding the next node to continue the loop.
            Node nextNode = curNode.getNextSibling();
        
            // A section body can contain Paragraph and Table nodes.
            // If the node is a Table, remove it from the parent.
            if (curNode.getNodeType() == NodeType.TABLE) curNode.remove();
        
            // Continue going through child nodes until null (no more siblings) is reached.
            curNode = nextNode;
        }

        Example:

        Shows how to delete all images from a document.
        // Here we get all shapes from the document node, but you can do this for any smaller
        // node too, for example delete shapes from a single section or a paragraph.
        NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
        
        // We cannot delete shape nodes while we enumerate through the collection.
        // One solution is to add nodes that we want to delete to a temporary array and delete afterwards.
        ArrayList shapesToDelete = new ArrayList();
        for (Shape shape : (Iterable<Shape>) shapes)
        {
            // Several shape types can have an image including image shapes and OLE objects.
            if (shape.hasImage()) shapesToDelete.add(shape);
        }
        
        // Now we can delete shapes.
        for (Shape shape : (Iterable<Shape>) shapesToDelete)
            shape.remove();
      • removeAllChildren

        public void removeAllChildren()
        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 paragraph in the document.
        // The document is valid and can be saved, but lets add some text before saving.
        // Create a new run of text and add it to our paragraph.
        Run run = new Run(doc);
        run.setText("Hello World!");
        run.getFont().setColor(Color.RED);
        para.appendChild(run);
        
        // As a matter of interest, you can retrieve text of the whole document and
        // see that \x000c is automatically appended. \x000c is the end of section character.
        System.out.println(doc.getText());
        
        // Save the document.
        doc.save(getMyDir() + "\\Artifacts\\Section.CreateFromScratch.doc");
      • removeChild

        public Node removeChild(Node oldChild)
        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);
      • removeShapeAttr

        public void removeShapeAttr(int key)
        Reserved for internal use.
      • removeSmartTags

        public void removeSmartTags()
        Removes all SmartTag descendant nodes of the current node. This method does not remove the content of the smart tags.

        Example:

        Removes all smart tags from descendant nodes of the composite node.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // Remove smart tags from the first paragraph in the document.
        doc.getFirstSection().getBody().getFirstParagraph().removeSmartTags();

        Example:

        Shows how to remove all smart tags from a document.
        Document doc = new Document(getMyDir() + "Document.doc");
        doc.removeSmartTags();
      • selectNodes

        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:

        Shows how to test if a node is inside a field by using an XPath expression.
        // Let's pick a document we know has some fields in.
        Document doc = new Document(getMyDir() + "MailMerge.MergeImage.doc");
        
        // Let's say we want to check if the Run below is inside a field.
        Run run = (Run) doc.getChild(NodeType.RUN, 5, true);
        
        // Evaluate the XPath expression. The resulting NodeList will contain all nodes found inside a field a field (between FieldStart
        // and FieldEnd exclusive). There can however be FieldStart and FieldEnd nodes in the list if there are nested fields
        // in the path. Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs.
        NodeList resultList = doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]");
        
        // Check if the specified run is one of the nodes that are inside the field.
        for (Node node : (Iterable<Node>) resultList)
        {
            if (node == run)
            {
                System.out.println("The node is found inside a field");
                break;
            }
        }

        Example:

        Shows how to select certain nodes by using an XPath expression.
        Document doc = new Document(getMyDir() + "Table.Document.doc");
        
        // This expression will extract all paragraph nodes which are descendants of any table node in the document.
        // This will return any paragraphs which are in a table.
        NodeList nodeList = doc.selectNodes("//Table//Paragraph");
        
        // This expression will select any paragraphs that are direct children of any body node in the document.
        nodeList = doc.selectNodes("//Body/Paragraph");
        
        // Use SelectSingleNode to select the first result of the same expression as above.
        Node node = doc.selectSingleNode("//Body/Paragraph");
      • selectSingleNode

        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.

        Example:

        Shows how to select certain nodes by using an XPath expression.
        Document doc = new Document(getMyDir() + "Table.Document.doc");
        
        // This expression will extract all paragraph nodes which are descendants of any table node in the document.
        // This will return any paragraphs which are in a table.
        NodeList nodeList = doc.selectNodes("//Table//Paragraph");
        
        // This expression will select any paragraphs that are direct children of any body node in the document.
        nodeList = doc.selectNodes("//Body/Paragraph");
        
        // Use SelectSingleNode to select the first result of the same expression as above.
        Node node = doc.selectSingleNode("//Body/Paragraph");
      • setShapeAttr

        public void setShapeAttr(int key, java.lang.Object value)
        Reserved for internal use.
      • 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 using custom specified options.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // Extract the last paragraph in the document to convert to HTML.
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // Create an instance of HtmlSaveOptions and set a few options.
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setExportHeadersFootersMode(ExportHeadersFootersMode.PER_SECTION);
        saveOptions.setExportRelativeFontSize(true);
        
        // Convert the document to HTML and return as a string. Pass the instance of HtmlSaveOptions to
        // to use the specified options during the conversion.
        String nodeAsHtml = node.toString(saveOptions);
      • toString

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

        Example:

        Shows the difference between calling the GetText and ToString methods on a node.
        Document doc = new Document();
        
        // Enter a dummy field into the document.
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertField("MERGEFIELD Field");
        
        // GetText will retrieve all field codes and special characters
        System.out.println("GetText() Result: " + doc.getText());
        
        // ToString will export the node to the specified format. When converted to text it will not retrieve fields code
        // or special characters, but will still contain some natural formatting characters such as paragraph markers etc.
        // This is the same as "viewing" the document as if it was opened in a text editor.
        System.out.println("ToString() Result: " + doc.toString(SaveFormat.TEXT));

        Example:

        Exports the content of a node to string in HTML format using default options.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        // Extract the last paragraph in the document to convert to HTML.
        Node node = doc.getLastSection().getBody().getLastParagraph();
        
        // When ToString is called using the SaveFormat overload then conversion is executed using default save options.
        // When saving to HTML using default options the following settings are set:
        //   ExportImagesAsBase64 = true
        //   CssStyleSheetType = CssStyleSheetType.Inline
        //   ExportFontResources = false
        String nodeAsHtml = node.toString(SaveFormat.HTML);