com.aspose.words
Class GroupShape

com.aspose.words.CompositeNode
  extended by ShapeBase
      extended by com.aspose.words.GroupShape

public class GroupShape 
extends ShapeBase

Represents a group of shapes in a document.

A GroupShape is a composite node and can have Shape and GroupShape nodes as children.

Each GroupShape defines a new coordinate system for its child shapes. The coordinate system is defined using the CoordSize and CoordOrigin properties.

See Also:
ShapeBase, Shape

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.
booleangetAspectRatioLocked()→ inherited from ShapeBase
voidsetAspectRatioLocked(boolean value)
           Specifies whether the shape's aspect ratio 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
           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.
java.awt.geom.Rectangle2D.FloatgetBoundsWithEffects()→ inherited from ShapeBase
           Gets final extent that this shape object has after applying drawing effects. Value is measured in points.
booleancanHaveImage()→ inherited from ShapeBase
           Returns true if the shape type allows the shape to have an image.
Aspose.Words.NodeCollectiongetChildNodes()→ inherited from Aspose.Words.CompositeNode
           Gets all immediate child nodes of this node.
java.awt.PointgetCoordOrigin()→ inherited from ShapeBase
           The coordinates at the top-left corner of the containing block of this shape.
java.awt.DimensiongetCoordSize()→ inherited from ShapeBase
           The width and height of the coordinate space inside the containing block of this shape.
intgetCount()→ inherited from Aspose.Words.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.
Aspose.Words.DocumentBasegetDocument()→ inherited from Aspose.Words.Node
           Gets the document to which this node belongs.
Aspose.Words.NodegetFirstChild()→ inherited from Aspose.Words.CompositeNode
           Gets the first child of the node.
intgetFlipOrientation()→ inherited from ShapeBase
voidsetFlipOrientation(int value)
           Switches the orientation of a shape. The value of the property is FlipOrientation integer constant.
Aspose.Words.FontgetFont()→ inherited from ShapeBase
           Provides access to the font formatting of this object.
booleanhasChildNodes()→ inherited from Aspose.Words.CompositeNode
           Returns true if this node has any child nodes.
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.
booleanisComposite()→ inherited from Aspose.Words.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.
booleanisSignatureLine()→ inherited from ShapeBase
           Indicates that shape is a SignatureLine.
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.
Aspose.Words.NodegetLastChild()→ inherited from Aspose.Words.CompositeNode
           Gets the last child of the node.
doublegetLeft()→ inherited from ShapeBase
voidsetLeft(double value)
           Gets or sets the position of the left edge of the containing block of the shape.
bytegetMarkupLanguage()→ inherited from ShapeBase
           Gets MarkupLanguage used for this graphic object. The value of the property is ShapeMarkupLanguage integer constant.
java.lang.StringgetName()→ inherited from ShapeBase
voidsetName(java.lang.String value)
           Gets or sets the optional shape name.
Aspose.Words.NodegetNextSibling()→ inherited from Aspose.Words.Node
           Gets the node immediately following this node.
Aspose.Words.NodeTypegetNodeType()
           Returns #Error Cref: F:Aspose.Words.NodeType.GroupShape.
Aspose.Words.CompositeNodegetParentNode()→ inherited from Aspose.Words.Node
           Gets the immediate parent of this node.
Aspose.Words.ParagraphgetParentParagraph()→ inherited from ShapeBase
           Returns the immediate parent paragraph.
Aspose.Words.NodegetPreviousSibling()→ inherited from Aspose.Words.Node
           Gets the node immediately preceding this node.
Aspose.Words.RangegetRange()→ inherited from Aspose.Words.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 vertically. 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. Positive value corresponds to clockwise rotation angle.
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.
java.awt.DimensiongetSizeInPoints()→ inherited from ShapeBase
           Gets the size of the shape in points.
java.lang.StringgetTarget()→ inherited from ShapeBase
voidsetTarget(java.lang.String value)
           Gets or sets the target frame for the shape hyperlink.
java.lang.StringgetTitle()→ inherited from ShapeBase
voidsetTitle(java.lang.String value)
           Gets or sets the title (caption) of the current shape 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
voidclearRunAttrs()→ inherited from ShapeBase
          Reserved for internal use.
voiddd()→ inherited from Aspose.Words.CompositeNode
          
Aspose.Words.NodedeepClone(boolean isCloneChildren)→ inherited from Aspose.Words.Node
           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.
Aspose.Words.CompositeNodegetAncestor(java.lang.Class ancestorType)→ inherited from Aspose.Words.Node
           Gets the first ancestor of the specified object type.
Aspose.Words.CompositeNodegetContainer()→ inherited from Aspose.Words.CompositeNode
          Reserved for internal use.
aspose.obfuscated.typegetDeleteRevision()→ inherited from ShapeBase
          Reserved for internal use.
java.lang.ObjectgetDirectRunAttr(int fontAttr)→ 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.
Aspose.Words.DocumentBasegetDocument_IInline()→ inherited from ShapeBase
          Reserved for internal use.
