GroupShape class
GroupShape class
Represents a group of shapes in a document. To learn more, visit the How to Add Group Shape into a Word Document documentation article.
Remarks
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 Aspose.Words.Drawing.ShapeBase.CoordSize and Aspose.Words.Drawing.ShapeBase.CoordOrigin properties.
Inheritance: GroupShape → ShapeBase → CompositeNode → Node
Constructors
| Name | Description |
|---|---|
| GroupShape(doc) | Creates a new group shape. |
Properties
| Name | Description |
|---|---|
| allowOverlap | Gets or sets a value that specifies whether this shape can overlap other shapes. (Inherited from ShapeBase) |
| alternativeText | Defines alternative text to be displayed instead of a graphic. (Inherited from ShapeBase) |
| anchorLocked | Specifies whether the shape’s anchor is locked. (Inherited from ShapeBase) |
| aspectRatioLocked | Specifies whether the shape’s aspect ratio is locked. (Inherited from ShapeBase) |
| behindText | Specifies whether the shape is below or above text. (Inherited from ShapeBase) |
| bottom | Gets the position of the bottom edge of the containing block of the shape. (Inherited from ShapeBase) |
| bounds2 | Gets or sets the location and size of the containing block of the shape. (Inherited from ShapeBase) |
| boundsInPoints2 | Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape. (Inherited from ShapeBase) |
| boundsWithEffects2 | Gets final extent that this shape object has after applying drawing effects. Value is measured in points. (Inherited from ShapeBase) |
| canHaveImage | Returns true if the shape type allows the shape to have an image.(Inherited from ShapeBase) |
| coordOrigin2 | The coordinates at the top-left corner of the containing block of this shape. (Inherited from ShapeBase) |
| coordSize2 | The width and height of the coordinate space inside the containing block of this shape. (Inherited from ShapeBase) |
| count | Gets the number of immediate children of this node. (Inherited from CompositeNode) |
| customNodeId | Specifies custom node identifier. (Inherited from Node) |
| distanceBottom | Returns or sets the distance (in points) between the document text and the bottom edge of the shape. (Inherited from ShapeBase) |
| distanceLeft | Returns or sets the distance (in points) between the document text and the left edge of the shape. (Inherited from ShapeBase) |
| distanceRight | Returns or sets the distance (in points) between the document text and the right edge of the shape. (Inherited from ShapeBase) |
| distanceTop | Returns or sets the distance (in points) between the document text and the top edge of the shape. (Inherited from ShapeBase) |
| document | Gets the document to which this node belongs. (Inherited from Node) |
| fill | Gets fill formatting for the shape. (Inherited from ShapeBase) |
| firstChild | Gets the first child of the node. (Inherited from CompositeNode) |
| flipOrientation | Switches the orientation of a shape. (Inherited from ShapeBase) |
| font | Provides access to the font formatting of this object. (Inherited from ShapeBase) |
| glow | Gets glow formatting for the shape. (Inherited from ShapeBase) |
| hasChildNodes | Returns true if this node has any child nodes.(Inherited from CompositeNode) |
| height | Gets or sets the height of the containing block of the shape. (Inherited from ShapeBase) |
| heightRelative | Gets or sets the value that represents the percentage of shape’s relative height. (Inherited from ShapeBase) |
| hidden | Gets or sets a boolean value indicating whether the shape is visible. (Inherited from ShapeBase) |
| horizontalAlignment | Specifies how the shape is positioned horizontally. (Inherited from ShapeBase) |
| href | Gets or sets the full hyperlink address for a shape. (Inherited from ShapeBase) |
| isComposite | Returns true if this node can contain other nodes.(Inherited from Node) |
| isDecorative | Gets or sets the flag that specifies whether the shape is decorative in the document. (Inherited from ShapeBase) |
| isDeleteRevision | Returns true if this object was deleted in Microsoft Word while change tracking was enabled. (Inherited from ShapeBase) |
| isGroup | Returns true if this is a group shape.(Inherited from ShapeBase) |
| isHorizontalRule | Returns true if this shape is a horizontal rule.(Inherited from ShapeBase) |
| isImage | Returns true if this shape is an image shape.(Inherited from ShapeBase) |
| isInline | A quick way to determine if this shape is positioned inline with text. (Inherited from ShapeBase) |
| isInsertRevision | Returns true if this object was inserted in Microsoft Word while change tracking was enabled. (Inherited from ShapeBase) |
| isLayoutInCell | Gets or sets a flag indicating whether the shape is displayed inside a table or outside of it. (Inherited from ShapeBase) |
| isMoveFromRevision | Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.(Inherited from ShapeBase) |
| isMoveToRevision | Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.(Inherited from ShapeBase) |
| isSignatureLine | Indicates that shape is a SignatureLine. (Inherited from ShapeBase) |
| isTopLevel | Returns true if this shape is not a child of a group shape.(Inherited from ShapeBase) |
| isWordArt | Returns true if this shape is a WordArt object.(Inherited from ShapeBase) |
| lastChild | Gets the last child of the node. (Inherited from CompositeNode) |
| left | Gets or sets the position of the left edge of the containing block of the shape. (Inherited from ShapeBase) |
| leftRelative | Gets or sets the value that represents shape’s relative left position in percent. (Inherited from ShapeBase) |
| markupLanguage | Gets MarkupLanguage used for this graphic object. (Inherited from ShapeBase) |
| name | Gets or sets the optional shape name. (Inherited from ShapeBase) |
| nextSibling | Gets the node immediately following this node. (Inherited from Node) |
| nodeType | Returns NodeType.GroupShape. |
| parentNode | Gets the immediate parent of this node. (Inherited from Node) |
| parentParagraph | Returns the immediate parent paragraph. (Inherited from ShapeBase) |
| previousSibling | Gets the node immediately preceding this node. (Inherited from Node) |
| range | Returns a Range object that represents the portion of a document that is contained in this node. (Inherited from Node) |
| reflection | Gets reflection formatting for the shape. (Inherited from ShapeBase) |
| relativeHorizontalPosition | Specifies relative to what the shape is positioned horizontally. (Inherited from ShapeBase) |
| relativeHorizontalSize | Gets or sets the value of shape’s relative size in horizontal direction. (Inherited from ShapeBase) |
| relativeVerticalPosition | Specifies relative to what the shape is positioned vertically. (Inherited from ShapeBase) |
| relativeVerticalSize | Gets or sets the value of shape’s relative size in vertical direction. (Inherited from ShapeBase) |
| right | Gets the position of the right edge of the containing block of the shape. (Inherited from ShapeBase) |
| rotation | Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle. (Inherited from ShapeBase) |
| screenTip | Defines the text displayed when the mouse pointer moves over the shape. (Inherited from ShapeBase) |
| shadowFormat | Gets shadow formatting for the shape. (Inherited from ShapeBase) |
| shapeType | Gets the shape type. (Inherited from ShapeBase) |
| sizeInPoints2 | Gets the size of the shape in points. (Inherited from ShapeBase) |
| softEdge | Gets soft edge formatting for the shape. (Inherited from ShapeBase) |
| target | Gets or sets the target frame for the shape hyperlink. (Inherited from ShapeBase) |
| title | Gets or sets the title (caption) of the current shape object. (Inherited from ShapeBase) |
| top | Gets or sets the position of the top edge of the containing block of the shape. (Inherited from ShapeBase) |
| topRelative | Gets or sets the value that represents shape’s relative top position in percent. (Inherited from ShapeBase) |
| verticalAlignment | Specifies how the shape is positioned vertically. (Inherited from ShapeBase) |
| width | Gets or sets the width of the containing block of the shape. (Inherited from ShapeBase) |
| widthRelative | Gets or sets the value that represents the percentage of shape’s relative width. (Inherited from ShapeBase) |
| wrapSide | Specifies how the text is wrapped around the shape. (Inherited from ShapeBase) |
| wrapType | Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape. (Inherited from ShapeBase) |
| zorder | Determines the display order of overlapping shapes. (Inherited from ShapeBase) |
Methods
| Name | Description |
|---|---|
| adjustWithEffects(source) | Adds to the source rectangle values of the effect extent and returns the final rectangle. (Inherited from ShapeBase) |
| appendChild(newChild) | Adds the specified node to the end of the list of child nodes for this node. (Inherited from CompositeNode) |
| asBody() | Cast node to Body. (Inherited from Node) |
| asBookmarkEnd() | Cast node to BookmarkEnd. (Inherited from Node) |
| asBookmarkStart() | Cast node to BookmarkStart. (Inherited from Node) |
| asBuildingBlock() | Cast node to BuildingBlock. (Inherited from Node) |
| asCell() | Cast node to Cell. (Inherited from Node) |
| asComment() | Cast node to Comment. (Inherited from Node) |
| asCommentRangeEnd() | Cast node to CommentRangeEnd. (Inherited from Node) |
| asCommentRangeStart() | Cast node to CommentRangeStart. (Inherited from Node) |
| asCompositeNode() | Cast node to CompositeNode. (Inherited from Node) |
| asDocument() | Cast node to Node.document. (Inherited from Node) |
| asEditableRangeEnd() | Cast node to EditableRangeEnd. (Inherited from Node) |
| asEditableRangeStart() | Cast node to EditableRangeStart. (Inherited from Node) |
| asFieldEnd() | Cast node to FieldEnd. (Inherited from Node) |
| asFieldSeparator() | Cast node to FieldSeparator. (Inherited from Node) |
| asFieldStart() | Cast node to FieldStart. (Inherited from Node) |
| asFootnote() | Cast node to Footnote. (Inherited from Node) |
| asFormField() | Cast node to FormField. (Inherited from Node) |
| asGlossaryDocument() | Cast node to GlossaryDocument. (Inherited from Node) |
| asGroupShape() | Cast node to GroupShape. (Inherited from Node) |
| asHeaderFooter() | Cast node to HeaderFooter. (Inherited from Node) |
| asOfficeMath() | Cast node to OfficeMath. (Inherited from Node) |
| asParagraph() | Cast node to Paragraph. (Inherited from Node) |
| asRow() | Cast node to Row. (Inherited from Node) |
| asRun() | Cast node to Run. (Inherited from Node) |
| asSection() | Cast node to Section. (Inherited from Node) |
| asShape() | Cast node to Shape. (Inherited from Node) |
| asSmartTag() | Cast node to SmartTag. (Inherited from Node) |
| asSpecialChar() | Cast node to SpecialChar. (Inherited from Node) |
| asStructuredDocumentTag() | Cast node to StructuredDocumentTag. (Inherited from Node) |
| asStructuredDocumentTagRangeEnd() | Cast node to StructuredDocumentTagRangeEnd. (Inherited from Node) |
| asStructuredDocumentTagRangeStart() | Cast node to StructuredDocumentTagRangeStart. (Inherited from Node) |
| asSubDocument() | Cast node to SubDocument. (Inherited from Node) |
| asTable() | Cast node to Table. (Inherited from Node) |
| clone(isCloneChildren) | Creates a duplicate of the node. (Inherited from Node) |
| getAncestor(ancestorType) | Gets the first ancestor of the specified NodeType. (Inherited from Node) |
| getBuildingBlock(index, isDeep) | Returns an Nth child BuildingBlock node. (Inherited from CompositeNode) |
| getChild(nodeType, index, isDeep) | Returns an Nth child node that matches the specified type. (Inherited from CompositeNode) |
| getChildNodes(nodeType, isDeep) | Returns a live collection of child nodes that match the specified type. (Inherited from CompositeNode) |
| getComment(index, isDeep) | Returns an Nth child Comment node. (Inherited from CompositeNode) |
| getEditableRangeStart(index, isDeep) | Returns an Nth child EditableRangeStart node. (Inherited from CompositeNode) |
| getFootnote(index, isDeep) | Returns an Nth child Footnote node. (Inherited from CompositeNode) |
| getGroupShape(index, isDeep) | Returns an Nth child GroupShape node. (Inherited from CompositeNode) |
| getOfficeMath(index, isDeep) | Returns an Nth child OfficeMath node. (Inherited from CompositeNode) |
| getParagraph(index, isDeep) | Returns an Nth child Paragraph node. (Inherited from CompositeNode) |
| getRun(index, isDeep) | Returns an Nth child Run node. (Inherited from CompositeNode) |
| getSdt(index, isDeep) | Returns an Nth child StructuredDocumentTag node. (Inherited from CompositeNode) |
| getSdtRangeEnd(index, isDeep) | Returns an Nth child StructuredDocumentTagRangeEnd node. (Inherited from CompositeNode) |
| getSdtRangeStart(index, isDeep) | Returns an Nth child StructuredDocumentTagRangeStart node. (Inherited from CompositeNode) |
| getShape(index, isDeep) | Returns an Nth child Shape node. (Inherited from CompositeNode) |
| getShapeRenderer() | Creates and returns an object that can be used to render this shape into an image. (Inherited from ShapeBase) |
| getSmartTag(index, isDeep) | Returns an Nth child SmartTag node. (Inherited from CompositeNode) |
| getTable(index, isDeep) | Returns an Nth child Table node. (Inherited from CompositeNode) |
| getText() | Gets the text of this node and of all its children. (Inherited from Node) |
| indexOf(child) | Returns the index of the specified child node in the child node array. (Inherited from CompositeNode) |
| insertAfter(newChild, refChild) | Inserts the specified node immediately after the specified reference node. (Inherited from CompositeNode) |
| insertBefore(newChild, refChild) | Inserts the specified node immediately before the specified reference node. (Inherited from CompositeNode) |
| localToParent(value) | Converts a value from the local coordinate space into the coordinate space of the parent shape. (Inherited from ShapeBase) |
| nextPreOrder(rootNode) | Gets next node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| nodeTypeToString(nodeType) | A utility method that converts a node type enum value into a user friendly string. (Inherited from Node) |
| prependChild(newChild) | Adds the specified node to the beginning of the list of child nodes for this node. (Inherited from CompositeNode) |
| previousPreOrder(rootNode) | Gets the previous node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| referenceEquals(other) | (Inherited from Node) |
| remove() | Removes itself from the parent. (Inherited from Node) |
| removeAllChildren() | Removes all the child nodes of the current node. (Inherited from CompositeNode) |
| removeChild(oldChild) | Removes the specified child node. (Inherited from CompositeNode) |
| removeSmartTags() | Removes all SmartTag descendant nodes of the current node. (Inherited from CompositeNode) |
| selectNodes(xpath) | Selects a list of nodes matching the XPath expression. (Inherited from CompositeNode) |
| selectSingleNode(xpath) | Selects the first Node that matches the XPath expression. (Inherited from CompositeNode) |
| toString(saveFormat) | Exports the content of the node into a string in the specified format. (Inherited from Node) |
| toString(saveOptions) | Exports the content of the node into a string using the specified save options. (Inherited from Node) |
See Also
- module Aspose.Words.Drawing
- class ShapeBase
- class Shape