Aspose::Words::Drawing::ShapeBase Class Referenceabstract

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

#include "Aspose.Words.Cpp/Model/Drawing/ShapeBase.h"

Inherits Aspose::Words::CompositeNode, IInline, IShape, IShapeAttrSource, and ITrackableNode.

Inherited by Aspose::Words::Drawing::GroupShape, and Aspose::Words::Drawing::Shape.

Public Member Functions

System::SharedPtr< Aspose::Words::Paragraphget_ParentParagraph_IInline ()
 
System::SharedPtr< Aspose::Words::DocumentBaseget_Document_IInline ()
 
System::SharedPtr< Aspose::Words::RunPr > get_RunPr_IInline ()
 
void set_RunPr_IInline (System::SharedPtr< Aspose::Words::RunPr > value)
 
int32_t get_ZOrder_IShape ()
 
void set_ZOrder_IShape (int32_t value)
 
System::SharedPtr< Aspose::Words::Revisions::EditRevision > get_InsertRevision ()
 
void set_InsertRevision (System::SharedPtr< Aspose::Words::Revisions::EditRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::EditRevision > get_DeleteRevision ()
 
void set_DeleteRevision (System::SharedPtr< Aspose::Words::Revisions::EditRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::MoveRevision > get_MoveFromRevision ()
 
void set_MoveFromRevision (System::SharedPtr< Aspose::Words::Revisions::MoveRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::MoveRevision > get_MoveToRevision ()
 
void set_MoveToRevision (System::SharedPtr< Aspose::Words::Revisions::MoveRevision > value)
 
System::String get_ScreenTip ()
 Defines the text displayed when the mouse pointer moves over the shape. More...
 
void set_ScreenTip (System::String value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_ScreenTip. More...
 
System::String get_HRef ()
 Gets or sets the full hyperlink address for a shape. More...
 
void set_HRef (System::String value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_HRef. More...
 
System::String get_Target ()
 Gets or sets the target frame for the shape hyperlink. More...
 
void set_Target (System::String value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_Target. More...
 
System::String get_AlternativeText ()
 Defines alternative text to be displayed instead of a graphic. More...
 
void set_AlternativeText (System::String value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_AlternativeText. More...
 
System::String get_Title ()
 Gets or sets the title (caption) of the current shape object. More...
 
void set_Title (System::String value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_Title. More...
 
System::String get_Name ()
 Gets or sets the optional shape name. More...
 
void set_Name (System::String value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_Name. More...
 
bool get_IsInsertRevision ()
 Returns true if this object was inserted in Microsoft Word while change tracking was enabled. More...
 
bool get_IsDeleteRevision ()
 Returns true if this object was deleted in Microsoft Word while change tracking was enabled. 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_IsTopLevel ()
 Returns true if this shape is not a child of a group shape. More...
 
bool get_IsGroup ()
 Returns true if this is a group shape. More...
 
bool get_IsImage ()
 Returns true if this shape is an image shape. More...
 
bool get_IsTextBox ()
 Return true is this shape is a TextBox shape. More...
 
bool get_IsHorizontalRule ()
 Returns true if this shape is a horizontal rule. More...
 
bool get_IsWordArt ()
 Returns true if this shape is a WordArt object. More...
 
bool get_CanHaveImage ()
 Returns true if the shape type allows the shape to have an image. More...
 
bool get_AnchorLocked ()
 Specifies whether the shape's anchor is locked. More...
 
void set_AnchorLocked (bool value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_AnchorLocked. More...
 
bool get_AspectRatioLocked ()
 Specifies whether the shape's aspect ratio is locked. More...
 
void set_AspectRatioLocked (bool value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_AspectRatioLocked. More...
 
bool get_AllowOverlap ()
 Gets or sets a value that specifies whether this shape can overlap other shapes. More...
 
void set_AllowOverlap (bool value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_AllowOverlap. More...
 
bool get_BehindText ()
 Specifies whether the shape is below or above text. More...
 
void set_BehindText (bool value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_BehindText. More...
 
bool get_IsInline ()
 A quick way to determine if this shape is positioned inline with text. More...
 
double get_Left ()
 Gets or sets the position of the left edge of the containing block of the shape. More...
 
void set_Left (double value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_Left. More...
 
double get_Top ()
 Gets or sets the position of the top edge of the containing block of the shape. More...
 
void set_Top (double value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_Top. More...
 
double get_Right ()
 Gets the position of the right edge of the containing block of the shape. More...
 
double get_Bottom ()
 Gets the position of the bottom edge of the containing block of the shape. More...
 
double get_Width ()
 Gets or sets the width of the containing block of the shape. More...
 
void set_Width (double value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_Width. More...
 
double get_Height ()
 Gets or sets the height of the containing block of the shape. More...
 
void set_Height (double value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_Height. More...
 
double get_DistanceTop ()
 Returns or sets the distance (in points) between the document text and the top edge of the shape. More...
 
void set_DistanceTop (double value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_DistanceTop. More...
 
double get_DistanceBottom ()
 Returns or sets the distance (in points) between the document text and the bottom edge of the shape. More...
 
void set_DistanceBottom (double value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_DistanceBottom. More...
 
double get_DistanceLeft ()
 Returns or sets the distance (in points) between the document text and the left edge of the shape. More...
 
void set_DistanceLeft (double value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_DistanceLeft. More...
 
double get_DistanceRight ()
 Returns or sets the distance (in points) between the document text and the right edge of the shape. More...
 
void set_DistanceRight (double value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_DistanceRight. More...
 
double get_Rotation ()
 Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle. More...
 
void set_Rotation (double value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_Rotation. More...
 
int32_t get_ZOrder ()
 Determines the display order of overlapping shapes. More...
 
void set_ZOrder (int32_t value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_ZOrder. More...
 
System::SharedPtr< Aspose::Words::Paragraphget_ParentParagraph ()
 Returns the immediate parent paragraph. More...
 
System::Drawing::RectangleF get_Bounds ()
 Gets or sets the location and size of the containing block of the shape. More...
 
void set_Bounds (System::Drawing::RectangleF value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_Bounds. More...
 
System::Drawing::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...
 
System::Drawing::RectangleF get_BoundsWithEffects ()
 Gets final extent that this shape object has after applying drawing effects. Value is measured in points. More...
 
Aspose::Words::Drawing::ShapeType get_ShapeType ()
 Gets the shape type. More...
 
Aspose::Words::Drawing::ShapeMarkupLanguage get_MarkupLanguage () const
 Gets MarkupLanguage used for this graphic object. More...
 
System::Drawing::SizeF get_SizeInPoints ()
 Gets the size of the shape in points. More...
 
Aspose::Words::Drawing::FlipOrientation get_FlipOrientation ()
 Switches the orientation of a shape. More...
 
void set_FlipOrientation (Aspose::Words::Drawing::FlipOrientation value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_FlipOrientation. More...
 
Aspose::Words::Drawing::RelativeHorizontalPosition get_RelativeHorizontalPosition ()
 Specifies relative to what the shape is positioned horizontally. More...
 
void set_RelativeHorizontalPosition (Aspose::Words::Drawing::RelativeHorizontalPosition value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_RelativeHorizontalPosition. More...
 
Aspose::Words::Drawing::RelativeVerticalPosition get_RelativeVerticalPosition ()
 Specifies relative to what the shape is positioned vertically. More...
 
void set_RelativeVerticalPosition (Aspose::Words::Drawing::RelativeVerticalPosition value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_RelativeVerticalPosition. More...
 
Aspose::Words::Drawing::HorizontalAlignment get_HorizontalAlignment ()
 Specifies how the shape is positioned horizontally. More...
 
void set_HorizontalAlignment (Aspose::Words::Drawing::HorizontalAlignment value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_HorizontalAlignment. More...
 
Aspose::Words::Drawing::VerticalAlignment get_VerticalAlignment ()
 Specifies how the shape is positioned vertically. More...
 
void set_VerticalAlignment (Aspose::Words::Drawing::VerticalAlignment value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_VerticalAlignment. More...
 
Aspose::Words::Drawing::WrapType get_WrapType ()
 Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape. More...
 
void set_WrapType (Aspose::Words::Drawing::WrapType value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_WrapType. More...
 
Aspose::Words::Drawing::WrapSide get_WrapSide ()
 Specifies how the text is wrapped around the shape. More...
 
void set_WrapSide (Aspose::Words::Drawing::WrapSide value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_WrapSide. More...
 
System::Drawing::Point get_CoordOrigin ()
 The coordinates at the top-left corner of the containing block of this shape. More...
 
void set_CoordOrigin (System::Drawing::Point value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_CoordOrigin. More...
 
System::Drawing::Size get_CoordSize ()
 The width and height of the coordinate space inside the containing block of this shape. More...
 
void set_CoordSize (System::Drawing::Size value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_CoordSize. More...
 
System::SharedPtr< Aspose::Words::Fontget_Font ()
 Provides access to the font formatting of this object. More...
 
bool get_IsSignatureLine ()
 Indicates that shape is a SignatureLine. More...
 
bool get_IsLayoutInCell ()
 Gets or sets a flag indicating whether the shape is displayed inside a table or outside of it. More...
 
void set_IsLayoutInCell (bool value)
 Setter for Aspose::Words::Drawing::ShapeBase::get_IsLayoutInCell. More...
 
System::SharedPtr< Aspose::Words::Rendering::ShapeRendererGetShapeRenderer ()
 Creates and returns an object that can be used to render this shape into an image. More...
 
System::SharedPtr< Aspose::Words::RunPr > GetExpandedRunPr_IInline (Aspose::Words::RunPrExpandFlags flags)
 
System::SharedPtr< System::ObjectGetDirectShapeAttr (int32_t key)
 Reserved for system use. IShapeAttrSource. More...
 
System::SharedPtr< System::ObjectFetchInheritedShapeAttr (int32_t key)
 Reserved for system use. IShapeAttrSource. More...
 
System::SharedPtr< System::ObjectFetchShapeAttr (int32_t key)
 Reserved for system use. IShapeAttrSource. More...
 
void SetShapeAttr (int32_t key, System::SharedPtr< System::Object > value)
 Reserved for system use. IShapeAttrSource. More...
 
void RemoveShapeAttr (int32_t key)
 Reserved for system use. IShapeAttrSource. More...
 
System::SharedPtr< System::ObjectGetDirectRunAttr (int32_t fontAttr)
 
System::SharedPtr< System::ObjectFetchInheritedRunAttr (int32_t fontAttr)
 
void SetRunAttr (int32_t fontAttr, System::SharedPtr< System::Object > value)
 
void RemoveRunAttr (int32_t key)
 
void ClearRunAttrs ()
 
System::Drawing::PointF LocalToParent (System::Drawing::PointF value)
 Converts a value from the local coordinate space into the coordinate space of the parent shape. More...
 
System::Drawing::RectangleF AdjustWithEffects (System::Drawing::RectangleF source)
 Adds to the source rectangle values of the effect extent and returns the final rectangle. More...
 
- Public Member Functions inherited from Aspose::Words::CompositeNode
virtual bool get_IsComposite ()
 Returns true as this node can have child nodes. More...
 
bool get_HasChildNodes ()
 Returns true if this node has any child nodes. More...
 
System::SharedPtr< Aspose::Words::NodeCollectionget_ChildNodes ()
 Gets all immediate child nodes of this node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_FirstChild () const
 Gets the first child of the node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_LastChild () const
 Gets the last child of the node. More...
 
int32_t get_Count ()
 Gets the number of immediate children of this node. More...
 
System::SharedPtr< Aspose::Words::CompositeNodeget_Container ()
 
virtual ~CompositeNode ()
 
virtual System::String GetText ()
 Gets the text of this node and of all its children. More...
 
System::SharedPtr< Aspose::Words::NodeCollectionGetChildNodes (Aspose::Words::NodeType nodeType, bool isDeep)
 Returns a live collection of child nodes that match the specified type. More...
 
System::SharedPtr< Aspose::Words::NodeGetChild (Aspose::Words::NodeType nodeType, int32_t index, bool isDeep)
 Returns an Nth child node that matches the specified type. More...
 
System::SharedPtr< Aspose::Words::NodeListSelectNodes (System::String xpath)
 Selects a list of nodes matching the XPath expression. More...
 
System::SharedPtr< Aspose::Words::NodeSelectSingleNode (System::String xpath)
 Selects the first Node that matches the XPath expression. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Words::Node > > > GetEnumerator ()
 Provides support for the for each style iteration over the child nodes of this node. More...
 
System::SharedPtr< Aspose::Words::NodeAppendChild (System::SharedPtr< Aspose::Words::Node > newChild)
 Adds the specified node to the end of the list of child nodes for this node. More...
 
System::SharedPtr< Aspose::Words::NodePrependChild (System::SharedPtr< Aspose::Words::Node > newChild)
 Adds the specified node to the beginning of the list of child nodes for this node. More...
 
System::SharedPtr< Aspose::Words::NodeInsertAfter (System::SharedPtr< Aspose::Words::Node > newChild, System::SharedPtr< Aspose::Words::Node > refChild)
 Inserts the specified node immediately after the specified reference node. More...
 
System::SharedPtr< Aspose::Words::NodeInsertBefore (System::SharedPtr< Aspose::Words::Node > newChild, System::SharedPtr< Aspose::Words::Node > refChild)
 Inserts the specified node immediately before the specified reference node. More...
 
System::SharedPtr< Aspose::Words::NodeRemoveChild (System::SharedPtr< Aspose::Words::Node > oldChild)
 Removes the specified child node. More...
 
void RemoveAllChildren ()
 Removes all the child nodes of the current node. More...
 
void RemoveSmartTags ()
 Removes all Aspose::Words::Markup::SmartTag descendant nodes of the current node. More...
 
int32_t IndexOf (System::SharedPtr< Aspose::Words::Node > child)
 Returns the index of the specified child node in the child node array. More...
 
System::SharedPtr< Aspose::Words::NodeGetNextMatchingNode (System::SharedPtr< Aspose::Words::Node > &curNode)
 
- Public Member Functions inherited from Aspose::Words::Node
virtual Aspose::Words::NodeType get_NodeType () const =0
 Gets the type of this node. More...
 
System::SharedPtr< Aspose::Words::CompositeNodeget_ParentNode ()
 Gets the immediate parent of this node. More...
 
System::SharedPtr< Aspose::Words::DocumentBaseget_Document ()
 Gets the document to which this node belongs. More...
 
System::SharedPtr< Aspose::Words::Nodeget_PreviousSibling ()
 Gets the node immediately preceding this node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_NextSibling ()
 Gets the node immediately following this node. More...
 
System::SharedPtr< Aspose::Words::Rangeget_Range ()
 Returns a Range object that represents the portion of a document that is contained in this node. More...
 
System::SharedPtr< Aspose::Words::NodeClone (bool isCloneChildren)
 
virtual bool Accept (System::SharedPtr< Aspose::Words::DocumentVisitor > visitor)=0
 Accepts a visitor. More...
 
template<typename T >
GetAncestorOf ()
 
System::SharedPtr< Aspose::Words::CompositeNodeGetAncestor (Aspose::Words::NodeType ancestorType)
 Gets the first ancestor of the specified Aspose::Words::NodeType. More...
 
void Remove ()
 Removes itself from the parent. More...
 
System::SharedPtr< Aspose::Words::NodeNextPreOrder (System::SharedPtr< Aspose::Words::Node > rootNode)
 Gets next node according to the pre-order tree traversal algorithm. More...
 
System::SharedPtr< Aspose::Words::NodePreviousPreOrder (System::SharedPtr< Aspose::Words::Node > rootNode)
 Gets the previous node according to the pre-order tree traversal algorithm. More...
 
System::String ToString (Aspose::Words::SaveFormat saveFormat)
 Exports the content of the node into a string in the specified format. More...
 
System::String ToString (System::SharedPtr< Aspose::Words::Saving::SaveOptions > saveOptions)
 Exports the content of the node into a string using the specified save options. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Node > >
typedef IEnumerator< System::SharedPtr< Aspose::Words::Node > > IEnumeratorType
 Enumerator type. More...
 
- Static Public Member Functions inherited from Aspose::Words::Node
static System::String NodeTypeToString (Aspose::Words::NodeType nodeType)
 A utility method that converts a node type enum value into a user friendly string. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

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

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

A shape is a node in the document tree.

If the shape is a child of a Aspose::Words::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 Aspose::Words::Drawing::GroupShape object when several shapes are grouped. Child shapes of a group shape are positioned in the coordinate space and units defined by the Aspose::Words::Drawing::ShapeBase::get_CoordSize and Aspose::Words::Drawing::ShapeBase::get_CoordOrigin properties of the parent group shape.

A shape can be positioned inline with text or floating. The positioning method is controlled using the Aspose::Words::Drawing::ShapeBase::get_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 Aspose::Words::Drawing::ShapeBase::get_RelativeHorizontalPosition and Aspose::Words::Drawing::ShapeBase::get_RelativeVerticalPosition properties.

A floating shape be positioned explicitly using the Aspose::Words::Drawing::ShapeBase::get_Left and Aspose::Words::Drawing::ShapeBase::get_Top properties or aligned relative to some other object using the Aspose::Words::Drawing::ShapeBase::get_HorizontalAlignment and Aspose::Words::Drawing::ShapeBase::get_VerticalAlignment properties.

See also
Aspose::Words::Drawing::Shape, Aspose::Words::Drawing::GroupShape

Member Function Documentation

◆ AdjustWithEffects()

System::Drawing::RectangleF Aspose::Words::Drawing::ShapeBase::AdjustWithEffects ( System::Drawing::RectangleF  source)

Adds to the source rectangle values of the effect extent and returns the final rectangle.

◆ ClearRunAttrs()

void Aspose::Words::Drawing::ShapeBase::ClearRunAttrs ( )

◆ FetchInheritedRunAttr()

System::SharedPtr<System::Object> Aspose::Words::Drawing::ShapeBase::FetchInheritedRunAttr ( int32_t  fontAttr)

◆ FetchInheritedShapeAttr()

System::SharedPtr<System::Object> Aspose::Words::Drawing::ShapeBase::FetchInheritedShapeAttr ( int32_t  key)

Reserved for system use. IShapeAttrSource.

◆ FetchShapeAttr()

System::SharedPtr<System::Object> Aspose::Words::Drawing::ShapeBase::FetchShapeAttr ( int32_t  key)

Reserved for system use. IShapeAttrSource.

◆ get_AllowOverlap()

bool Aspose::Words::Drawing::ShapeBase::get_AllowOverlap ( )

Gets or sets a value that specifies whether this shape can overlap other shapes.

This property affects behavior of the shape in Microsoft Word. Aspose.Words ignores the value of this property.

This property is applicable only to top level shapes.

The default value is true.

◆ get_AlternativeText()

System::String Aspose::Words::Drawing::ShapeBase::get_AlternativeText ( )

Defines alternative text to be displayed instead of a graphic.

The default value is an empty string.

◆ get_AnchorLocked()

bool Aspose::Words::Drawing::ShapeBase::get_AnchorLocked ( )

Specifies whether the shape's anchor is locked.

The default value is false.

Has effect only for top level shapes.

This property affects behavior of the shape's anchor in Microsoft Word. When the anchor is not locked, moving the shape in Microsoft Word can move the shape's anchor too.

◆ get_AspectRatioLocked()

bool Aspose::Words::Drawing::ShapeBase::get_AspectRatioLocked ( )

Specifies whether the shape's aspect ratio is locked.

The default value depends on the Aspose::Words::Drawing::ShapeBase::get_ShapeType, for the ShapeType.Image it is true but for the other shape types it is false.

Has effect for top level shapes only.

◆ get_BehindText()

bool Aspose::Words::Drawing::ShapeBase::get_BehindText ( )

Specifies whether the shape is below or above text.

Has effect only for top level shapes.

The default value is false.

See also
Aspose::Words::Drawing::ShapeBase::get_ZOrder

◆ get_Bottom()

double Aspose::Words::Drawing::ShapeBase::get_Bottom ( )

Gets the position of the bottom edge of the containing block of the shape.

For a top-level shape, the value is in points and relative to the shape anchor.

For shapes in a group, the value is in the coordinate space and units of the parent group.

◆ get_Bounds()

System::Drawing::RectangleF Aspose::Words::Drawing::ShapeBase::get_Bounds ( )

Gets or sets the location and size of the containing block of the shape.

Ignores aspect ratio lock upon setting.

For a top-level shape, the value is in points and relative to the shape anchor.

For shapes in a group, the value is in the coordinate space and units of the parent group.

◆ get_BoundsInPoints()

System::Drawing::RectangleF Aspose::Words::Drawing::ShapeBase::get_BoundsInPoints ( )

Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape.

◆ get_BoundsWithEffects()

System::Drawing::RectangleF Aspose::Words::Drawing::ShapeBase::get_BoundsWithEffects ( )

Gets final extent that this shape object has after applying drawing effects. Value is measured in points.

◆ get_CanHaveImage()

bool Aspose::Words::Drawing::ShapeBase::get_CanHaveImage ( )

Returns true if the shape type allows the shape to have an image.

Although Microsoft Word has a special shape type for images, it appears that in Microsoft Word documents any shape except a group shape can have an image, therefore this property returns true for all shapes except Aspose::Words::Drawing::GroupShape.

◆ get_CoordOrigin()

System::Drawing::Point Aspose::Words::Drawing::ShapeBase::get_CoordOrigin ( )

The coordinates at the top-left corner of the containing block of this shape.

The default value is (0,0).

◆ get_CoordSize()

System::Drawing::Size Aspose::Words::Drawing::ShapeBase::get_CoordSize ( )

The width and height of the coordinate space inside the containing block of this shape.

The default value is (1000, 1000).

◆ get_DeleteRevision()

System::SharedPtr<Aspose::Words::Revisions::EditRevision> Aspose::Words::Drawing::ShapeBase::get_DeleteRevision ( )

◆ get_DistanceBottom()

double Aspose::Words::Drawing::ShapeBase::get_DistanceBottom ( )

Returns or sets the distance (in points) between the document text and the bottom edge of the shape.

The default value is 0.

Has effect only for top level shapes.

◆ get_DistanceLeft()

double Aspose::Words::Drawing::ShapeBase::get_DistanceLeft ( )

Returns or sets the distance (in points) between the document text and the left edge of the shape.

The default value is 1/8 inch.

Has effect only for top level shapes.

◆ get_DistanceRight()

double Aspose::Words::Drawing::ShapeBase::get_DistanceRight ( )

Returns or sets the distance (in points) between the document text and the right edge of the shape.

The default value is 1/8 inch.

Has effect only for top level shapes.

◆ get_DistanceTop()

double Aspose::Words::Drawing::ShapeBase::get_DistanceTop ( )

Returns or sets the distance (in points) between the document text and the top edge of the shape.

The default value is 0.

Has effect only for top level shapes.

◆ get_Document_IInline()

System::SharedPtr<Aspose::Words::DocumentBase> Aspose::Words::Drawing::ShapeBase::get_Document_IInline ( )

◆ get_FlipOrientation()

Aspose::Words::Drawing::FlipOrientation Aspose::Words::Drawing::ShapeBase::get_FlipOrientation ( )

Switches the orientation of a shape.

The default value is Aspose::Words::Drawing::FlipOrientation::None.

◆ get_Font()

System::SharedPtr<Aspose::Words::Font> Aspose::Words::Drawing::ShapeBase::get_Font ( )

Provides access to the font formatting of this object.

◆ get_Height()

double Aspose::Words::Drawing::ShapeBase::get_Height ( )

Gets or sets the height of the containing block of the shape.

For a top-level shape, the value is in points.

For shapes in a group, the value is in the coordinate space and units of the parent group.

The default value is 0.

◆ get_HorizontalAlignment()

Aspose::Words::Drawing::HorizontalAlignment Aspose::Words::Drawing::ShapeBase::get_HorizontalAlignment ( )

Specifies how the shape is positioned horizontally.

The default value is Aspose::Words::Drawing::HorizontalAlignment::None.

Has effect only for top level floating shapes.

◆ get_HRef()

System::String Aspose::Words::Drawing::ShapeBase::get_HRef ( )

Gets or sets the full hyperlink address for a shape.

The default value is an empty string.

Below are examples of valid values for this property:

Full URI: https://www.aspose.com/.

Full file name: C:\\My Documents\\SalesReport.doc.

Relative URI: ../../../resource.txt

Relative file name: ..\\My Documents\\SalesReport.doc.

Bookmark within another document: https://www.aspose.com/Products/Default.aspx#Suites

Bookmark within this document: #BookmakName.

◆ get_InsertRevision()

System::SharedPtr<Aspose::Words::Revisions::EditRevision> Aspose::Words::Drawing::ShapeBase::get_InsertRevision ( )

◆ get_IsDeleteRevision()

bool Aspose::Words::Drawing::ShapeBase::get_IsDeleteRevision ( )

Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

◆ get_IsGroup()

bool Aspose::Words::Drawing::ShapeBase::get_IsGroup ( )

Returns true if this is a group shape.

◆ get_IsHorizontalRule()

bool Aspose::Words::Drawing::ShapeBase::get_IsHorizontalRule ( )

Returns true if this shape is a horizontal rule.

◆ get_IsImage()

bool Aspose::Words::Drawing::ShapeBase::get_IsImage ( )

Returns true if this shape is an image shape.

◆ get_IsInline()

bool Aspose::Words::Drawing::ShapeBase::get_IsInline ( )

A quick way to determine if this shape is positioned inline with text.

Has effect only for top level shapes.

◆ get_IsInsertRevision()

bool Aspose::Words::Drawing::ShapeBase::get_IsInsertRevision ( )

Returns true if this object was inserted in Microsoft Word while change tracking was enabled.

◆ get_IsLayoutInCell()

bool Aspose::Words::Drawing::ShapeBase::get_IsLayoutInCell ( )

Gets or sets a flag indicating whether the shape is displayed inside a table or outside of it.

The default value is true.

Has effect only for top level shapes, the property Aspose::Words::Drawing::ShapeBase::get_WrapType of which is set to value other than Aspose::Words::Inline.

◆ get_IsMoveFromRevision()

bool Aspose::Words::Drawing::ShapeBase::get_IsMoveFromRevision ( )

Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.

◆ get_IsMoveToRevision()

bool Aspose::Words::Drawing::ShapeBase::get_IsMoveToRevision ( )

Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.

◆ get_IsSignatureLine()

bool Aspose::Words::Drawing::ShapeBase::get_IsSignatureLine ( )

Indicates that shape is a SignatureLine.

◆ get_IsTextBox()

bool Aspose::Words::Drawing::ShapeBase::get_IsTextBox ( )

Return true is this shape is a TextBox shape.

◆ get_IsTopLevel()

bool Aspose::Words::Drawing::ShapeBase::get_IsTopLevel ( )

Returns true if this shape is not a child of a group shape.

◆ get_IsWordArt()

bool Aspose::Words::Drawing::ShapeBase::get_IsWordArt ( )

Returns true if this shape is a WordArt object.

Works till 2007 compatibility mode. In 2010 and higher compatibility mode WordArt is just a TextBox with fancy fonts.

◆ get_Left()

double Aspose::Words::Drawing::ShapeBase::get_Left ( )

Gets or sets the position of the left edge of the containing block of the shape.

For a top-level shape, the value is in points and relative to the shape anchor.

For shapes in a group, the value is in the coordinate space and units of the parent group.

The default value is 0.

Has effect only for floating shapes.

◆ get_MarkupLanguage()

Aspose::Words::Drawing::ShapeMarkupLanguage Aspose::Words::Drawing::ShapeBase::get_MarkupLanguage ( ) const

Gets MarkupLanguage used for this graphic object.

◆ get_MoveFromRevision()

System::SharedPtr<Aspose::Words::Revisions::MoveRevision> Aspose::Words::Drawing::ShapeBase::get_MoveFromRevision ( )

◆ get_MoveToRevision()

System::SharedPtr<Aspose::Words::Revisions::MoveRevision> Aspose::Words::Drawing::ShapeBase::get_MoveToRevision ( )

◆ get_Name()

System::String Aspose::Words::Drawing::ShapeBase::get_Name ( )

Gets or sets the optional shape name.

Default is empty string.

Cannot be null, but can be an empty string.

◆ get_ParentParagraph()

System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::Drawing::ShapeBase::get_ParentParagraph ( )

Returns the immediate parent paragraph.

For child shapes of a group shape and child shapes of an Office Math object always returns null.

◆ get_ParentParagraph_IInline()

System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::Drawing::ShapeBase::get_ParentParagraph_IInline ( )

◆ get_RelativeHorizontalPosition()

Aspose::Words::Drawing::RelativeHorizontalPosition Aspose::Words::Drawing::ShapeBase::get_RelativeHorizontalPosition ( )

Specifies relative to what the shape is positioned horizontally.

The default value is Aspose::Words::Drawing::RelativeHorizontalPosition::Column.

Has effect only for top level floating shapes.

◆ get_RelativeVerticalPosition()

Aspose::Words::Drawing::RelativeVerticalPosition Aspose::Words::Drawing::ShapeBase::get_RelativeVerticalPosition ( )

Specifies relative to what the shape is positioned vertically.

The default value is Aspose::Words::Drawing::RelativeVerticalPosition::Paragraph.

Has effect only for top level floating shapes.

◆ get_Right()

double Aspose::Words::Drawing::ShapeBase::get_Right ( )

Gets the position of the right edge of the containing block of the shape.

For a top-level shape, the value is in points and relative to the shape anchor.

For shapes in a group, the value is in the coordinate space and units of the parent group.

◆ get_Rotation()

double Aspose::Words::Drawing::ShapeBase::get_Rotation ( )

Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle.

The default value is 0.

◆ get_RunPr_IInline()

System::SharedPtr<Aspose::Words::RunPr> Aspose::Words::Drawing::ShapeBase::get_RunPr_IInline ( )

◆ get_ScreenTip()

System::String Aspose::Words::Drawing::ShapeBase::get_ScreenTip ( )

Defines the text displayed when the mouse pointer moves over the shape.

The default value is an empty string.

◆ get_ShapeType()

Aspose::Words::Drawing::ShapeType Aspose::Words::Drawing::ShapeBase::get_ShapeType ( )

Gets the shape type.

◆ get_SizeInPoints()

System::Drawing::SizeF Aspose::Words::Drawing::ShapeBase::get_SizeInPoints ( )

Gets the size of the shape in points.

◆ get_Target()

System::String Aspose::Words::Drawing::ShapeBase::get_Target ( )

Gets or sets the target frame for the shape hyperlink.

The default value is an empty string.

◆ get_Title()

System::String Aspose::Words::Drawing::ShapeBase::get_Title ( )

Gets or sets the title (caption) of the current shape object.

Default is empty string.

Cannot be null, but can be an empty string.

◆ get_Top()

double Aspose::Words::Drawing::ShapeBase::get_Top ( )

Gets or sets the position of the top edge of the containing block of the shape.

For a top-level shape, the value is in points and relative to the shape anchor.

For shapes in a group, the value is in the coordinate space and units of the parent group.

The default value is 0.

Has effect only for floating shapes.

◆ get_VerticalAlignment()

Aspose::Words::Drawing::VerticalAlignment Aspose::Words::Drawing::ShapeBase::get_VerticalAlignment ( )

Specifies how the shape is positioned vertically.

The default value is Aspose::Words::Drawing::VerticalAlignment::None.

Has effect only for top level floating shapes.

◆ get_Width()

double Aspose::Words::Drawing::ShapeBase::get_Width ( )

Gets or sets the width of the containing block of the shape.

For a top-level shape, the value is in points.

For shapes in a group, the value is in the coordinate space and units of the parent group.

The default value is 0.

◆ get_WrapSide()

Aspose::Words::Drawing::WrapSide Aspose::Words::Drawing::ShapeBase::get_WrapSide ( )

Specifies how the text is wrapped around the shape.

The default value is Aspose::Words::Drawing::WrapSide::Both.

Has effect only for top level shapes.

◆ get_WrapType()

Aspose::Words::Drawing::WrapType Aspose::Words::Drawing::ShapeBase::get_WrapType ( )

Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape.

The default value is Aspose::Words::Drawing::WrapType::None.

Has effect only for top level shapes.

◆ get_ZOrder()

int32_t Aspose::Words::Drawing::ShapeBase::get_ZOrder ( )

Determines the display order of overlapping shapes.

Has effect only for top level shapes.

The default value is 0.

The number represents the stacking precedence. A shape with a higher number will be displayed as if it were overlapping (in "front" of) a shape with a lower number.

The order of overlapping shapes is independent for shapes in the header and in the main text of the document.

The display order of child shapes in a group shape is determined by their order inside the group shape.

See also
Aspose::Words::Drawing::ShapeBase::get_BehindText

◆ get_ZOrder_IShape()

int32_t Aspose::Words::Drawing::ShapeBase::get_ZOrder_IShape ( )

◆ GetDirectRunAttr()

System::SharedPtr<System::Object> Aspose::Words::Drawing::ShapeBase::GetDirectRunAttr ( int32_t  fontAttr)

◆ GetDirectShapeAttr()

System::SharedPtr<System::Object> Aspose::Words::Drawing::ShapeBase::GetDirectShapeAttr ( int32_t  key)

Reserved for system use. IShapeAttrSource.

◆ GetExpandedRunPr_IInline()

System::SharedPtr<Aspose::Words::RunPr> Aspose::Words::Drawing::ShapeBase::GetExpandedRunPr_IInline ( Aspose::Words::RunPrExpandFlags  flags)

◆ GetShapeRenderer()

System::SharedPtr<Aspose::Words::Rendering::ShapeRenderer> Aspose::Words::Drawing::ShapeBase::GetShapeRenderer ( )

Creates and returns an object that can be used to render this shape into an image.

This method just invokes the Aspose::Words::Rendering::ShapeRenderer constructor and passes this object as a parameter.

Returns
The renderer object for this shape.

◆ LocalToParent()

System::Drawing::PointF Aspose::Words::Drawing::ShapeBase::LocalToParent ( System::Drawing::PointF  value)

Converts a value from the local coordinate space into the coordinate space of the parent shape.

◆ RemoveRunAttr()

void Aspose::Words::Drawing::ShapeBase::RemoveRunAttr ( int32_t  key)

◆ RemoveShapeAttr()

void Aspose::Words::Drawing::ShapeBase::RemoveShapeAttr ( int32_t  key)

Reserved for system use. IShapeAttrSource.

◆ set_AllowOverlap()

void Aspose::Words::Drawing::ShapeBase::set_AllowOverlap ( bool  value)

◆ set_AlternativeText()

void Aspose::Words::Drawing::ShapeBase::set_AlternativeText ( System::String  value)

◆ set_AnchorLocked()

void Aspose::Words::Drawing::ShapeBase::set_AnchorLocked ( bool  value)

◆ set_AspectRatioLocked()

void Aspose::Words::Drawing::ShapeBase::set_AspectRatioLocked ( bool  value)

◆ set_BehindText()

void Aspose::Words::Drawing::ShapeBase::set_BehindText ( bool  value)

◆ set_Bounds()

void Aspose::Words::Drawing::ShapeBase::set_Bounds ( System::Drawing::RectangleF  value)

◆ set_CoordOrigin()

void Aspose::Words::Drawing::ShapeBase::set_CoordOrigin ( System::Drawing::Point  value)

◆ set_CoordSize()

void Aspose::Words::Drawing::ShapeBase::set_CoordSize ( System::Drawing::Size  value)

◆ set_DeleteRevision()

void Aspose::Words::Drawing::ShapeBase::set_DeleteRevision ( System::SharedPtr< Aspose::Words::Revisions::EditRevision >  value)

◆ set_DistanceBottom()

void Aspose::Words::Drawing::ShapeBase::set_DistanceBottom ( double  value)

◆ set_DistanceLeft()

void Aspose::Words::Drawing::ShapeBase::set_DistanceLeft ( double  value)

◆ set_DistanceRight()

void Aspose::Words::Drawing::ShapeBase::set_DistanceRight ( double  value)

◆ set_DistanceTop()

void Aspose::Words::Drawing::ShapeBase::set_DistanceTop ( double  value)

◆ set_FlipOrientation()

void Aspose::Words::Drawing::ShapeBase::set_FlipOrientation ( Aspose::Words::Drawing::FlipOrientation  value)

◆ set_Height()

void Aspose::Words::Drawing::ShapeBase::set_Height ( double  value)

◆ set_HorizontalAlignment()

void Aspose::Words::Drawing::ShapeBase::set_HorizontalAlignment ( Aspose::Words::Drawing::HorizontalAlignment  value)

◆ set_HRef()

void Aspose::Words::Drawing::ShapeBase::set_HRef ( System::String  value)

◆ set_InsertRevision()

void Aspose::Words::Drawing::ShapeBase::set_InsertRevision ( System::SharedPtr< Aspose::Words::Revisions::EditRevision >  value)

◆ set_IsLayoutInCell()

void Aspose::Words::Drawing::ShapeBase::set_IsLayoutInCell ( bool  value)

◆ set_Left()

void Aspose::Words::Drawing::ShapeBase::set_Left ( double  value)

◆ set_MoveFromRevision()

void Aspose::Words::Drawing::ShapeBase::set_MoveFromRevision ( System::SharedPtr< Aspose::Words::Revisions::MoveRevision >  value)

◆ set_MoveToRevision()

void Aspose::Words::Drawing::ShapeBase::set_MoveToRevision ( System::SharedPtr< Aspose::Words::Revisions::MoveRevision >  value)

◆ set_Name()

void Aspose::Words::Drawing::ShapeBase::set_Name ( System::String  value)

◆ set_RelativeHorizontalPosition()

void Aspose::Words::Drawing::ShapeBase::set_RelativeHorizontalPosition ( Aspose::Words::Drawing::RelativeHorizontalPosition  value)

◆ set_RelativeVerticalPosition()

void Aspose::Words::Drawing::ShapeBase::set_RelativeVerticalPosition ( Aspose::Words::Drawing::RelativeVerticalPosition  value)

◆ set_Rotation()

void Aspose::Words::Drawing::ShapeBase::set_Rotation ( double  value)

◆ set_RunPr_IInline()

void Aspose::Words::Drawing::ShapeBase::set_RunPr_IInline ( System::SharedPtr< Aspose::Words::RunPr >  value)

◆ set_ScreenTip()

void Aspose::Words::Drawing::ShapeBase::set_ScreenTip ( System::String  value)

◆ set_Target()

void Aspose::Words::Drawing::ShapeBase::set_Target ( System::String  value)

◆ set_Title()

void Aspose::Words::Drawing::ShapeBase::set_Title ( System::String  value)

◆ set_Top()

void Aspose::Words::Drawing::ShapeBase::set_Top ( double  value)

◆ set_VerticalAlignment()

void Aspose::Words::Drawing::ShapeBase::set_VerticalAlignment ( Aspose::Words::Drawing::VerticalAlignment  value)

◆ set_Width()

void Aspose::Words::Drawing::ShapeBase::set_Width ( double  value)

◆ set_WrapSide()

void Aspose::Words::Drawing::ShapeBase::set_WrapSide ( Aspose::Words::Drawing::WrapSide  value)

◆ set_WrapType()

void Aspose::Words::Drawing::ShapeBase::set_WrapType ( Aspose::Words::Drawing::WrapType  value)

◆ set_ZOrder()

void Aspose::Words::Drawing::ShapeBase::set_ZOrder ( int32_t  value)

◆ set_ZOrder_IShape()

void Aspose::Words::Drawing::ShapeBase::set_ZOrder_IShape ( int32_t  value)

◆ SetRunAttr()

void Aspose::Words::Drawing::ShapeBase::SetRunAttr ( int32_t  fontAttr,
System::SharedPtr< System::Object value 
)

◆ SetShapeAttr()

void Aspose::Words::Drawing::ShapeBase::SetShapeAttr ( int32_t  key,
System::SharedPtr< System::Object value 
)

Reserved for system use. IShapeAttrSource.