aspose.obfuscated.typegetExpandedRunPr_IInline(aspose.obfuscated.type flags)→ inherited from ShapeBase
          Reserved for internal use.
aspose.obfuscated.typegetInsertRevision()→ inherited from ShapeBase
          Reserved for internal use.
aspose.obfuscated.typegetMoveFromRevision()→ inherited from ShapeBase
          Reserved for internal use.
aspose.obfuscated.typegetMoveToRevision()→ inherited from ShapeBase
          Reserved for internal use.
Aspose.Words.NodegetNextMatchingNode(aspose.obfuscated.type curNode)→ inherited from Aspose.Words.CompositeNode
          Reserved for internal use.
Aspose.Words.ParagraphgetParentParagraph_IInline()→ inherited from ShapeBase
          Reserved for internal use.
aspose.obfuscated.typegetRunPr_IInline()→ inherited from ShapeBase
          Reserved for internal use.
ShapeRenderergetShapeRenderer()→ inherited from ShapeBase
           Creates and returns an object that can be used to render this shape into an image.
java.awt.geom.Point2D.FloatgetSizeInPoints()→ inherited from ShapeBase
           Gets the size of the shape in points.
java.lang.StringgetText()→ inherited from Aspose.Words.CompositeNode
           Gets the text of this node and of all its children.
intgetZOrder_IShape()→ inherited from ShapeBase
          Reserved for internal use.
java.util.Iteratoriterator()→ inherited from Aspose.Words.CompositeNode
           Provides support for the for each style iteration over the child nodes of this node.
voidremove()→ inherited from Aspose.Words.Node
           Removes itself from the parent.
voidremoveAllChildren()→ inherited from Aspose.Words.CompositeNode
           Removes all the child nodes of the current node.
voidremoveRunAttr(int key)→ inherited from ShapeBase
          Reserved for internal use.
voidremoveShapeAttr(int key)→ inherited from ShapeBase
          Reserved for internal use.
voidremoveSmartTags()→ inherited from Aspose.Words.CompositeNode
           Removes all SmartTag descendant nodes of the current node.
Aspose.Words.NodeListselectNodes(java.lang.String xpath)→ inherited from Aspose.Words.CompositeNode
           Selects a list of nodes matching the XPath expression.
Aspose.Words.NodeselectSingleNode(java.lang.String xpath)→ inherited from Aspose.Words.CompositeNode
           Selects the first Node that matches the XPath expression.
voidsetDeleteRevision(aspose.obfuscated.type value)→ inherited from ShapeBase
          Reserved for internal use.
voidsetInsertRevision(aspose.obfuscated.type value)→ inherited from ShapeBase
          Reserved for internal use.
voidsetMoveFromRevision(aspose.obfuscated.type value)→ inherited from ShapeBase
          Reserved for internal use.
voidsetMoveToRevision(aspose.obfuscated.type value)→ inherited from ShapeBase
          Reserved for internal use.
voidsetRunAttr(int fontAttr, java.lang.Object value)→ inherited from ShapeBase
          Reserved for internal use.
voidsetRunPr_IInline(aspose.obfuscated.type value)→ inherited from ShapeBase
          Reserved for internal use.
voidsetShapeAttr(int key, java.lang.Object value)→ inherited from ShapeBase
          Reserved for internal use.
voidsetZOrder_IShape(int value)→ inherited from ShapeBase
          Reserved for internal use.
java.lang.StringtoString()→ inherited from Aspose.Words.Node
          
java.lang.StringtoString(SaveOptions saveOptions)→ inherited from Aspose.Words.Node
           Exports the content of the node into a string using the specified save options.
java.lang.StringtoTxt()→ inherited from Aspose.Words.Node
           Exports the content of the node into a string in plain text format.
 

Property Getters/Setters Detail

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 behavior of the shape in Microsoft Word. Aspose.Words ignores the value of this property.

This property is applicable only to top level shapes.

The default value is true.


getAlternativeText/setAlternativeText

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


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.


getAspectRatioLocked/setAspectRatioLocked

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

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

Has effect for top level shapes only.


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.

See Also:
ZOrder

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.


getBounds

→ inherited from ShapeBase
public java.awt.geom.Rectangle2D.Float getBounds()
Gets or sets the location and size of the containing block of the shape. Ignores aspect ratio lock upon setting.

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

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


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.

getBoundsWithEffects

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

canHaveImage

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

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


getChildNodes

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

Note, #Error Cref: P:Aspose.Words.CompositeNode.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.


getCoordOrigin

→ inherited from ShapeBase
public java.awt.Point getCoordOrigin()
The coordinates at the top-left corner of the containing block of this shape.

The default value is (0,0).


getCoordSize

→ inherited from ShapeBase
public java.awt.Dimension getCoordSize()
The width and height of the coordinate space inside the containing block of this shape.

The default value is (1000, 1000).


getCount

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

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.


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.


getDocument

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

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


getFirstChild

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

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.


getFont

→ inherited from ShapeBase
public Aspose.Words.Font getFont()
Provides access to the font formatting of this object.

