com.aspose.words
Class Shape

java.lang.Object
  extended by Node
      extended by CompositeNode
          extended by ShapeBase
              extended by com.aspose.words.Shape
All Implemented Interfaces:
java.lang.Iterable, java.lang.Cloneable, java.lang.Iterable

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 node.
// 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, false);
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, false);
groupShapes.clear();

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() + "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() + "Image.CreateFloatingPageCenter Out.doc");

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<Shape> shapes = doc.getChildNodes(NodeType.SHAPE, true, false);

// 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<Shape> shapesToDelete = new ArrayList<Shape>();
for (Shape shape : shapes)
{
   // Several shape types can have an image including image shapes and OLE objects.
   if (shape.canHaveImage())
        shapesToDelete.add(shape);
}

// Now we can delete shapes.
for (Shape shape : shapesToDelete)
    shape.remove();

Example:

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

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

        }
    }
}

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

Example:

Opens an HTML document with images from a stream with a base URI.
// We are opening this HTML file:
/*
    <html>
    <body>
    <p>Simple file.</p>
    <p><img src="Aspose.Words.gif" width="80" height="60"></p>
    </body>
    </html>
*/
String fileName = getMyDir() + "Document.OpenFromStreamWithBaseUri.html";

// Open the stream.
InputStream stream = new FileInputStream(fileName);

// Open the document. Note the Document constructor detects HTML format automatically.
// Pass the URI of the base folder so any images with relative URIs in the file can be found.
Document doc = new Document(stream, getMyDir());

// You can close the stream now, it is no longer needed because the document is in memory.
stream.close();

// Lets make sure the image was imported successfully into a Shape node.
// Get the 1st shape node in the document.
Shape shape = (Shape)doc.getChild(NodeType.SHAPE, 0, true);

// Verify some properties of the image.
Assert.assertTrue(shape.isImage());
Assert.assertNotNull(shape.getImageData().getImageBytes());
Assert.assertEquals(80.0, ConvertUtil.pointToPixel(shape.getWidth()));
Assert.assertEquals(60.0, ConvertUtil.pointToPixel(shape.getHeight()));

// Save in the DOC format.
doc.save(getMyDir() + "Document.OpenFromStreamWithBaseUri Out.doc");
See Also:
ShapeBase, GroupShape

Constructor Summary
Shape(DocumentBase doc, int shapeType)
           Creates a new shape object.
 
Property Getters/Setters Summary
booleangetAllowOverlap()→ inherited from ShapeBase
voidsetAllowOverlap(boolean value)
           Gets or sets a value that specifies whether this shape can overlap other shapes.
java.lang.StringgetAlternativeText()→ inherited from ShapeBase
voidsetAlternativeText(java.lang.String value)
           Defines alternative text to be displayed instead of a graphic.
booleangetAnchorLocked()→ inherited from ShapeBase
voidsetAnchorLocked(boolean value)
           Specifies whether the shape's anchor is locked.
booleangetBehindText()→ inherited from ShapeBase
voidsetBehindText(boolean value)
           Specifies whether the shape is below or above text.
doublegetBottom()→ inherited from ShapeBase
           Gets the position of the bottom edge of the containing block of the shape.
java.awt.geom.Rectangle2D.FloatgetBounds()→ inherited from ShapeBase
voidsetBounds(java.awt.geom.Rectangle2D.Float value)
           Gets or sets the location and size of the containing block of the shape.
java.awt.geom.Rectangle2D.FloatgetBoundsInPoints()→ inherited from ShapeBase
           Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape.
booleancanHaveImage()→ inherited from ShapeBase
           Returns true if the shape type allows the shape to have an image. Image shapes and OLE objects can have an image.
NodeCollectiongetChildNodes()→ inherited from CompositeNode
           Gets all immediate child nodes of this node.
java.awt.PointgetCoordOrigin()→ inherited from ShapeBase
voidsetCoordOrigin(java.awt.Point value)
           The coordinates at the top-left corner of the containing block of this shape.
java.awt.DimensiongetCoordSize()→ inherited from ShapeBase
voidsetCoordSize(java.awt.Dimension value)
           The width and height of the coordinate space inside the containing block of this shape.
intgetCount()→ inherited from CompositeNode
           Gets the number of immediate children of this node.
doublegetDistanceBottom()→ inherited from ShapeBase
voidsetDistanceBottom(double value)
           Returns or sets the distance (in points) between the document text and the bottom edge of the shape.
doublegetDistanceLeft()→ inherited from ShapeBase
voidsetDistanceLeft(double value)
           Returns or sets the distance (in points) between the document text and the left edge of the shape.
doublegetDistanceRight()→ inherited from ShapeBase
voidsetDistanceRight(double value)
           Returns or sets the distance (in points) between the document text and the right edge of the shape.
doublegetDistanceTop()→ inherited from ShapeBase
voidsetDistanceTop(double value)
           Returns or sets the distance (in points) between the document text and the top edge of the shape.
DocumentBasegetDocument()→ inherited from Node
           Gets the document to which this node belongs.
FillgetFill()
           Defines a fill for a shape.
java.awt.ColorgetFillColor()
voidsetFillColor(java.awt.Color value)
           Defines the brush color that fills the closed path of the shape.
booleangetFilled()
voidsetFilled(boolean value)
           Determines whether the closed path of the shape will be filled.
