ShapeBase Class
Base class for objects in the drawing layer, such as an AutoShape, freeform, OLE object, ActiveX control, or picture.
Inheritance Hierarchy

Namespace: Aspose.Words.Drawing
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 19.12
Syntax
public abstract class ShapeBase : CompositeNode

The ShapeBase type exposes the following members.

Constructors
  NameDescription
Protected methodShapeBase
Initializes a new instance of the ShapeBase class
Properties
  NameDescription
Public propertyCode exampleAllowOverlap
Gets or sets a value that specifies whether this shape can overlap other shapes.
Public propertyCode exampleAlternativeText
Defines alternative text to be displayed instead of a graphic.
Public propertyCode exampleAnchorLocked
Specifies whether the shape's anchor is locked.
Public propertyCode exampleAspectRatioLocked
Specifies whether the shape's aspect ratio is locked.
Public propertyCode exampleBehindText
Specifies whether the shape is below or above text.
Public propertyCode exampleBottom
Gets the position of the bottom edge of the containing block of the shape.
Public propertyCode exampleBounds
Gets or sets the location and size of the containing block of the shape.
Public propertyCode exampleBoundsInPoints
Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape.
Public propertyCode exampleBoundsWithEffects
Gets final extent that this shape object has after applying drawing effects. Value is measured in points.
Public propertyCode exampleCanHaveImage
Returns true if the shape type allows the shape to have an image.
Public propertyCode exampleChildNodes
Gets all immediate child nodes of this node.
(Inherited from CompositeNode.)
Public propertyCode exampleCoordOrigin
The coordinates at the top-left corner of the containing block of this shape.
Public propertyCode exampleCoordSize
The width and height of the coordinate space inside the containing block of this shape.
Public propertyCode exampleCount
Gets the number of immediate children of this node.
(Inherited from CompositeNode.)
Public propertyCode exampleDistanceBottom
Returns or sets the distance (in points) between the document text and the bottom edge of the shape.
Public propertyCode exampleDistanceLeft
Returns or sets the distance (in points) between the document text and the left edge of the shape.
Public propertyCode exampleDistanceRight
Returns or sets the distance (in points) between the document text and the right edge of the shape.
Public propertyCode exampleDistanceTop
Returns or sets the distance (in points) between the document text and the top edge of the shape.
Public propertyCode exampleDocument
Gets the document to which this node belongs.
(Inherited from Node.)
Public propertyCode exampleFirstChild
Gets the first child of the node.
(Inherited from CompositeNode.)
Public propertyCode exampleFlipOrientation
Switches the orientation of a shape.
Public propertyCode exampleFont
Provides access to the font formatting of this object.
Public propertyCode exampleHasChildNodes
Returns true if this node has any child nodes.
(Inherited from CompositeNode.)
Public propertyCode exampleHeight
Gets or sets the height of the containing block of the shape.
Public propertyCode exampleHorizontalAlignment
Specifies how the shape is positioned horizontally.
Public propertyCode exampleHRef
Gets or sets the full hyperlink address for a shape.
Public propertyCode exampleIsComposite
Returns true as this node can have child nodes.
(Inherited from CompositeNode.)
Public propertyCode exampleIsDeleteRevision
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
Public propertyCode exampleIsGroup
Returns true if this is a group shape.
Public propertyCode exampleIsHorizontalRule
Returns true if this shape is a horizontal rule.
Public propertyCode exampleIsImage
Returns true if this shape is an image shape.
Public propertyCode exampleIsInline
A quick way to determine if this shape is positioned inline with text.
Public propertyCode exampleIsInsertRevision
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
Public propertyCode exampleIsLayoutInCell
Gets or sets a flag indicating whether the shape is displayed inside a table or outside of it.
Public propertyCode exampleIsMoveFromRevision
Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
Public propertyCode exampleIsMoveToRevision
Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
Public propertyCode exampleIsSignatureLine
Indicates that shape is a SignatureLine.
Public propertyCode exampleIsTopLevel
Returns true if this shape is not a child of a group shape.
Public propertyCode exampleIsWordArt
Returns true if this shape is a WordArt object.
Public propertyCode exampleLastChild
Gets the last child of the node.
(Inherited from CompositeNode.)
Public propertyCode exampleLeft
Gets or sets the position of the left edge of the containing block of the shape.
Public propertyCode exampleMarkupLanguage
Gets MarkupLanguage used for this graphic object.
Public propertyCode exampleName
Gets or sets the optional shape name.
Public propertyCode exampleNextSibling
Gets the node immediately following this node.
(Inherited from Node.)
Public propertyCode exampleNodeType
Gets the type of this node.
(Inherited from Node.)
Public propertyCode exampleParentNode
Gets the immediate parent of this node.
(Inherited from Node.)
Public propertyCode exampleParentParagraph
Returns the immediate parent paragraph.
Public propertyCode examplePreviousSibling
Gets the node immediately preceding this node.
(Inherited from Node.)
Public propertyCode exampleRange
Returns a Range object that represents the portion of a document that is contained in this node.
(Inherited from Node.)
Public propertyCode exampleRelativeHorizontalPosition
Specifies relative to what the shape is positioned horizontally.
Public propertyCode exampleRelativeVerticalPosition
Specifies relative to what the shape is positioned vertically.
Public propertyCode exampleRight
Gets the position of the right edge of the containing block of the shape.
Public propertyCode exampleRotation
Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle.
Public propertyCode exampleScreenTip
Defines the text displayed when the mouse pointer moves over the shape.
Public propertyCode exampleShapeType
Gets the shape type.
Public propertyCode exampleSizeInPoints
Gets the size of the shape in points.
Public propertyCode exampleTarget
Gets or sets the target frame for the shape hyperlink.
Public propertyCode exampleTitle
Gets or sets the title (caption) of the current shape object.
Public propertyCode exampleTop
Gets or sets the position of the top edge of the containing block of the shape.
Public propertyCode exampleVerticalAlignment
Specifies how the shape is positioned vertically.
Public propertyCode exampleWidth
Gets or sets the width of the containing block of the shape.
Public propertyCode exampleWrapSide
Specifies how the text is wrapped around the shape.
Public propertyCode exampleWrapType
Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape.
Public propertyCode exampleZOrder
Determines the display order of overlapping shapes.
Methods
  NameDescription
