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.
Shows how to create a group of shapes, and print its contents using a document visitor.
#include <Aspose.Words.Cpp/Drawing/GroupShape.h>
Public Member Functions | |
GroupShape (const SharedPtr< DocumentBase > &doc) | |
Creates a new group shape. More... | |
bool | Accept (SharedPtr< DocumentVisitor > visitor) override |
Accepts a visitor. More... | |
NodeType | get_NodeType () const override |
Returns GroupShape. More... | |
virtual const TypeInfo & | GetType () const override |
virtual bool | Is (const TypeInfo &target) const override |
![]() | |
RectangleF | AdjustWithEffects (RectangleF source) |
Adds to the source rectangle values of the effect extent and returns the final rectangle. More... | |
bool | get_AllowOverlap () |
Gets or sets a value that specifies whether this shape can overlap other shapes. More... | |
String | get_AlternativeText () |
Defines alternative text to be displayed instead of a graphic. More... | |
bool | get_AnchorLocked () |
Specifies whether the shape's anchor is locked. More... | |
bool | get_AspectRatioLocked () |
Specifies whether the shape's aspect ratio is locked. More... | |
bool | get_BehindText () |
Specifies whether the shape is below or above text. More... | |
double | get_Bottom () |
Gets the position of the bottom edge of the containing block of the shape. More... | |
RectangleF | get_Bounds () |
Gets or sets the location and size of the containing block of the shape. More... | |
RectangleF | get_BoundsInPoints () |
Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape. More... | |
RectangleF | get_BoundsWithEffects () |
Gets final extent that this shape object has after applying drawing effects. Value is measured in points. More... | |
bool | get_CanHaveImage () |
Returns true if the shape type allows the shape to have an image. More... | |
Point | get_CoordOrigin () |
The coordinates at the top-left corner of the containing block of this shape. More... | |
Size | get_CoordSize () |
The width and height of the coordinate space inside the containing block of this shape. More... | |
double | get_DistanceBottom () |
Returns or sets the distance (in points) between the document text and the bottom edge of the shape. More... | |
double | get_DistanceLeft () |
Returns or sets the distance (in points) between the document text and the left edge of the shape. More... | |
double | get_DistanceRight () |
Returns or sets the distance (in points) between the document text and the right edge of the shape. More... | |
double | get_DistanceTop () |
Returns or sets the distance (in points) between the document text and the top edge of the shape. More... | |
SharedPtr< Fill > | get_Fill () |
Gets fill formatting for the shape. More... | |
FlipOrientation | get_FlipOrientation () |
Switches the orientation of a shape. More... | |
SharedPtr< Font > | get_Font () |
Provides access to the font formatting of this object. More... | |
double | get_Height () |
Gets or sets the height of the containing block of the shape. More... | |
HorizontalAlignment | get_HorizontalAlignment () |
Specifies how the shape is positioned horizontally. More... | |
String | get_HRef () |
Gets or sets the full hyperlink address for a shape. More... | |
bool | get_IsDecorative () |
Gets or sets the flag that specifies whether the shape is decorative in the document. More... | |
bool | get_IsDeleteRevision () |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. More... | |
bool | get_IsGroup () |
Returns true if this is a group shape. More... | |
bool | get_IsHorizontalRule () |
Returns true if this shape is a horizontal rule. More... | |
bool | get_IsImage () |
Returns true if this shape is an image shape. More... | |
bool | get_IsInline () |
A quick way to determine if this shape is positioned inline with text. More... | |
bool | get_IsInsertRevision () |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled. More... | |
bool | get_IsLayoutInCell () |
Gets or sets a flag indicating whether the shape is displayed inside a table or outside of it. More... | |
bool | get_IsMoveFromRevision () |
Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled. More... | |
bool | get_IsMoveToRevision () |
Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled. More... | |
bool | get_IsSignatureLine () |
Indicates that shape is a SignatureLine. More... | |
bool | get_IsTopLevel () |
Returns true if this shape is not a child of a group shape. More... | |
bool | get_IsWordArt () |
Returns true if this shape is a WordArt object. More... | |
double | get_Left () |
Gets or sets the position of the left edge of the containing block of the shape. More... | |
ShapeMarkupLanguage | get_MarkupLanguage () const |
Gets MarkupLanguage used for this graphic object. More... | |
String | get_Name () |
Gets or sets the optional shape name. More... | |
SharedPtr< Paragraph > | get_ParentParagraph () |
Returns the immediate parent paragraph. More... | |
RelativeHorizontalPosition | get_RelativeHorizontalPosition () |
Specifies relative to what the shape is positioned horizontally. More... | |
RelativeVerticalPosition | get_RelativeVerticalPosition () |
Specifies relative to what the shape is positioned vertically. More... | |
double | get_Right () |
Gets the position of the right edge of the containing block of the shape. More... | |
double | get_Rotation () |
Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle. More... | |
String | get_ScreenTip () |
Defines the text displayed when the mouse pointer moves over the shape. More... | |
ShapeType | get_ShapeType () |
Gets the shape type. More... | |
SizeF | get_SizeInPoints () |
Gets the size of the shape in points. More... | |
String | get_Target () |
Gets or sets the target frame for the shape hyperlink. More... | |
String | get_Title () |
Gets or sets the title (caption) of the current shape object. More... | |
double | get_Top () |
Gets or sets the position of the top edge of the containing block of the shape. More... | |
VerticalAlignment | get_VerticalAlignment () |
Specifies how the shape is positioned vertically. More... | |
double | get_Width () |
Gets or sets the width of the containing block of the shape. More... | |
WrapSide | get_WrapSide () |
Specifies how the text is wrapped around the shape. More... | |
WrapType | get_WrapType () |
Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape. More... | |
int32_t | get_ZOrder () |
Determines the display order of overlapping shapes. More... | |
SharedPtr< ShapeRenderer > | GetShapeRenderer () |
Creates and returns an object that can be used to render this shape into an image. More... | |
PointF | LocalToParent (PointF value) |
Converts a value from the local coordinate space into the coordinate space of the parent shape. More... | |
void | set_AllowOverlap (bool value) |
Setter for get_AllowOverlap. More... | |
void | set_AlternativeText (const String &value) |
Setter for get_AlternativeText. More... | |
void | set_AnchorLocked (bool value) |
Setter for get_AnchorLocked. More... | |
void | set_AspectRatioLocked (bool value) |
Setter for get_AspectRatioLocked. More... | |
void | set_BehindText (bool value) |
Setter for get_BehindText. More... | |
void | set_Bounds (RectangleF value) |
Setter for get_Bounds. More... | |
void | set_CoordOrigin (Point value) |
Setter for get_CoordOrigin. More... | |
void | set_CoordSize (Size value) |
Setter for get_CoordSize. More... | |
void | set_DistanceBottom (double value) |
Setter for get_DistanceBottom. More... | |
void | set_DistanceLeft (double value) |
Setter for get_DistanceLeft. More... | |
void | set_DistanceRight (double value) |
Setter for get_DistanceRight. More... | |
void | set_DistanceTop (double value) |
Setter for get_DistanceTop. More... | |
void | set_FlipOrientation (FlipOrientation value) |
Setter for get_FlipOrientation. More... | |
void | set_Height (double value) |
Setter for get_Height. More... | |
void | set_HorizontalAlignment (HorizontalAlignment value) |
Setter for get_HorizontalAlignment. More... | |
void | set_HRef (const String &value) |
Setter for get_HRef. More... | |
void | set_IsDecorative (bool value) |
Setter for get_IsDecorative. More... | |
void | set_IsLayoutInCell (bool value) |
Setter for get_IsLayoutInCell. More... | |
void | set_Left (double value) |
Setter for get_Left. More... | |
void | set_Name (const String &value) |
Setter for get_Name. More... | |
void | set_RelativeHorizontalPosition (RelativeHorizontalPosition value) |
Setter for get_RelativeHorizontalPosition. More... | |
void | set_RelativeVerticalPosition (RelativeVerticalPosition value) |
Setter for get_RelativeVerticalPosition. More... | |
void | set_Rotation (double value) |
Setter for get_Rotation. More... | |
void | set_ScreenTip (const String &value) |
Setter for get_ScreenTip. More... | |
void | set_Target (const String &value) |
Setter for get_Target. More... | |
void | set_Title (const String &value) |
Setter for get_Title. More... | |
void | set_Top (double value) |
Setter for get_Top. More... | |
void | set_VerticalAlignment (VerticalAlignment value) |
Setter for get_VerticalAlignment. More... | |
void | set_Width (double value) |
Setter for get_Width. More... | |
void | set_WrapSide (WrapSide value) |
Setter for get_WrapSide. More... | |
void | set_WrapType (WrapType value) |
Setter for get_WrapType. More... | |
void | set_ZOrder (int32_t value) |
Setter for get_ZOrder. More... | |
![]() | |
SharedPtr< Node > | AppendChild (const SharedPtr< Node > &newChild) |
Adds the specified node to the end of the list of child nodes for this node. More... | |
SharedPtr< NodeCollection > | get_ChildNodes () |
Gets all immediate child nodes of this node. More... | |
int32_t | get_Count () |
Gets the number of immediate children of this node. More... | |
SharedPtr< Node > | get_FirstChild () const |
Gets the first child of the node. More... | |
bool | get_HasChildNodes () |
Returns true if this node has any child nodes. More... | |
bool | get_IsComposite () override |
Returns true as this node can have child nodes. More... | |
SharedPtr< Node > | get_LastChild () const |
Gets the last child of the node. More... | |
SharedPtr< Node > | GetChild (NodeType nodeType, int32_t index, bool isDeep) |
Returns an Nth child node that matches the specified type. More... | |
SharedPtr< NodeCollection > | GetChildNodes (NodeType nodeType, bool isDeep) |
Returns a live collection of child nodes that match the specified type. More... | |
SharedPtr< IEnumerator< SharedPtr< Node > > > | GetEnumerator () override |
Provides support for the for each style iteration over the child nodes of this node. More... | |
String | GetText () override |
Gets the text of this node and of all its children. More... | |
int32_t | IndexOf (const SharedPtr< Node > &child) |
Returns the index of the specified child node in the child node array. More... | |
SharedPtr< Node > | InsertAfter (const SharedPtr< Node > &newChild, const SharedPtr< Node > &refChild) |
Inserts the specified node immediately after the specified reference node. More... | |
SharedPtr< Node > | InsertBefore (const SharedPtr< Node > &newChild, const SharedPtr< Node > &refChild) |
Inserts the specified node immediately before the specified reference node. More... | |
SharedPtr< Node > | PrependChild (const SharedPtr< Node > &newChild) |
Adds the specified node to the beginning of the list of child nodes for this node. More... | |
void | RemoveAllChildren () |
Removes all the child nodes of the current node. More... | |
SharedPtr< Node > | RemoveChild (const SharedPtr< Node > &oldChild) |
Removes the specified child node. More... | |
void | RemoveSmartTags () |
Removes all SmartTag descendant nodes of the current node. More... | |
SharedPtr< NodeList > | SelectNodes (const String &xpath) |
Selects a list of nodes matching the XPath expression. More... | |
SharedPtr< Node > | SelectSingleNode (const String &xpath) |
Selects the first Node that matches the XPath expression. More... | |
void | SetTemplateWeakPtr (uint32_t argument) override |
![]() | |
SharedPtr< Node > | Clone (bool isCloneChildren) |
Creates a duplicate of the node. More... | |
int32_t | get_CustomNodeId () const |
Specifies custom node identifier. More... | |
virtual SharedPtr< DocumentBase > | get_Document () const |
Gets the document to which this node belongs. More... | |
SharedPtr< Node > | get_NextSibling () |
Gets the node immediately following this node. More... | |
SharedPtr< CompositeNode > | get_ParentNode () |
Gets the immediate parent of this node. More... | |
SharedPtr< Node > | get_PreviousSibling () |
Gets the node immediately preceding this node. More... | |
SharedPtr< Range > | get_Range () |
Returns a Range object that represents the portion of a document that is contained in this node. More... | |
SharedPtr< CompositeNode > | GetAncestor (NodeType ancestorType) |
Gets the first ancestor of the specified NodeType. More... | |
template<typename T > | |
T | GetAncestorOf () |
SharedPtr< Node > | NextPreOrder (const SharedPtr< Node > &rootNode) |
Gets next node according to the pre-order tree traversal algorithm. More... | |
SharedPtr< Node > | PreviousPreOrder (const SharedPtr< Node > &rootNode) |
Gets the previous node according to the pre-order tree traversal algorithm. More... | |
void | Remove () |
Removes itself from the parent. More... | |
void | set_CustomNodeId (int32_t value) |
Setter for get_CustomNodeId. More... | |
String | ToString (SaveFormat saveFormat) |
Exports the content of the node into a string in the specified format. More... | |
String | ToString (const SharedPtr< SaveOptions > &saveOptions) |
Exports the content of the node into a string using the specified save options. More... | |
Static Public Member Functions | |
static const TypeInfo & | Type () |
![]() | |
static const TypeInfo & | Type () |
![]() | |
static const TypeInfo & | Type () |
![]() | |
static String | NodeTypeToString (NodeType nodeType) |
A utility method that converts a node type enum value into a user friendly string. More... | |
static const TypeInfo & | Type () |
Aspose::Words::Drawing::GroupShape::GroupShape | ( | const System::SharedPtr< Aspose::Words::DocumentBase > & | doc | ) |
Creates a new group shape.
By default, the shape is floating and has default location and size.
You should specify desired shape properties after you created a shape.
doc | The owner document. |
Shows how to create a group of shapes, and print its contents using a document visitor.
|
overridevirtual |
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.
visitor | The visitor that will visit the nodes. |
Shows how to create a group of shapes, and print its contents using a document visitor.
Implements Aspose::Words::Node.
|
overridevirtual |
Returns GroupShape.
Shows how to traverse a composite node's tree of child nodes.
Implements Aspose::Words::Node.
|
overridevirtual |
Reimplemented from Aspose::Words::Drawing::ShapeBase.
|
overridevirtual |
Reimplemented from Aspose::Words::Drawing::ShapeBase.
|
static |