NodegetFirstChild()→ inherited from CompositeNode
           Gets the first child of the node.
ParagraphgetFirstParagraph()
           Gets the first paragraph in the shape.
intgetFlipOrientation()→ inherited from ShapeBase
voidsetFlipOrientation(int value)
           Switches the orientation of a shape. The value of the property is FlipOrientation integer constant.
booleanhasChildNodes()→ inherited from CompositeNode
           Returns true if this node has any child nodes.
booleanhasImage()
           Returns true if the shape has image bytes or links an image.
doublegetHeight()→ inherited from ShapeBase
voidsetHeight(double value)
           Gets or sets the height of the containing block of the shape.
intgetHorizontalAlignment()→ inherited from ShapeBase
voidsetHorizontalAlignment(int value)
           Specifies how the shape is positioned horizontally. The value of the property is HorizontalAlignment integer constant.
java.lang.StringgetHRef()→ inherited from ShapeBase
voidsetHRef(java.lang.String value)
           Gets or sets the full hyperlink address for a shape.
ImageDatagetImageData()
           Provides access to the image of the shape. For a shape that cannot have an image, returns null.
booleanisComposite()→ inherited from CompositeNode
           Returns true as this node can have child nodes.
booleanisDeleteRevision()→ inherited from ShapeBase
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisGroup()→ inherited from ShapeBase
           Returns true if this is a group shape.
booleanisHorizontalRule()→ inherited from ShapeBase
           Returns true if this shape is a horizontal rule.
booleanisImage()→ inherited from ShapeBase
           Returns true if this shape is an image shape.
booleanisInline()→ inherited from ShapeBase
           A quick way to determine if this shape is positioned inline with text.
booleanisInsertRevision()→ inherited from ShapeBase
           Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
booleanisTopLevel()→ inherited from ShapeBase
           Returns true if this shape is not a child of a group shape.
booleanisWordArt()→ inherited from ShapeBase
           Returns true if this shape is a WordArt object.
NodegetLastChild()→ inherited from CompositeNode
           Gets the last child of the node.
ParagraphgetLastParagraph()
           Gets the last paragraph in the shape.
doublegetLeft()→ inherited from ShapeBase
voidsetLeft(double value)
           Gets or sets the position of the left edge of the containing block of the shape.
java.lang.StringgetName()→ inherited from ShapeBase
voidsetName(java.lang.String value)
           Gets or sets the optional shape name.
NodegetNextSibling()→ inherited from Node
           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()→ inherited from Node
           Gets the immediate parent of this node.
ParagraphgetParentParagraph()→ inherited from ShapeBase
           Returns the immediate parent paragraph.
NodegetPreviousSibling()→ inherited from Node
           Gets the node immediately preceding this node.
RangegetRange()→ inherited from Node
           Returns a Range object that represents the portion of a document that is contained in this node.
intgetRelativeHorizontalPosition()→ inherited from ShapeBase
voidsetRelativeHorizontalPosition(int value)
           Specifies relative to what the shape is positioned horizontally. The value of the property is RelativeHorizontalPosition integer constant.
intgetRelativeVerticalPosition()→ inherited from ShapeBase
voidsetRelativeVerticalPosition(int value)
           Specifies relative to what the shape is positioned horizontally. The value of the property is RelativeVerticalPosition integer constant.
doublegetRight()→ inherited from ShapeBase
           Gets the position of the right edge of the containing block of the shape.
doublegetRotation()→ inherited from ShapeBase
voidsetRotation(double value)
           Defines the angle (in degrees) that a shape is rotated.
java.lang.StringgetScreenTip()→ inherited from ShapeBase
voidsetScreenTip(java.lang.String value)
           Defines the text displayed when the mouse pointer moves over the shape.
intgetShapeType()→ inherited from ShapeBase
           Gets the shape type. The value of the property is ShapeType integer constant.
intgetStoryType()
           Returns StoryType.TEXTBOX. The value of the property is StoryType integer constant.
StrokegetStroke()
           Defines a stroke for a shape.
java.awt.ColorgetStrokeColor()
voidsetStrokeColor(java.awt.Color value)
           Defines the color of a stroke.
booleangetStroked()
voidsetStroked(boolean value)
           Defines whether the path will be stroked.
doublegetStrokeWeight()
voidsetStrokeWeight(double value)
           Defines the brush thickness that strokes the path of a shape in points.
java.lang.StringgetTarget()→ inherited from ShapeBase
voidsetTarget(java.lang.String value)
           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).
doublegetTop()→ inherited from ShapeBase
voidsetTop(double value)
           Gets or sets the position of the top edge of the containing block of the shape.
intgetVerticalAlignment()→ inherited from ShapeBase
voidsetVerticalAlignment(int value)
           Specifies how the shape is positioned vertically. The value of the property is VerticalAlignment integer constant.
doublegetWidth()→ inherited from ShapeBase
voidsetWidth(double value)
           Gets or sets the width of the containing block of the shape.
intgetWrapSide()→ inherited from ShapeBase
voidsetWrapSide(int value)
           Specifies how the text is wrapped around the shape. The value of the property is WrapSide integer constant.