Public methodCode exampleAccept
Accepts a visitor.
(Inherited from Node.)
Protected methodAcceptChildren (Inherited from CompositeNode.)
Protected methodAcceptCore (Inherited from CompositeNode.)
Public methodCode exampleAdjustWithEffects
Adds to the source rectangle values of the effect extent and returns the final rectangle.
Public methodCode exampleAppendChild
Adds the specified node to the end of the list of child nodes for this node.
(Inherited from CompositeNode.)
Public methodCode exampleClone (Inherited from Node.)
Protected methodCoreRemoveSelfOnly (Inherited from CompositeNode.)
Public methodCode exampleCreateNavigator
Reserved for system use. IXPathNavigable.
(Inherited from CompositeNode.)
Public methodEquals (Inherited from Object.)
Public methodFetchInheritedShapeAttr
Reserved for system use. IShapeAttrSource.
Public methodFetchShapeAttr
Reserved for system use. IShapeAttrSource.
Protected methodFinalize (Inherited from Object.)
Public methodCode exampleGetAncestor(Type)
Gets the first ancestor of the specified object type.
(Inherited from Node.)
Public methodCode exampleGetAncestor(NodeType)
Gets the first ancestor of the specified NodeType.
(Inherited from Node.)
Public methodCode exampleGetChild
Returns an Nth child node that matches the specified type.
(Inherited from CompositeNode.)
Public methodCode exampleGetChildNodes
Returns a live collection of child nodes that match the specified type.
(Inherited from CompositeNode.)
Public methodGetDirectShapeAttr
Reserved for system use. IShapeAttrSource.
Public methodCode exampleGetEnumerator
Provides support for the for each style iteration over the child nodes of this node.
(Inherited from CompositeNode.)
Public methodGetHashCode (Inherited from Object.)
Public methodCode exampleGetShapeRenderer
Creates and returns an object that can be used to render this shape into an image.
Public methodCode exampleGetText
Gets the text of this node and of all its children.
(Inherited from CompositeNode.)
Public methodGetType (Inherited from Object.)
Public methodCode exampleIndexOf
Returns the index of the specified child node in the child node array.
(Inherited from CompositeNode.)
Public methodCode exampleInsertAfter
Inserts the specified node immediately after the specified reference node.
(Inherited from CompositeNode.)
Public methodCode exampleInsertBefore
Inserts the specified node immediately before the specified reference node.
(Inherited from CompositeNode.)
Public methodCode exampleLocalToParent
Converts a value from the local coordinate space into the coordinate space of the parent shape.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodCode exampleNextPreOrder
Gets next node according to the pre-order tree traversal algorithm.
(Inherited from Node.)
Public methodCode examplePrependChild
Adds the specified node to the beginning of the list of child nodes for this node.
(Inherited from CompositeNode.)
Public methodCode examplePreviousPreOrder
Gets the previous node according to the pre-order tree traversal algorithm.
(Inherited from Node.)
Public methodCode exampleRemove
Removes itself from the parent.
(Inherited from Node.)
Public methodCode exampleRemoveAllChildren
Removes all the child nodes of the current node.
(Inherited from CompositeNode.)
Public methodCode exampleRemoveChild
Removes the specified child node.
(Inherited from CompositeNode.)
Public methodRemoveShapeAttr
Reserved for system use. IShapeAttrSource.
Public methodCode exampleRemoveSmartTags
Removes all SmartTag descendant nodes of the current node.
(Inherited from CompositeNode.)
Public methodCode exampleSelectNodes
Selects a list of nodes matching the XPath expression.
(Inherited from CompositeNode.)
Public methodCode exampleSelectSingleNode
Selects the first Node that matches the XPath expression.
(Inherited from CompositeNode.)
Public methodSetShapeAttr
Reserved for system use. IShapeAttrSource.
Public methodToString (Inherited from Object.)
Public methodCode exampleToString(SaveFormat)
Exports the content of the node into a string in the specified format.
(Inherited from Node.)
Public methodCode exampleToString(SaveOptions)
Exports the content of the node into a string using the specified save options.
(Inherited from Node.)
Remarks

