GroupShape
Overview
GroupShape is a class in Aspose.Words FOSS for .NET.
Inherits from: ShapeBase.
Represents a group of shapes in a document.
This class provides 29 methods for working with GroupShape objects in .NET programs.
Available methods include: Accept, AcceptEnd, AcceptStart, AdjustWithEffects, AppendChild, Clone, CreateNavigator, GetAncestor, GetAncestorOf, GetChild, GetChildNodes, GetEnumerator, and 17 additional methods.
All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package.
Properties: AllowOverlap, AlternativeText, AnchorLocked, AspectRatioLocked, BehindText, Bottom, and 71 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
NodeType | NodeType | Read | Returns GroupShape. |
Fill | Fill | Read | Gets fill formatting for the shape. |
ShadowFormat | ShadowFormat | Read | Gets shadow formatting for the shape. |
Glow | GlowFormat | Read | Gets glow formatting for the shape. |
Reflection | ReflectionFormat | Read | Gets reflection formatting for the shape. |
SoftEdge | SoftEdgeFormat | Read | Gets soft edge formatting for the shape. |
ScreenTip | string | Read/Write | Defines the text displayed when the mouse pointer moves over the shape. |
HRef | string | Read/Write | Gets or sets the full hyperlink address for a shape. |
Target | string | Read/Write | Gets or sets the target frame for the shape hyperlink. |
AlternativeText | string | Read/Write | Defines alternative text to be displayed instead of a graphic. |
IsDecorative | bool | Read/Write | Gets or sets the flag that specifies whether the shape is decorative in the document. |
Title | string | Read/Write | Gets or sets the title (caption) of the current shape object. |
Name | string | Read/Write | Gets or sets the optional shape name. |
IsInsertRevision | bool | Read | Gets the is insert revision. |
IsDeleteRevision | bool | Read | Gets the is delete revision. |
IsMoveFromRevision | bool | Read | Gets the is move from revision. |
IsMoveToRevision | bool | Read | Gets the is move to revision. |
IsTopLevel | bool | Read | Returns true if this shape is not a child of a group shape. |
IsGroup | bool | Read | Returns true if this is a group shape. |
IsImage | bool | Read | Returns true if this shape is an image shape. |
IsHorizontalRule | bool | Read | Returns true if this shape is a horizontal rule. |
IsWordArt | bool | Read | Returns true if this shape is a WordArt object. |
CanHaveImage | bool | Read | Returns true if the shape type allows the shape to have an image. |
AnchorLocked | bool | Read/Write | Specifies whether the shape’s anchor is locked. |
AspectRatioLocked | bool | Read/Write | Specifies whether the shape’s aspect ratio is locked. |
AllowOverlap | bool | Read/Write | Gets or sets a value that specifies whether this shape can overlap other shapes. |
BehindText | bool | Read/Write | Specifies whether the shape is below or above text. |
IsInline | bool | Read | A quick way to determine if this shape is positioned inline with text. |
Left | double | Read/Write | Gets or sets the position of the left edge of the containing block of the shape. |
Top | double | Read/Write | Gets or sets the position of the top edge of the containing block of the shape. |
Right | double | Read | Gets the position of the right edge of the containing block of the shape. |
Bottom | double | Read | Gets the position of the bottom edge of the containing block of the shape. |
Width | double | Read/Write | Gets or sets the width of the containing block of the shape. |
Height | double | Read/Write | Gets or sets the height of the containing block of the shape. |
DistanceTop | double | Read/Write | Returns or sets the distance (in points) between the document text and the top edge of the shape. |
DistanceBottom | double | Read/Write | Returns or sets the distance (in points) between the document text and the bottom edge of the shape. |
DistanceLeft | double | Read/Write | Returns or sets the distance (in points) between the document text and the left edge of the shape. |
DistanceRight | double | Read/Write | Returns or sets the distance (in points) between the document text and the right edge of the shape. |
Rotation | double | Read/Write | Defines the angle (in degrees) that a shape is rotated. |
ZOrder | int | Read/Write | Determines the display order of overlapping shapes. |
ParentParagraph | Paragraph | Read | Returns the immediate parent paragraph. |
Bounds | RectangleF | Read/Write | Gets or sets the location and size of the containing block of the shape. |
BoundsInPoints | RectangleF | Read | Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape. |
BoundsWithEffects | RectangleF | Read | Gets final extent that this shape object has after applying drawing effects. |
ShapeType | ShapeType | Read | Gets the shape type. |
MarkupLanguage | ShapeMarkupLanguage | Read | Gets MarkupLanguage used for this graphic object. |
SizeInPoints | SizeF | Read | Gets the size of the shape in points. |
FlipOrientation | FlipOrientation | Read/Write | Switches the orientation of a shape. |
RelativeHorizontalPosition | RelativeHorizontalPosition | Read/Write | Specifies relative to what the shape is positioned horizontally. |
RelativeVerticalPosition | RelativeVerticalPosition | Read/Write | Specifies relative to what the shape is positioned vertically. |
RelativeHorizontalSize | RelativeHorizontalSize | Read/Write | Gets or sets the value of shape’s relative size in horizontal direction. |
RelativeVerticalSize | RelativeVerticalSize | Read/Write | Gets or sets the value of shape’s relative size in vertical direction. |
LeftRelative | float | Read/Write | Gets or sets the value that represents shape’s relative left position in percent. |
TopRelative | float | Read/Write | Gets or sets the value that represents shape’s relative top position in percent. |
HeightRelative | float | Read/Write | Gets or sets the value that represents the percentage of shape’s relative height. |
WidthRelative | float | Read/Write | Gets or sets the value that represents the percentage of shape’s relative width. |
HorizontalAlignment | HorizontalAlignment | Read/Write | Specifies how the shape is positioned horizontally. |
VerticalAlignment | VerticalAlignment | Read/Write | Specifies how the shape is positioned vertically. |
WrapType | WrapType | Read/Write | Defines whether the shape is inline or floating. |
WrapSide | WrapSide | Read/Write | Specifies how the text is wrapped around the shape. |
CoordOrigin | Point | Read/Write | The coordinates at the top-left corner of the containing block of this shape. |
CoordSize | Size | Read/Write | The width and height of the coordinate space inside the containing block of this shape. |
Font | Font | Read | Provides access to the font formatting of this object. |
IsSignatureLine | bool | Read | Indicates that shape is a SignatureLine. |
IsLayoutInCell | bool | Read/Write | Gets or sets a flag indicating whether the shape is displayed inside a table or outside of it. |
Hidden | bool | Read/Write | Gets or sets a boolean value indicating whether the shape is visible. |
IsComposite | bool | Read | Returns true as this node can have child nodes. |
HasChildNodes | bool | Read | Returns true if this node has any child nodes. |
FirstChild | Node | Read | Gets the first child of the node. |
LastChild | Node | Read | Gets the last child of the node. |
Count | int | Read | Gets the number of immediate children of this node. |
ParentNode | CompositeNode | Read | Gets the immediate parent of this node. |
Document | DocumentBase | Read | Gets the document to which this node belongs. |
PreviousSibling | Node | Read | Gets the node immediately preceding this node. |
NextSibling | Node | Read | Gets the node immediately following this node. |
Range | Range | Read | Returns a Range object that represents the portion of a document that is contained in this node. |
CustomNodeId | int | Read/Write | Specifies custom node identifier. |
Methods
| Signature | Description |
|---|---|
GroupShape(doc: DocumentBase) | Creates a new group shape. |
Accept(visitor: DocumentVisitor) | Calls VisitGroupShapeStart, then calls Accept for all child shapes of this group shape and calls VisitGroupShapeEnd at the end. |
AcceptStart(visitor: DocumentVisitor) | Accepts a visitor for visiting the start of the GroupShape. |
AcceptEnd(visitor: DocumentVisitor) | Accepts a visitor for visiting the end of the GroupShape. |
LocalToParent(value: PointF) | Converts a value from the local coordinate space into the coordinate space of the parent shape. |
AdjustWithEffects(source: RectangleF) | Adds to the source rectangle values of the effect extent and returns the final rectangle. |
GetText() | Gets the text of this node and of all its children. |
GetChildNodes(nodeType: NodeType, isDeep: bool) | Returns a collection of child nodes that match the specified type. |
GetChild(nodeType: NodeType, index: int, isDeep: bool) | Returns an Nth child node that matches the specified type. |
SelectNodes(xpath: string) | Selects a list of nodes matching the XPath expression. |
SelectSingleNode(xpath: string) | Selects the first Node that matches the XPath expression. |
GetEnumerator() | Provides support for the for each style iteration over the child nodes of this node. |
AppendChild(newChild: T) | Adds the specified node to the end of the list of child nodes for this node. |
PrependChild(newChild: T) | Adds the specified node to the beginning of the list of child nodes for this node. |
InsertAfter(newChild: T, refChild: Node) | Inserts the specified node immediately after the specified reference node. |
InsertBefore(newChild: T, refChild: Node) | Inserts the specified node immediately before the specified reference node. |
RemoveChild(oldChild: T) | Removes the specified child node. |
RemoveAllChildren() | Removes all the child nodes of the current node. |
RemoveSmartTags() | Removes all SmartTag descendant nodes of the current node. |
IndexOf(child: Node) | Returns the index of the specified child node in the child node array. |
CreateNavigator() | Creates navigator which can be used to traverse and read nodes. |
Clone(isCloneChildren: bool) | You should use the Clone(bool, INodeCloningListener) overload when the node cloning is a part of another (usually composite) node cloning process. |
GetAncestor(ancestorType: Type) | Gets the first ancestor of the specified object type. |
GetAncestorOf() | Calls GetAncestorOf on this GroupShape instance. |
Remove() | Removes itself from the parent. |
NextPreOrder(rootNode: Node) | Gets next node according to the pre-order tree traversal algorithm. |
PreviousPreOrder(rootNode: Node) | Gets the previous node according to the pre-order tree traversal algorithm. |
ToString(saveFormat: SaveFormat) | Exports the content of the node into a string in the specified format. |
NodeTypeToString(nodeType: NodeType) | A utility method that converts a node type enum value into a user friendly string. |