intgetWrapType()→ inherited from ShapeBase
voidsetWrapType(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.
intgetZOrder()→ inherited from ShapeBase
voidsetZOrder(int value)
           Determines the display order of overlapping shapes.
 
Method Summary
booleanaccept(DocumentVisitor visitor)
           Accepts a visitor.
NodeappendChild(Node newChild)→ inherited from CompositeNode
           Adds the specified node to the end of the list of child nodes for this node.
voidclearRunAttrs()→ inherited from ShapeBase
          Reserved for internal use.
NodedeepClone(boolean isCloneChildren)
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedRunAttr(int fontAttr)→ inherited from ShapeBase
          Reserved for internal use.
java.lang.ObjectfetchInheritedShapeAttr(int key)→ inherited from ShapeBase
          Reserved for internal use.
java.lang.ObjectfetchShapeAttr(int key)→ inherited from ShapeBase
          Reserved for internal use.
NodegetAncestor(int ancestorType)→ inherited from Node
           Gets the first ancestor of the specified NodeType.
NodegetAncestor(java.lang.Class ancestorType)→ inherited from Node
           Gets the first ancestor of the specified object type.
NodegetChild(int nodeType, int index, boolean isDeep)→ inherited from CompositeNode
           Returns an Nth child node that matches the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep)→ inherited from CompositeNode
           Returns a live collection of child nodes that match the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep, boolean isLive)→ inherited from CompositeNode
           Returns a "live" or "snapshot" collection of child node that match the specified type.
java.lang.ObjectgetDirectRunAttr(int fontAttr)→ inherited from ShapeBase
          Reserved for internal use.
voidgetDirectRunAttrByIndex(int index, int[] key, java.lang.Object[] value)→ inherited from ShapeBase
          Reserved for internal use.
intgetDirectRunAttrsCount()→ inherited from ShapeBase
          Reserved for internal use.
java.lang.ObjectgetDirectShapeAttr(int key)→ inherited from ShapeBase
          Reserved for internal use.
DocumentBasegetDocument()→ inherited from ShapeBase
          Reserved for internal use.
ParagraphgetParentParagraph()→ inherited from ShapeBase
          Reserved for internal use.
Aspose.Words.RunPrgetRunPr()→ inherited from ShapeBase
          Reserved for internal use.
java.awt.geom.Point2D.FloatgetSizeInPoints()→ inherited from ShapeBase
           Gets the size of the shape in points.
Aspose.Words.RunPrgetSrcRunPr()→ inherited from ShapeBase
          Reserved for internal use.
java.lang.StringgetText()→ inherited from CompositeNode
           Gets the text of this node and of all its children.
intindexOf(Node child)→ inherited from CompositeNode
           Returns the index of the specified child node in the child node array.
NodeinsertAfter(Node newChild, Node refChild)→ inherited from CompositeNode
           Inserts the specified node immediately after the specified reference node.
NodeinsertBefore(Node newChild, Node refChild)→ inherited from CompositeNode
           Inserts the specified node immediately before the specified reference node.
java.util.Iteratoriterator()→ inherited from CompositeNode
           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)→ inherited from ShapeBase
           Converts a value from the local coordinate space into the coordinate space of the parent shape.
NodenextPreOrder(Node rootNode)→ inherited from Node
           Gets next node according to the pre-order tree traversal algorithm.
NodeprependChild(Node newChild)→ inherited from CompositeNode
           Adds the specified node to the beginning of the list of child nodes for this node.
NodepreviousPreOrder(Node rootNode)→ inherited from Node
           Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()→ inherited from Node
           Removes itself from the parent.
voidremoveAllChildren()→ inherited from CompositeNode
           Removes all the child nodes of the current node.
NoderemoveChild(Node oldChild)→ inherited from CompositeNode
           Removes the specified child node.
NodeListselectNodes(java.lang.String xpath)→ inherited from CompositeNode
           Selects a list of nodes matching the XPath expression.
NodeselectSingleNode(java.lang.String xpath)→ inherited from CompositeNode
           Selects the first Node that matches the XPath expression.
voidsetId(int id)→ inherited from ShapeBase
          Reserved for internal use.
voidsetRunAttr(int fontAttr, java.lang.Object value)→ inherited from ShapeBase
          Reserved for internal use.
voidsetShapeAttr(int key, java.lang.Object value)→ inherited from ShapeBase
          Reserved for internal use.
java.lang.StringtoTxt()→ inherited from Node
           Exports the content of the node into a string in plain text 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:

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() + "Hammer.wmf");
shape.setWidth(100);
shape.setHeight(100);

doc.getFirstSection().getBody().getFirstParagraph().appendChild(shape);

doc.save(getMyDir() + "Image.CreateImageDirectly Out.doc");

Property Getters/Setters Detail

getNodeType

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

getStoryType

public int getStoryType()
Returns StoryType.TEXTBOX. The value of the property is StoryType integer constant.

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.


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.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);
builder.insertNode(shape);

builder.getDocument().save(getMyDir() + "Shape.Fill Out.doc");

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.


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.


getStroke

public Stroke getStroke()
Defines a stroke for a shape.

getFill

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

Example:

Demonstrates how to create shapes with fill.
DocumentBuilder builder = new DocumentBuilder();

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);
builder.insertNode(shape);

builder.getDocument().save(getMyDir() + "Shape.Fill Out.doc");

hasImage

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

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<Shape> shapes = doc.getChildNodes(NodeType.SHAPE, true, false);

// 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<Shape> shapesToDelete = new ArrayList<Shape>();
for (Shape shape : shapes)
{
   // Several shape types can have an image including image shapes and OLE objects.
   if (shape.canHaveImage())
        shapesToDelete.add(shape);
}