This is an abstract class. The two derived classes that you can instantiate are Shape and GroupShape.

A shape is a node in the document tree.

If the shape is a child of a Paragraph object, then the shape is said to be "top-level". Top-level shapes are measured and positioned in points.

A shape can also occur as a child of a GroupShape object when several shapes are grouped. Child shapes of a group shape are positioned in the coordinate space and units defined by the CoordSize and CoordOrigin properties of the parent group shape.

A shape can be positioned inline with text or floating. The positioning method is controlled using the WrapType property.

When a shape is floating, it is positioned relative to something (e.g the current paragraph, the margin or the page). The relative positioning of the shape is specified using the RelativeHorizontalPosition and RelativeVerticalPosition properties.

A floating shape be positioned explicitly using the Left and Top properties or aligned relative to some other object using the HorizontalAlignment and VerticalAlignment properties.

Examples
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(MyDir + "Images/Aspose.Words.gif");

// Make the image float, put it behind text and center on the page.
shape.WrapType = WrapType.None;
shape.BehindText = true;
shape.RelativeHorizontalPosition = RelativeHorizontalPosition.Page;
shape.HorizontalAlignment = HorizontalAlignment.Center;
shape.RelativeVerticalPosition = RelativeVerticalPosition.Page;
shape.VerticalAlignment = VerticalAlignment.Center;

builder.Document.Save(ArtifactsDir + "Image.CreateFloatingPageCenter.doc");
See Also