Aspose::Words::Drawing::GroupShape Class Reference

Detailed Description

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
Aspose::Words::Drawing::ShapeBase, Aspose::Words::Drawing::Shape

#include <Aspose.Words.Cpp/Model/Drawing/GroupShape.h>

+ Inheritance diagram for Aspose::Words::Drawing::GroupShape:

Public Member Functions

 GroupShape (SharedPtr< DocumentBase > doc)
 Creates a new group shape. More...
 
virtual bool Accept (SharedPtr< DocumentVisitor > visitor)
 Accepts a visitor. More...
 
virtual NodeType get_NodeType () const
 Returns GroupShape. More...
 
- Public Member Functions inherited from ShapeBase
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< DocumentBaseget_Document_IInline ()
 
FlipOrientation get_FlipOrientation ()
 Switches the orientation of a shape. More...
 
SharedPtr< Fontget_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_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< Paragraphget_ParentParagraph ()
 Returns the immediate parent paragraph. More...
 
SharedPtr< Paragraphget_ParentParagraph_IInline ()
 
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...
 
SharedPtr< Aspose::Words::RunPr > get_RunPr_IInline ()
 
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...
 
int32_t get_ZOrder_IShape ()
 
SharedPtr< Aspose::Words::RunPr > GetExpandedRunPr_IInline (RunPrExpandFlags flags)
 