// Now we can delete shapes.
for (Shape shape : shapesToDelete)
    shape.remove();

Example:

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

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

        }
    }
}

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

getImageData

public ImageData getImageData()
Provides access to the image of the shape. For a shape that cannot have an image, returns null.

Not all shapes can have an image. If a shape cannot have an image this property returns null.

Whether a shape can have an image or not depends on its ShapeType. Only ShapeType.IMAGE, ShapeType.OLE_CONTROL, ShapeType.OLE_OBJECT can have an image.

Example:

Shows how to insert a linked image into a document.
DocumentBuilder builder = new DocumentBuilder();

String imageFileName = getMyDir() + "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() + "Image.CreateLinkedImage Out.doc");

Example:

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

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

        }
    }
}

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

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.

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

getFirstParagraph

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

getLastParagraph

public Paragraph getLastParagraph()
Gets the last paragraph in the shape.

getShapeType

→ inherited from ShapeBase
public int getShapeType()
Gets the shape type. The value of the property is ShapeType integer constant.

isGroup

→ inherited from ShapeBase
public boolean isGroup()
Returns true if this is a group shape.

isImage

→ inherited from ShapeBase
public boolean isImage()
Returns true if this shape is an image shape.

Example:

Opens an HTML document with images from a stream with a base URI.
// We are opening this HTML file:
/*
    <html>
    <body>
    <p>Simple file.</p>
    <p><img src="Aspose.Words.gif" width="80" height="60"></p>
    </body>
    </html>
*/
String fileName = getMyDir() + "Document.OpenFromStreamWithBaseUri.html";

// Open the stream.
InputStream stream = new FileInputStream(fileName);

// Open the document. Note the Document constructor detects HTML format automatically.
// Pass the URI of the base folder so any images with relative URIs in the file can be found.
Document doc = new Document(stream, getMyDir());

// You can close the stream now, it is no longer needed because the document is in memory.
stream.close();

// Lets make sure the image was imported successfully into a Shape node.
// Get the 1st shape node in the document.
Shape shape = (Shape)doc.getChild(NodeType.SHAPE, 0, true);

// Verify some properties of the image.
Assert.assertTrue(shape.isImage());
Assert.assertNotNull(shape.getImageData().getImageBytes());
Assert.assertEquals(80.0, ConvertUtil.pointToPixel(shape.getWidth()));
Assert.assertEquals(60.0, ConvertUtil.pointToPixel(shape.getHeight()));

// Save in the DOC format.
doc.save(getMyDir() + "Document.OpenFromStreamWithBaseUri Out.doc");

isHorizontalRule

→ inherited from ShapeBase
public boolean isHorizontalRule()
Returns true if this shape is a horizontal rule.

isWordArt

→ inherited from ShapeBase
public boolean isWordArt()
Returns true if this shape is a WordArt object.

canHaveImage

→ inherited from ShapeBase
public boolean canHaveImage()
Returns true if the shape type allows the shape to have an image. Image shapes and OLE objects can have an image.

getLeft/setLeft

→ inherited from ShapeBase
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() + "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() + "Image.CreateFloatingPositionSize Out.doc");

getTop/setTop

→ inherited from ShapeBase
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() + "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() + "Image.CreateFloatingPositionSize Out.doc");

getRight

→ inherited from ShapeBase
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.


getBottom

→ inherited from ShapeBase
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.


getWidth/setWidth

→ inherited from ShapeBase
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() + "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() + "Image.ScaleImage Out.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() + "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() + "Image.CreateFloatingPositionSize Out.doc");

Example:

Opens an HTML document with images from a stream with a base URI.
// We are opening this HTML file:
/*
    <html>
    <body>
    <p>Simple file.</p>
    <p><img src="Aspose.Words.gif" width="80" height="60"></p>
    </body>
    </html>
*/
String fileName = getMyDir() + "Document.OpenFromStreamWithBaseUri.html";

// Open the stream.
InputStream stream = new FileInputStream(fileName);

// Open the document. Note the Document constructor detects HTML format automatically.
// Pass the URI of the base folder so any images with relative URIs in the file can be found.
Document doc = new Document(stream, getMyDir());

// You can close the stream now, it is no longer needed because the document is in memory.
stream.close();

// Lets make sure the image was imported successfully into a Shape node.
// Get the 1st shape node in the document.
Shape shape = (Shape)doc.getChild(NodeType.SHAPE, 0, true);

// Verify some properties of the image.
Assert.assertTrue(shape.isImage());
Assert.assertNotNull(shape.getImageData().getImageBytes());
Assert.assertEquals(80.0, ConvertUtil.pointToPixel(shape.getWidth()));
Assert.assertEquals(60.0, ConvertUtil.pointToPixel(shape.getHeight()));

// Save in the DOC format.
doc.save(getMyDir() + "Document.OpenFromStreamWithBaseUri Out.doc");

getHeight/setHeight

→ inherited from ShapeBase
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() + "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() + "Image.ScaleImage Out.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() + "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() + "Image.CreateFloatingPositionSize Out.doc");

Example:

Opens an HTML document with images from a stream with a base URI.
// We are opening this HTML file:
/*
    <html>
    <body>
    <p>Simple file.</p>
    <p><img src="Aspose.Words.gif" width="80" height="60"></p>
    </body>
    </html>
*/
String fileName = getMyDir() + "Document.OpenFromStreamWithBaseUri.html";