hasChildNodes

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

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.


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.


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.


isComposite

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

isDeleteRevision

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

isGroup

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

isHorizontalRule

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

isImage

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

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.


isInsertRevision

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

isSignatureLine

→ inherited from ShapeBase
public boolean isSignatureLine()
Indicates that shape is a SignatureLine.

isTopLevel

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

isWordArt

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

getLastChild

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.Node getLastChild()
Gets the last child of the node. If there is no last child node, a null is returned.

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.


getMarkupLanguage

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

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.


getNextSibling

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

getNodeType

public Aspose.Words.NodeType getNodeType()
Returns #Error Cref: F:Aspose.Words.NodeType.GroupShape.

getParentNode

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


getParentParagraph

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

getPreviousSibling

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

getRange

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

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.


getRelativeVerticalPosition/setRelativeVerticalPosition

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

The default value is RelativeVerticalPosition.PARAGRAPH.

Has effect only for top level floating shapes.


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.


getRotation/setRotation

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

The default value is 0.


getScreenTip/setScreenTip

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


getShapeType

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

getSizeInPoints

→ inherited from ShapeBase
public java.awt.Dimension getSizeInPoints()
Gets the size of the shape in points.

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.


getTitle/setTitle

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

Default is empty string.

Cannot be null, but can be an empty string.


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.


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.


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.


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.


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.


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

Method Detail

clearRunAttrs

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

dd

→ inherited from Aspose.Words.CompositeNode
public void dd()

deepClone

→ inherited from Aspose.Words.Node
public Aspose.Words.Node deepClone(boolean isCloneChildren)
Creates a duplicate of the node.

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

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

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

fetchInheritedRunAttr

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

fetchInheritedShapeAttr

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

fetchShapeAttr

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

getAncestor

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

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

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

getContainer

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.CompositeNode getContainer()
Reserved for internal use.

getDeleteRevision

→ inherited from ShapeBase
public aspose.obfuscated.type getDeleteRevision()
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.

getDirectShapeAttr

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

getDocument_IInline

→ inherited from ShapeBase
public Aspose.Words.DocumentBase getDocument_IInline()
Reserved for internal use.

getExpandedRunPr_IInline

→ inherited from ShapeBase
public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags)
Reserved for internal use.

getInsertRevision

→ inherited from ShapeBase
public aspose.obfuscated.type getInsertRevision()
Reserved for internal use.

getMoveFromRevision

→ inherited from ShapeBase
public aspose.obfuscated.type getMoveFromRevision()
Reserved for internal use.

getMoveToRevision

→ inherited from ShapeBase
public aspose.obfuscated.type getMoveToRevision()
Reserved for internal use.

getNextMatchingNode

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.Node getNextMatchingNode(aspose.obfuscated.type curNode)
Reserved for internal use.

getParentParagraph_IInline

→ inherited from ShapeBase
public Aspose.Words.Paragraph getParentParagraph_IInline()
Reserved for internal use.

getRunPr_IInline

→ inherited from ShapeBase
public aspose.obfuscated.type getRunPr_IInline()
Reserved for internal use.

getShapeRenderer

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

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

Returns:
The renderer object for this shape.

getSizeInPoints

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

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


getText

→ inherited from Aspose.Words.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 Aspose.Words.ControlChar.


getZOrder_IShape

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

iterator

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

remove

→ inherited from Aspose.Words.Node
public void remove()
Removes itself from the parent.

removeAllChildren

→ inherited from Aspose.Words.CompositeNode
public void removeAllChildren()
Removes all the child nodes of the current node.

removeRunAttr

→ inherited from ShapeBase
public void removeRunAttr(int key)
Reserved for internal use.

removeShapeAttr

→ inherited from ShapeBase
public void removeShapeAttr(int key)
Reserved for internal use.

removeSmartTags

→ inherited from Aspose.Words.CompositeNode
public void removeSmartTags()
Removes all SmartTag descendant nodes of the current node. This method does not remove the content of the smart tags.

selectNodes

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

selectSingleNode

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

setDeleteRevision

→ inherited from ShapeBase
public void setDeleteRevision(aspose.obfuscated.type value)
Reserved for internal use.

setInsertRevision

→ inherited from ShapeBase
public void setInsertRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveFromRevision

→ inherited from ShapeBase
public void setMoveFromRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveToRevision

→ inherited from ShapeBase
public void setMoveToRevision(aspose.obfuscated.type value)
Reserved for internal use.

setRunAttr

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

setRunPr_IInline

→ inherited from ShapeBase
public void setRunPr_IInline(aspose.obfuscated.type value)
Reserved for internal use.

setShapeAttr

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

setZOrder_IShape

→ inherited from ShapeBase
public void setZOrder_IShape(int value)
Reserved for internal use.

toString

→ inherited from Aspose.Words.Node
public java.lang.String toString()

toString

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

toTxt

→ inherited from Aspose.Words.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 #Error Cref: M:Aspose.Words.Node.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:
TxtSaveOptions.ParagraphBreak, TxtSaveOptions.ExportHeadersFooters

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