SharedPtr< ShapeRendererGetShapeRenderer ()
 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 (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 (String value)
 Setter for get_HRef. More...
 
void set_IsLayoutInCell (bool value)
 Setter for get_IsLayoutInCell. More...
 
void set_Left (double value)
 Setter for get_Left. More...
 
void set_Name (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_RunPr_IInline (SharedPtr< Aspose::Words::RunPr > value)
 
void set_ScreenTip (String value)
 Setter for get_ScreenTip. More...
 
void set_Target (String value)
 Setter for get_Target. More...
 
void set_Title (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...
 
void set_ZOrder_IShape (int32_t value)
 
- Public Member Functions inherited from CompositeNode
SharedPtr< NodeAppendChild (SharedPtr< Node > newChild)
 Adds the specified node to the end of the list of child nodes for this node. More...
 
SharedPtr< NodeCollectionget_ChildNodes ()
 Gets all immediate child nodes of this node. More...
 
SharedPtr< CompositeNodeget_Container ()
 
int32_t get_Count ()
 Gets the number of immediate children of this node. More...
 
SharedPtr< Nodeget_FirstChild () const
 Gets the first child of the node. More...
 
bool get_HasChildNodes ()
 Returns true if this node has any child nodes. More...
 
virtual bool get_IsComposite ()
 Returns true as this node can have child nodes. More...
 
SharedPtr< Nodeget_LastChild () const
 Gets the last child of the node. More...
 
SharedPtr< NodeGetChild (NodeType nodeType, int32_t index, bool isDeep)
 Returns an Nth child node that matches the specified type. More...
 
SharedPtr< NodeCollectionGetChildNodes (NodeType nodeType, bool isDeep)
 Returns a live collection of child nodes that match the specified type. More...
 
SharedPtr< NodeGetCurrentNode ()
 
SharedPtr< IEnumerator< SharedPtr< Node > > > GetEnumerator ()
 Provides support for the for each style iteration over the child nodes of this node. More...
 
SharedPtr< NodeGetNextMatchingNode (SharedPtr< Node > curNode)
 
virtual String GetText ()
 Gets the text of this node and of all its children. More...
 
int32_t IndexOf (SharedPtr< Node > child)
 Returns the index of the specified child node in the child node array. More...
 
SharedPtr< NodeInsertAfter (SharedPtr< Node > newChild, SharedPtr< Node > refChild)
 Inserts the specified node immediately after the specified reference node. More...
 
SharedPtr< NodeInsertBefore (SharedPtr< Node > newChild, SharedPtr< Node > refChild)
 Inserts the specified node immediately before the specified reference node. More...
 
SharedPtr< NodePrependChild (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< NodeRemoveChild (SharedPtr< Node > oldChild)
 Removes the specified child node. More...
 
void RemoveSmartTags ()
 Removes all SmartTag descendant nodes of the current node. More...
 
SharedPtr< NodeListSelectNodes (String xpath)
 Selects a list of nodes matching the XPath expression. More...
 
SharedPtr< NodeSelectSingleNode (String xpath)
 Selects the first Node that matches the XPath expression. More...
 
- Public Member Functions inherited from Node
SharedPtr< NodeClone (bool isCloneChildren)
 
virtual SharedPtr< DocumentBaseget_Document () const
 Gets the document to which this node belongs. More...
 
SharedPtr< Nodeget_NextSibling ()
 Gets the node immediately following this node. More...
 
SharedPtr< CompositeNodeget_ParentNode ()
 Gets the immediate parent of this node. More...
 
SharedPtr< Nodeget_PreviousSibling ()
 Gets the node immediately preceding this node. More...
 
SharedPtr< Rangeget_Range ()
 Returns a Range object that represents the portion of a document that is contained in this node. More...
 
SharedPtr< CompositeNodeGetAncestor (NodeType ancestorType)
 Gets the first ancestor of the specified NodeType. More...
 
template<typename T >
GetAncestorOf ()
 
SharedPtr< NodeNextPreOrder (SharedPtr< Node > rootNode)
 Gets next node according to the pre-order tree traversal algorithm. More...
 
SharedPtr< NodePreviousPreOrder (SharedPtr< Node > rootNode)
 Gets the previous node according to the pre-order tree traversal algorithm. More...
 
void Remove ()
 Removes itself from the parent. More...
 
String ToString (SaveFormat saveFormat)
 Exports the content of the node into a string in the specified format. More...
 
String ToString (SharedPtr< SaveOptions > saveOptions)
 Exports the content of the node into a string using the specified save options. More...
 
- Public Member Functions inherited from Object
ASPOSECPP_SHARED_API Object ()
 
ASPOSECPP_SHARED_API Object (Object const &x)
 
virtual ASPOSECPP_SHARED_API ~Object ()
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 
Detail::SmartPtrCounter * GetCounter ()
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 
ASPOSECPP_SHARED_API void Lock ()
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 
Objectoperator= (Object const &x)
 
bool ReferenceEquals (String const &str, std::nullptr_t)
 
bool ReferenceEquals (String const &str1, String const &str2)
 
int RemovedSharedRefs (int count)
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 
int SharedCount () const
 
ObjectSharedRefAdded ()
 
int SharedRefRemovedSafe ()
 
virtual ASPOSECPP_SHARED_API String ToString () const
 
ASPOSECPP_SHARED_API void Unlock ()
 
Detail::SmartPtrCounter * WeakRefAdded ()
 
void WeakRefRemoved ()
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Node > >
EnumeratorBasedIterator< T, IEnumerator< T > > begin () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > cbegin () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > cend () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > end () noexcept
 
bool LINQ_All (std::function< bool(T)> predicate)
 
bool LINQ_Any ()
 
bool LINQ_Any (std::function< bool(T)> predicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
bool LINQ_Contains (T value)
 
int LINQ_Count ()
 
LINQ_ElementAt (int index)
 
LINQ_First ()
 
LINQ_FirstOrDefault ()
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 
LINQ_Last ()
 
LINQ_LastOrDefault ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 
ArrayPtr< T > LINQ_ToArray ()
 
SharedPtr< List< T > > LINQ_ToList ()
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 

Additional Inherited Members

- Public Types inherited from Object
typedef SmartPtr< Objectptr
 
typedef System::Details::SharedMembersType shared_members_type
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Node > >
typedef IEnumerator< T > IEnumeratorType
 
typedef T ValueType
 
- Static Public Member Functions inherited from Node
static String NodeTypeToString (NodeType nodeType)
 A utility method that converts a node type enum value into a user friendly string. More...
 
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
 
bool Equals (float const &objA, float const &objB)
 
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 
static const TypeInfoType ()
 

Constructor & Destructor Documentation

◆ GroupShape()

Aspose::Words::Drawing::GroupShape::GroupShape ( System::SharedPtr< Aspose::Words::DocumentBase doc)

Creates a new group shape.

Parameters
docThe owner document.

By default, the shape is floating and has default location and size.

You should specify desired shape properties after you created a shape.

Member Function Documentation

◆ Accept()

virtual bool Aspose::Words::Drawing::GroupShape::Accept ( System::SharedPtr< Aspose::Words::DocumentVisitor visitor)
virtual

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.

Parameters
visitorThe visitor that will visit the nodes.
Returns
True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Calls VisitGroupShapeStart, then calls Accept for all child shapes of this group shape and calls VisitGroupShapeEnd at the end.

Implements Aspose::Words::Node.

◆ get_NodeType()

virtual Aspose::Words::NodeType Aspose::Words::Drawing::GroupShape::get_NodeType ( ) const
virtual

Returns GroupShape.

Implements Aspose::Words::Node.