// Open the stream.
InputStream stream = new FileInputStream(fileName);

// Open the document. Note the Document constructor detects HTML format automatically.
// Pass the URI of the base folder so any images with relative URIs in the file can be found.
Document doc = new Document(stream, getMyDir());

// You can close the stream now, it is no longer needed because the document is in memory.
stream.close();

// Lets make sure the image was imported successfully into a Shape node.
// Get the 1st shape node in the document.
Shape shape = (Shape)doc.getChild(NodeType.SHAPE, 0, true);

// Verify some properties of the image.
Assert.assertTrue(shape.isImage());
Assert.assertNotNull(shape.getImageData().getImageBytes());
Assert.assertEquals(80.0, ConvertUtil.pointToPixel(shape.getWidth()));
Assert.assertEquals(60.0, ConvertUtil.pointToPixel(shape.getHeight()));

// Save in the DOC format.
doc.save(getMyDir() + "Document.OpenFromStreamWithBaseUri Out.doc");

getBounds/setBounds

→ inherited from ShapeBase
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.

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 cros 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() + "Shape.LineFlipOrientation Out.doc");

getBoundsInPoints

→ inherited from ShapeBase
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.

getFlipOrientation/setFlipOrientation

→ inherited from ShapeBase
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 cros 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() + "Shape.LineFlipOrientation Out.doc");

getRelativeHorizontalPosition/setRelativeHorizontalPosition

→ inherited from ShapeBase
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() + "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() + "Image.CreateFloatingPageCenter Out.doc");

getRelativeVerticalPosition/setRelativeVerticalPosition

→ inherited from ShapeBase
public int getRelativeVerticalPosition() / public void setRelativeVerticalPosition(int value)
Specifies relative to what the shape is positioned horizontally. 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() + "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() + "Image.CreateFloatingPageCenter Out.doc");

getHorizontalAlignment/setHorizontalAlignment

→ inherited from ShapeBase
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() + "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() + "Image.CreateFloatingPageCenter Out.doc");

getVerticalAlignment/setVerticalAlignment

→ inherited from ShapeBase
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() + "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() + "Image.CreateFloatingPageCenter Out.doc");

getWrapType/setWrapType

→ inherited from ShapeBase
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() + "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() + "Image.CreateFloatingPageCenter Out.doc");

getWrapSide/setWrapSide

→ inherited from ShapeBase
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.


getAnchorLocked/setAnchorLocked

→ inherited from ShapeBase
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.


getAllowOverlap/setAllowOverlap

→ inherited from ShapeBase
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 behaviour 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.


getBehindText/setBehindText

→ inherited from ShapeBase
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() + "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() + "Image.CreateFloatingPageCenter Out.doc");
See Also:
ZOrder

getDistanceTop/setDistanceTop

→ inherited from ShapeBase
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.


getDistanceBottom/setDistanceBottom

→ inherited from ShapeBase
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

→ inherited from ShapeBase
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

→ inherited from ShapeBase
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.


isInline

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

Has effect only for top level shapes.


getZOrder/setZOrder

→ inherited from ShapeBase
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.

See Also:
BehindText

getRotation/setRotation

→ inherited from ShapeBase
public double getRotation() / public void setRotation(double value)
Defines the angle (in degrees) that a shape is rotated.

The default value is 0.


getCoordOrigin/setCoordOrigin

→ inherited from ShapeBase
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

→ inherited from ShapeBase
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).


getScreenTip/setScreenTip

→ inherited from ShapeBase
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() + "Hammer.wmf");
shape.setHRef("http://www.aspose.com/Community/Forums/75/ShowForum.aspx");
shape.setScreenTip("Aspose.Words Support Forums");

builder.getDocument().save(getMyDir() + "Image.InsertImageWithHyperlink Out.doc");

getHRef/setHRef

→ inherited from ShapeBase
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: http://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: http://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() + "Hammer.wmf");
shape.setHRef("http://www.aspose.com/Community/Forums/75/ShowForum.aspx");
shape.setScreenTip("Aspose.Words Support Forums");

builder.getDocument().save(getMyDir() + "Image.InsertImageWithHyperlink Out.doc");

getTarget/setTarget

→ inherited from ShapeBase
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.


getAlternativeText/setAlternativeText

→ inherited from ShapeBase
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.


isTopLevel

→ inherited from ShapeBase
public boolean isTopLevel()
Returns true if this shape is not a child of a group shape.

getParentParagraph

→ inherited from ShapeBase
public Paragraph getParentParagraph()
Returns the immediate parent paragraph. For child shapes of a group shape always returns null.

isInsertRevision

→ inherited from ShapeBase
public boolean isInsertRevision()
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.

isDeleteRevision

→ inherited from ShapeBase
public boolean isDeleteRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

getName/setName

→ inherited from ShapeBase
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.


isComposite

→ inherited from CompositeNode
public boolean isComposite()
Returns true as this node can have child nodes.

hasChildNodes

→ inherited from CompositeNode
public boolean hasChildNodes()
Returns true if this node has any child nodes.

getChildNodes

→ inherited from CompositeNode
public NodeCollection getChildNodes()
Gets all immediate child nodes of this node.

Note, ChildNodes is equivalent to calling GetChildNodes(NodeType.Any, false) and creates and returns a new collection every time it is accessed.

If there are no child nodes, this property returns an empty collection.

Example:

Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.
NodeCollection<Node> children = paragraph.getChildNodes();
for (Node child : children)
{
    // Paragraph may contain children of various types such as runs, shapes and so on.
    if (child.getNodeType() == NodeType.RUN)
    {
        // Say we found the node that we want, do something useful.
        Run run = (Run)child;
        System.out.println(run.getText());
    }
}

getFirstChild

→ inherited from CompositeNode
public Node getFirstChild()
Gets the first child of the node. If there is no first child node, a null is returned.

Example:

Shows how to enumerate immediate child nodes of a composite node using NextSibling. In this example we enumerate all paragraphs of a section body.
// Get the section that we want to work on.
Section section = doc.getSections().get(0);
Body body = section.getBody();

// Loop starting from the first child until we reach null.
for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling())
{
    // Output the types of the nodes that we come across.
    System.out.println(node.getNodeType());
}

Example:

Shows how to efficiently visit all direct and indirect children of a composite node.
public void recurseAllNodes() throws Exception
{
    // Open a document.
    Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc");

    // Invoke the recursive function that will walk the tree.
    traverseAllNodes(doc);
}

/// <summary>
/// A simple function that will walk through all children of a specified node recursively
/// and print the type of each node to the screen.
/// </summary>
private void traverseAllNodes(CompositeNode parentNode)
{
    // This is the most efficient way to loop through immediate children of a node.
    for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling())
    {
        // Do some useful work.
        System.out.println(childNode.getNodeType());

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

getLastChild

→ inherited from CompositeNode
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);

getCount

→ inherited from CompositeNode
public int getCount()
Gets the number of immediate children of this node.

getParentNode

→ inherited from Node
public CompositeNode getParentNode()
Gets the immediate parent of this node.

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

Example:

Shows how to access the parent node.
// Create a new empty document. It has one section.
Document doc = new Document();

// The section is the first child node of the document.
Node section = doc.getFirstChild();

// The section's parent node is the document.
Assert.assertEquals(doc, section.getParentNode());

Example:

Shows that when you create any node, it requires a document that will own the node.
// Open a file from disk.
Document doc = new Document();

// Creating a new node of any type requires a document passed into the constructor.
Paragraph para = new Paragraph(doc);

// The new paragraph node does not yet have a parent.
Assert.assertNull(para.getParentNode());

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

// The fact that a node always belongs to a document allows us to access and modify
// properties that reference the document-wide data such as styles or lists.
para.getParagraphFormat().setStyleName("Heading 1");

// Now add the paragaph to the main text of the first section.
doc.getFirstSection().getBody().appendChild(para);

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

getDocument

→ inherited from Node
public DocumentBase getDocument()
Gets the document to which this node belongs.

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

Example:

Shows that when you create any node, it requires a document that will own the node.
// Open a file from disk.
Document doc = new Document();

// Creating a new node of any type requires a document passed into the constructor.
Paragraph para = new Paragraph(doc);

// The new paragraph node does not yet have a parent.
Assert.assertNull(para.getParentNode());

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

// The fact that a node always belongs to a document allows us to access and modify
// properties that reference the document-wide data such as styles or lists.
para.getParagraphFormat().setStyleName("Heading 1");

// Now add the paragaph to the main text of the first section.
doc.getFirstSection().getBody().appendChild(para);

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

getPreviousSibling

→ inherited from Node
public Node getPreviousSibling()
Gets the node immediately preceding this node.

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

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

Example:

Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.
// Document is a CompositeNode and LastChild returns the last child node in the Document node.
// Since the Document can contain only Section nodes, the last child is the last section.
Node lastSection = doc.getLastChild();

// Each node knows its next and previous sibling nodes.
// Previous sibling of a section is a section before the specified section.
// If the node is the first child, PreviousSibling will return null.
Node sectionBeforeLast = lastSection.getPreviousSibling();

if (sectionBeforeLast != null)
    doc.removeChild(sectionBeforeLast);

getNextSibling

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

Example:

Shows how to enumerate immediate child nodes of a composite node using NextSibling. In this example we enumerate all paragraphs of a section body.
// Get the section that we want to work on.
Section section = doc.getSections().get(0);
Body body = section.getBody();

// Loop starting from the first child until we reach null.
for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling())
{
    // Output the types of the nodes that we come across.
    System.out.println(node.getNodeType());
}

Example:

Shows how to efficiently visit all direct and indirect children of a composite node.
public void recurseAllNodes() throws Exception
{
    // Open a document.
    Document doc = new Document(getMyDir() + "Node.RecurseAllNodes.doc");

    // Invoke the recursive function that will walk the tree.
    traverseAllNodes(doc);
}

/// <summary>
/// A simple function that will walk through all children of a specified node recursively
/// and print the type of each node to the screen.
/// </summary>
private void traverseAllNodes(CompositeNode parentNode)
{
    // This is the most efficient way to loop through immediate children of a node.
    for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling())
    {
        // Do some useful work.
        System.out.println(childNode.getNodeType());

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

getRange

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

Method Detail

getSizeInPoints

→ inherited from ShapeBase
public java.awt.geom.Point2D.Float getSizeInPoints()
                     throws java.lang.Exception
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.


accept

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

Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

For more info see the Visitor design pattern.

Calls DocumentVisitor.visitShapeStart(com.aspose.words.Shape), then calls accept(com.aspose.words.DocumentVisitor) for all child nodes of the shape and calls DocumentVisitor.visitShapeEnd(com.aspose.words.Shape) at the end.
Parameters:
visitor - The visitor that will visit the nodes.
Returns:
True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

deepClone

public Node deepClone(boolean isCloneChildren)
              throws java.lang.Exception
Creates a duplicate of the node.

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

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

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

localToParent

→ inherited from ShapeBase
public java.awt.geom.Point2D.Float localToParent(java.awt.geom.Point2D.Float value)
                   throws java.lang.Exception
Converts a value from the local coordinate space into the coordinate space of the parent shape.

getText

→ inherited from CompositeNode
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.


getChildNodes

→ inherited from CompositeNode
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.

getChildNodes

→ inherited from CompositeNode
public NodeCollection getChildNodes(int nodeType, boolean isDeep, boolean isLive)
Returns a "live" or "snapshot" collection of child node that match the specified type.

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

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

A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.

Parameters:
nodeType - A NodeType value. Specifies the type of nodes to select.
isDeep - True to select from all child nodes recursively. False to select only among immediate children.
isLive - True to return a live collection; false to return a snapshot collection.
Returns:
A collection of child nodes of the specified type.

Example:

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

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

        }
    }
}

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

getChild

→ inherited from CompositeNode
public Node getChild(int nodeType, int index, boolean isDeep)
Returns an Nth child node that matches the specified type.

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

Parameters:
nodeType - A NodeType value. Specifies the type of the child node.
index - Zero based index of the child node to select. Negative indexes are also allowed and indicate access from the end, that is -1 means the last node.
isDeep - True to select from all child nodes recursively. False to select only among immediate children.
Returns:
The child node that matches the criteria or null if no matching node is found.

selectNodes

→ inherited from CompositeNode
public NodeList selectNodes(java.lang.String xpath)
Selects a list of nodes matching the XPath expression.

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

Parameters:
xpath - The XPath expression.
Returns:
A list of nodes matching the XPath query.

Example:

Finds all hyperlinks in a Word document and changes their URL and display name.
import com.aspose.words.*;
import java.lang.Exception;
import java.text.MessageFormat;
import java.util.regex.Pattern;
import java.util.regex.Matcher;

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

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

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

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

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

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

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

        mFieldStart = fieldStart;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

selectSingleNode

→ inherited from CompositeNode
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.

iterator

→ inherited from CompositeNode
public java.util.Iterator iterator()
Provides support for the for each style iteration over the child nodes of this node.

Example:

Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.
NodeCollection<Node> children = paragraph.getChildNodes();
for (Node child : children)
{
    // Paragraph may contain children of various types such as runs, shapes and so on.
    if (child.getNodeType() == NodeType.RUN)
    {
        // Say we found the node that we want, do something useful.
        Run run = (Run)child;
        System.out.println(run.getText());
    }
}

appendChild

→ inherited from CompositeNode
public Node appendChild(Node newChild)
                throws java.lang.Exception
Adds the specified node to the end of the list of child nodes for this node.

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use 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 pararagraph in the document.
// The document is valid and can be saved, but lets add some text before saving.
// Create a new run of text and add it to our paragraph.
Run run = new Run(doc);
run.setText("Hello World!");
run.getFont().setColor(Color.RED);
para.appendChild(run);


// As a matter of interest, you can retrieve text of the whole document and
// see that \u000c is automatically appended. \u000c is the end of section character.
Assert.assertEquals("Hello World!\u000c", doc.getText());

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

prependChild

→ inherited from CompositeNode
public Node prependChild(Node newChild)
                 throws java.lang.Exception
Adds the specified node to the beginning of the list of child nodes for this node.

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use 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.

insertAfter

→ inherited from CompositeNode
public Node insertAfter(Node newChild, Node refChild)
                throws java.lang.Exception
Inserts the specified node immediately after the specified reference node.

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

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use 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.

insertBefore

→ inherited from CompositeNode
public Node insertBefore(Node newChild, Node refChild)
                 throws java.lang.Exception
Inserts the specified node immediately before the specified reference node.

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

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

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use 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.

removeChild

→ inherited from CompositeNode
public Node removeChild(Node oldChild)
                throws java.lang.Exception
Removes the specified child node.

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

Parameters:
oldChild - The node to remove.
Returns:
The removed node.

Example:

Demonstrates use of methods of Node and CompositeNode to remove a section before the last section in the document.
// Document is a CompositeNode and LastChild returns the last child node in the Document node.
// Since the Document can contain only Section nodes, the last child is the last section.
Node lastSection = doc.getLastChild();

// Each node knows its next and previous sibling nodes.
// Previous sibling of a section is a section before the specified section.
// If the node is the first child, PreviousSibling will return null.
Node sectionBeforeLast = lastSection.getPreviousSibling();

if (sectionBeforeLast != null)
    doc.removeChild(sectionBeforeLast);

removeAllChildren

→ inherited from CompositeNode
public void removeAllChildren()
                      throws java.lang.Exception
Removes all the child nodes of the current node.

Example:

Creates a simple document from scratch using the Aspose.Words object model.
// Create an "empty" document. Note that like in Microsoft Word,
// the empty document has one section, body and one paragraph in it.
Document doc = new Document();

// This truly makes the document empty. No sections (not possible in Microsoft Word).
doc.removeAllChildren();


// Create a new section node.
// Note that the section has not yet been added to the document,
// but we have to specify the parent document.
Section section = new Section(doc);

// Append the section to the document.
doc.appendChild(section);

// Lets set some properties for the section.
section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
section.getPageSetup().setPaperSize(PaperSize.LETTER);


// The section that we created is empty, lets populate it. The section needs at least the Body node.
Body body = new Body(doc);
section.appendChild(body);


// The body needs to have at least one paragraph.
// Note that the paragraph has not yet been added to the document,
// but we have to specify the parent document.
// The parent document is needed so the paragraph can correctly work
// with styles and other document-wide information.
Paragraph para = new Paragraph(doc);
body.appendChild(para);

// We can set some formatting for the paragraph
para.getParagraphFormat().setStyleName("Heading 1");
para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);


// So far we have one empty pararagraph in the document.
// The document is valid and can be saved, but lets add some text before saving.
// Create a new run of text and add it to our paragraph.
Run run = new Run(doc);
run.setText("Hello World!");
run.getFont().setColor(Color.RED);
para.appendChild(run);


// As a matter of interest, you can retrieve text of the whole document and
// see that \u000c is automatically appended. \u000c is the end of section character.
Assert.assertEquals("Hello World!\u000c", doc.getText());

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

indexOf

→ inherited from CompositeNode
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.

getAncestor

→ inherited from Node
public Node getAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.

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

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

getAncestor

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

remove

→ inherited from Node
public void remove()
           throws java.lang.Exception
Removes itself from the parent.

Example:

Shows how to remove all nodes of a specific type from a composite node. In this example we remove tables from a section body.
// Get the section that we want to work on.
Section section = doc.getSections().get(0);
Body body = section.getBody();

// Select the first child node in the body.
Node curNode = body.getFirstChild();

while (curNode != null)
{
    // Save the pointer to the next sibling node because if the current
    // node is removed from the parent in the next step, we will have
    // no way of finding the next node to continue the loop.
    Node nextNode = curNode.getNextSibling();

    // A section body can contain Paragraph and Table nodes.
    // If the node is a Table, remove it from the parent.
    if (curNode.getNodeType() == NodeType.TABLE)
        curNode.remove();

    // Continue going through child nodes until null (no more siblings) is reached.
    curNode = nextNode;
}

nextPreOrder

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

Example:

Shows how to delete all images from a document using pre-order tree traversal.
Node curNode = doc;
while (curNode != null)
{
    Node nextNode = curNode.nextPreOrder(doc);

    if (curNode.getNodeType() == NodeType.SHAPE)
    {
        Shape shape = (Shape)curNode;

        // Several shape types can have an image including image shapes and OLE objects.
        if (shape.canHaveImage())
            shape.remove();
    }

    curNode = nextNode;
}

previousPreOrder

→ inherited from Node
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.

toTxt

→ inherited from Node
public java.lang.String toTxt()
            throws java.lang.Exception
Exports the content of the node into a string in plain text format.

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

Returns:
The content of the node in plain text format.
See Also:
SaveOptions.TxtExportParagraphBreak, SaveOptions.TxtExportHeadersFooters

setId

→ inherited from ShapeBase
public void setId(int id)
Reserved for internal use.

getDirectRunAttr

→ inherited from ShapeBase
public java.lang.Object getDirectRunAttr(int fontAttr)
Reserved for internal use.

getDirectRunAttrsCount

→ inherited from ShapeBase
public int getDirectRunAttrsCount()
Reserved for internal use.

getDirectRunAttrByIndex

→ inherited from ShapeBase
public void getDirectRunAttrByIndex(int index, int[] key, java.lang.Object[] value)
Reserved for internal use.

fetchInheritedRunAttr

→ inherited from ShapeBase
public java.lang.Object fetchInheritedRunAttr(int fontAttr)
                            throws java.lang.Exception
Reserved for internal use.

setRunAttr

→ inherited from ShapeBase
public void setRunAttr(int fontAttr, java.lang.Object value)
Reserved for internal use.

clearRunAttrs

→ inherited from ShapeBase
public void clearRunAttrs()
Reserved for internal use.

getSrcRunPr

→ inherited from ShapeBase
public Aspose.Words.RunPr getSrcRunPr()
Reserved for internal use.

getRunPr

→ inherited from ShapeBase
public Aspose.Words.RunPr getRunPr()
Reserved for internal use.

getParentParagraph

→ inherited from ShapeBase
public Paragraph getParentParagraph()
Reserved for internal use.

getDocument

→ inherited from ShapeBase
public DocumentBase getDocument()
Reserved for internal use.

getDirectShapeAttr

→ inherited from ShapeBase
public java.lang.Object getDirectShapeAttr(int key)
Reserved for internal use.

fetchInheritedShapeAttr

→ inherited from ShapeBase
public java.lang.Object fetchInheritedShapeAttr(int key)
                              throws java.lang.Exception
Reserved for internal use.

fetchShapeAttr

→ inherited from ShapeBase
public java.lang.Object fetchShapeAttr(int key)
                     throws java.lang.Exception
Reserved for internal use.

setShapeAttr

→ inherited from ShapeBase
public void setShapeAttr(int key, java.lang.Object value)
Reserved for internal use.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.