Represents a shape on a slide. More...

Inherits Aspose::Slides::ISlideComponent, and Aspose::Slides::IHyperlinkContainer.

Inherited by Aspose::Slides::IGeometryShape [virtual], Aspose::Slides::IGraphicalObject [virtual], Aspose::Slides::IGroupShape [virtual], and Aspose::Slides::Shape [virtual].

Public Member Functions
virtual bool	get_IsTextHolder ()=0
	Determines whether the shape is TextHolder. Read-only bool. More...

virtual System::SharedPtr< IPlaceholder >	get_Placeholder ()=0
	Returns the placeholder for a shape. Read-only IPlaceholder. More...

virtual System::SharedPtr< ICustomData >	get_CustomData ()=0
	Returns the shape's custom data. Read-only ICustomData. More...

virtual System::SharedPtr< IShapeFrame >	get_RawFrame ()=0
	Returns the raw shape frame's properties. Read IShapeFrame. More...

virtual void	set_RawFrame (System::SharedPtr< IShapeFrame > value)=0
	Sets the raw shape frame's properties. Write IShapeFrame. More...

virtual System::SharedPtr< IShapeFrame >	get_Frame ()=0
	Returns the shape frame's properties. Read IShapeFrame. More...

virtual void	set_Frame (System::SharedPtr< IShapeFrame > value)=0
	Sets the shape frame's properties. Write IShapeFrame. More...

virtual System::SharedPtr< ILineFormat >	get_LineFormat ()=0
	Returns the LineFormat object that contains line formatting properties for a shape. Read-only ILineFormat. More...

virtual System::SharedPtr< IThreeDFormat >	get_ThreeDFormat ()=0
	Returns the ThreeDFormat object that contains line formatting properties for a shape. Read-only IThreeDFormat. More...

virtual System::SharedPtr< IEffectFormat >	get_EffectFormat ()=0
	Returns the EffectFormat object which contains pixel effects applied to a shape. Read-only IEffectFormat. More...

virtual System::SharedPtr< IFillFormat >	get_FillFormat ()=0
	Returns the FillFormat object that contains fill formatting properties for a shape. Read-only IFillFormat. More...

virtual bool	get_Hidden ()=0
	Determines whether the shape is hidden. Read bool. More...

virtual void	set_Hidden (bool value)=0
	Determines whether the shape is hidden. Write bool. More...

virtual int32_t	get_ZOrderPosition ()=0
	Returns the position of a shape in the z-order. Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order. Read-only int32_t. More...

virtual int32_t	get_ConnectionSiteCount ()=0
	Returns the number of connection sites on the shape. Read-only int32_t. More...

virtual float	get_Rotation ()=0
	Returns the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read float. More...

virtual void	set_Rotation (float value)=0
	Sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Write float. More...

virtual float	get_X ()=0
	Returns the x-coordinate of the upper-left corner of the shape. Read float. More...

virtual void	set_X (float value)=0
	Sets the x-coordinate of the upper-left corner of the shape. Write float. More...

virtual float	get_Y ()=0
	Returns the y-coordinate of the upper-left corner of the shape. Read float. More...

virtual void	set_Y (float value)=0
	Sets the y-coordinate of the upper-left corner of the shape. Write float. More...

virtual float	get_Width ()=0
	Returns the width of the shape. Read float. More...

virtual void	set_Width (float value)=0
	Sets the width of the shape. Write float. More...

virtual float	get_Height ()=0
	Returns the height of the shape. Read float. More...

virtual void	set_Height (float value)=0
	Sets the height of the shape. Write float. More...

virtual System::String	get_AlternativeText ()=0
	Returns the alternative text associated with a shape. Read System::String. More...

virtual void	set_AlternativeText (System::String value)=0
	Sets the alternative text associated with a shape. Write System::String. More...

virtual System::String	get_AlternativeTextTitle ()=0
	Returns the title of alternative text associated with a shape. Read System::String. More...

virtual void	set_AlternativeTextTitle (System::String value)=0
	Sets the title of alternative text associated with a shape. Write System::String. More...

virtual System::String	get_Name ()=0
	Returns the name of a shape. Read System::String. More...

virtual void	set_Name (System::String value)=0
	Sets the name of a shape. Write System::String. More...

virtual System::SharedPtr< IBaseShapeLock >	get_ShapeLock ()=0
	Returns shape's locks. Read-only IBaseShapeLock. More...

virtual uint32_t	get_UniqueId ()=0
	Gets unique shape identifier in presentation scope. Read-only uint32_t. See also OfficeInteropShapeId for getting unique shape identifier in slide scope. More...

virtual uint32_t	get_OfficeInteropShapeId ()=0
	Gets unique shape identifier in slide scope. Read-only uint32_t. See also UniqueId for getting unique shape identifier in presentation scope. More...

virtual bool	get_IsGrouped ()=0
	Determines whether the shape is grouped. Read-only bool. More...

virtual Aspose::Slides::BlackWhiteMode	get_BlackWhiteMode ()=0
	Property specifies how a shape will render in black-and-white display mode.. Read Slides::BlackWhiteMode. More...

virtual void	set_BlackWhiteMode (Aspose::Slides::BlackWhiteMode value)=0
	Property specifies how a shape will render in black-and-white display mode.. Write Slides::BlackWhiteMode. More...

virtual System::SharedPtr< IGroupShape >	get_ParentGroup ()=0
	Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape. More...

virtual System::SharedPtr< IPlaceholder >	AddPlaceholder (System::SharedPtr< IPlaceholder > placeholderToCopyFrom)=0
	Adds a new placeholder if there is no and sets placeholder properties to a specified one. More...

virtual void	RemovePlaceholder ()=0
	Defines that this shape isn't a placeholder. More...

virtual System::SharedPtr< ILineFormatEffectiveData >	CreateLineFormatEffective ()=0
	Creates the LineFormatEffectiveData object that contains all line formatting properties for a shape, included inherited. More...

virtual System::SharedPtr< IFillFormatEffectiveData >	CreateFillFormatEffective ()=0
	Creates the FillFormatEffectiveData object that contains all fill formatting properties for a shape, included inherited. More...

virtual System::SharedPtr< IEffectFormatEffectiveData >	CreateEffectFormatEffective ()=0
	Creates the EffectFormatEffectiveData object that contains all effects applyed to a shape, included inherited. More...

virtual System::SharedPtr< IThreeDFormatEffectiveData >	CreateThreeDFormatEffective ()=0
	Creates the ThreeDFormatEffectiveData object that contains volume properties and 3D transformation of a shape, included inherited. More...

virtual System::SharedPtr< System::Drawing::Bitmap >	GetThumbnail ()=0
	Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default. More...

virtual System::SharedPtr< System::Drawing::Bitmap >	GetThumbnail (ShapeThumbnailBounds bounds, float scaleX, float scaleY)=0
	Returns shape thumbnail. More...

virtual void	WriteAsSvg (System::SharedPtr< System::IO::Stream > stream)=0
	Saves content of Shape as SVG file. More...

virtual void	WriteAsSvg (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< Export::ISVGOptions > svgOptions)=0
	Saves content of Shape as SVG file. More...

Public Member Functions inherited from Aspose::Slides::ISlideComponent
virtual System::SharedPtr< IBaseSlide >	get_Slide ()=0
	Returns the base slide. Read-only IBaseSlide. More...

Public Member Functions inherited from Aspose::Slides::IPresentationComponent
virtual System::SharedPtr< IPresentation >	get_Presentation ()=0
	Returns the presentation. Read-only IPresentation. 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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...

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)

Public Member Functions inherited from Aspose::Slides::IHyperlinkContainer
virtual System::SharedPtr< IHyperlink >	get_HyperlinkClick ()=0
	Returns the hyperlink defined for mouse click. Read IHyperlink. More...

virtual void	set_HyperlinkClick (System::SharedPtr< IHyperlink > value)=0
	Sets the hyperlink defined for mouse click. Write IHyperlink. More...

virtual System::SharedPtr< IHyperlink >	get_HyperlinkMouseOver ()=0
	Returns the hyperlink defined for mouse over. Read IHyperlink. More...

virtual void	set_HyperlinkMouseOver (System::SharedPtr< IHyperlink > value)=0
	Sets the hyperlink defined for mouse over. Write IHyperlink. More...

virtual System::SharedPtr< IHyperlinkManager >	get_HyperlinkManager ()=0
	Hyperlinks manager Read-only IHyperlinkManager. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

typedef System::Details::SharedMembersType	shared_members_type
	structure to keep list of shared pointers contained in object. 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 TypeInfo &	Type ()
	Impleemnts C# typeof(System.Object) construct. More...

Detailed Description

Represents a shape on a slide.

Member Function Documentation

◆ AddPlaceholder()

virtual System::SharedPtr<IPlaceholder> Aspose::Slides::IShape::AddPlaceholder ( System::SharedPtr< IPlaceholder > placeholderToCopyFrom )

pure virtual

Adds a new placeholder if there is no and sets placeholder properties to a specified one.

Parameters

placeholderToCopyFrom Placeholder to copy content from.

Returns: New IPlaceholder.

Implemented in Aspose::Slides::Shape.

◆ CreateEffectFormatEffective()

virtual System::SharedPtr<IEffectFormatEffectiveData> Aspose::Slides::IShape::CreateEffectFormatEffective ( )

pure virtual

Creates the EffectFormatEffectiveData object that contains all effects applyed to a shape, included inherited.

Deprecated:: Use EffectFormat.GetEffective() instead. The method will be removed after release of version 20.8.

Returns: IEffectFormatEffectiveData.

Implemented in Aspose::Slides::Shape.

◆ CreateFillFormatEffective()

virtual System::SharedPtr<IFillFormatEffectiveData> Aspose::Slides::IShape::CreateFillFormatEffective ( )

pure virtual

Creates the FillFormatEffectiveData object that contains all fill formatting properties for a shape, included inherited.

Deprecated:: Use FillFormat.GetEffective() instead. The method will be removed after release of version 20.8.

Returns: IFillFormatEffectiveData.

Implemented in Aspose::Slides::Shape.

◆ CreateLineFormatEffective()

virtual System::SharedPtr<ILineFormatEffectiveData> Aspose::Slides::IShape::CreateLineFormatEffective ( )

pure virtual

Creates the LineFormatEffectiveData object that contains all line formatting properties for a shape, included inherited.

Deprecated:: Use LineFormat.GetEffective() instead. The method will be removed after release of version 20.8.

Returns: ILineFormatEffectiveData.

Implemented in Aspose::Slides::Shape.

◆ CreateThreeDFormatEffective()

virtual System::SharedPtr<IThreeDFormatEffectiveData> Aspose::Slides::IShape::CreateThreeDFormatEffective ( )

pure virtual

Creates the ThreeDFormatEffectiveData object that contains volume properties and 3D transformation of a shape, included inherited.

Deprecated:: Use ThreeDFormatFormat.GetEffective() instead. The method will be removed after release of version 20.8.

Returns: IThreeDFormatEffectiveData.

Implemented in Aspose::Slides::Shape.

◆ get_AlternativeText()

virtual System::String Aspose::Slides::IShape::get_AlternativeText ( )

pure virtual

Returns the alternative text associated with a shape. Read System::String.

Implemented in Aspose::Slides::Shape.

◆ get_AlternativeTextTitle()

virtual System::String Aspose::Slides::IShape::get_AlternativeTextTitle ( )

pure virtual

Returns the title of alternative text associated with a shape. Read System::String.

Implemented in Aspose::Slides::Shape.

◆ get_BlackWhiteMode()

virtual Aspose::Slides::BlackWhiteMode Aspose::Slides::IShape::get_BlackWhiteMode ( )

pure virtual

Property specifies how a shape will render in black-and-white display mode.. Read Slides::BlackWhiteMode.

Implemented in Aspose::Slides::Shape.

◆ get_ConnectionSiteCount()

virtual int32_t Aspose::Slides::IShape::get_ConnectionSiteCount ( )

pure virtual

Returns the number of connection sites on the shape. Read-only int32_t.

Implemented in Aspose::Slides::Shape.

◆ get_CustomData()

virtual System::SharedPtr<ICustomData> Aspose::Slides::IShape::get_CustomData ( )

pure virtual

Returns the shape's custom data. Read-only ICustomData.

Implemented in Aspose::Slides::Shape.

◆ get_EffectFormat()

virtual System::SharedPtr<IEffectFormat> Aspose::Slides::IShape::get_EffectFormat ( )

pure virtual

Returns the EffectFormat object which contains pixel effects applied to a shape. Read-only IEffectFormat.

Implemented in Aspose::Slides::Shape.

◆ get_FillFormat()

virtual System::SharedPtr<IFillFormat> Aspose::Slides::IShape::get_FillFormat ( )

pure virtual

Returns the FillFormat object that contains fill formatting properties for a shape. Read-only IFillFormat.

Implemented in Aspose::Slides::Shape, and Aspose::Slides::Table.

◆ get_Frame()

virtual System::SharedPtr<IShapeFrame> Aspose::Slides::IShape::get_Frame ( )

pure virtual

Returns the shape frame's properties. Read IShapeFrame.

Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ get_Height()

virtual float Aspose::Slides::IShape::get_Height ( )

pure virtual

Returns the height of the shape. Read float.

Returned value is always defined (is not float.NaN). Assigned value must be defined (not float.NaN). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ get_Hidden()

virtual bool Aspose::Slides::IShape::get_Hidden ( )

pure virtual

Determines whether the shape is hidden. Read bool.

Implemented in Aspose::Slides::Shape.

◆ get_IsGrouped()

virtual bool Aspose::Slides::IShape::get_IsGrouped ( )

pure virtual

Determines whether the shape is grouped. Read-only bool.

Property ParentGroup returns parent GroupShape object if shape is grouped.

Implemented in Aspose::Slides::Shape.

◆ get_IsTextHolder()

virtual bool Aspose::Slides::IShape::get_IsTextHolder ( )

pure virtual

Determines whether the shape is TextHolder. Read-only bool.

Implemented in Aspose::Slides::Shape.

◆ get_LineFormat()

virtual System::SharedPtr<ILineFormat> Aspose::Slides::IShape::get_LineFormat ( )

pure virtual

Returns the LineFormat object that contains line formatting properties for a shape. Read-only ILineFormat.

Implemented in Aspose::Slides::Shape, and Aspose::Slides::GroupShape.

◆ get_Name()

virtual System::String Aspose::Slides::IShape::get_Name ( )

pure virtual

Returns the name of a shape. Read System::String.

Implemented in Aspose::Slides::Shape.

◆ get_OfficeInteropShapeId()

virtual uint32_t Aspose::Slides::IShape::get_OfficeInteropShapeId ( )

pure virtual

Gets unique shape identifier in slide scope. Read-only uint32_t. See also UniqueId for getting unique shape identifier in presentation scope.

Implemented in Aspose::Slides::Shape.

◆ get_ParentGroup()

virtual System::SharedPtr<IGroupShape> Aspose::Slides::IShape::get_ParentGroup ( )

pure virtual

Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape.

Property IsGrouped determines whether the shape is grouped.

Implemented in Aspose::Slides::Shape.

◆ get_Placeholder()

virtual System::SharedPtr<IPlaceholder> Aspose::Slides::IShape::get_Placeholder ( )

pure virtual

Returns the placeholder for a shape. Read-only IPlaceholder.

Implemented in Aspose::Slides::Shape.

◆ get_RawFrame()

virtual System::SharedPtr<IShapeFrame> Aspose::Slides::IShape::get_RawFrame ( )

pure virtual

Returns the raw shape frame's properties. Read IShapeFrame.

Code that attempts to assign undefined frame to IShape.Frame doesn't make sence in general case (particulary in case when parent GroupShape is multiple nested into other GroupShape-s). For example: {code}IShape shape = ...; shape.Frame = new ShapeFrame(float.NaN, float.NaN, float.NaN, float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, float.NaN);{code} or {code}slide.Shapes.AddAutoShape(ShapeType.RoundCornerRectangle, float.NaN, float.NaN, float.NaN, float.NaN);{code} Such code can lead to unclear situations. So restrictions had been added for using undefined values for IShape.Frame. Values of x, y, width, height, flipH, flipV and rotationAngle must be defined (not float.NaN or NullableBool.NotDefined). Example code above now throws ArgumentException exception. This applies to these use cases: {code}IShape shape = ...; shape.Frame = ...; // cannot be undefined

IShapeCollection shapes = ...; // x, y, width, height parameters cannot be float.NaN: { shapes.AddAudioFrameCD(...); shapes.AddAudioFrameEmbedded(...); shapes.AddAudioFrameLinked(...); shapes.AddAutoShape(...); shapes.AddChart(...); shapes.AddConnector(...); shapes.AddOleObjectFrame(...); shapes.AddPictureFrame(...); shapes.AddSmartArt(...); shapes.AddTable(...); shapes.AddVideoFrame(...); shapes.InsertAudioFrameEmbedded(...); shapes.InsertAudioFrameLinked(...); shapes.InsertAutoShape(...); shapes.InsertChart(...); shapes.InsertConnector(...); shapes.InsertOleObjectFrame(...); shapes.InsertPictureFrame(...); shapes.InsertTable(...); shapes.InsertVideoFrame(...); }{code}

But IShape.RawFrame frame properties can be undefined. This make sence when shape is linked to placeholder. Then undefined shape frame values is overridden from the parent placeholder shape. If there is no parent placeholder shape for that shape then that shape uses default values when it evaluates effective frame based on its IShape.RawFrame. Default values are 0 and NullableBool.False for x, y, width, height, flipH, flipV and rotationAngle. For example: {code}IShape shape = ...; // shape is linked to placeholder shape.RawFrame = new ShapeFrame(float.NaN, float.NaN, 100, float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, 0); // now shape inherits x, y, height, flipH, flipV values form placeholder and overrides width=100 and rotationAngle=0.{code}

Implemented in Aspose::Slides::Shape.

◆ get_Rotation()

virtual float Aspose::Slides::IShape::get_Rotation ( )

pure virtual

Returns the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read float.

Returned value is always defined (is not float.NaN). Assigned value must be defined (not float.NaN). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ get_ShapeLock()

virtual System::SharedPtr<IBaseShapeLock> Aspose::Slides::IShape::get_ShapeLock ( )

pure virtual

Returns shape's locks. Read-only IBaseShapeLock.

Implemented in Aspose::Slides::Shape.

◆ get_ThreeDFormat()

virtual System::SharedPtr<IThreeDFormat> Aspose::Slides::IShape::get_ThreeDFormat ( )

pure virtual

Returns the ThreeDFormat object that contains line formatting properties for a shape. Read-only IThreeDFormat.

Implemented in Aspose::Slides::Shape.

◆ get_UniqueId()

virtual uint32_t Aspose::Slides::IShape::get_UniqueId ( )

pure virtual

Gets unique shape identifier in presentation scope. Read-only uint32_t. See also OfficeInteropShapeId for getting unique shape identifier in slide scope.

Implemented in Aspose::Slides::Shape.

◆ get_Width()

virtual float Aspose::Slides::IShape::get_Width ( )

pure virtual

Returns the width of the shape. Read float.

Returned value is always defined (is not float.NaN). Assigned value must be defined (not float.NaN). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ get_X()

virtual float Aspose::Slides::IShape::get_X ( )

pure virtual

Returns the x-coordinate of the upper-left corner of the shape. Read float.

Returned value is always defined (is not float.NaN). Assigned value must be defined (not float.NaN). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ get_Y()

virtual float Aspose::Slides::IShape::get_Y ( )

pure virtual

Returns the y-coordinate of the upper-left corner of the shape. Read float.

Returned value is always defined (is not float.NaN). Assigned value must be defined (not float.NaN). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ get_ZOrderPosition()

virtual int32_t Aspose::Slides::IShape::get_ZOrderPosition ( )

pure virtual

Returns the position of a shape in the z-order. Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order. Read-only int32_t.

Implemented in Aspose::Slides::Shape.

◆ GetThumbnail() [1/2]

virtual System::SharedPtr<System::Drawing::Bitmap> Aspose::Slides::IShape::GetThumbnail ( )

pure virtual

Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.

Returns: Shape thumbnail.

Implemented in Aspose::Slides::Shape.

◆ GetThumbnail() [2/2]

virtual System::SharedPtr<System::Drawing::Bitmap> Aspose::Slides::IShape::GetThumbnail	(	ShapeThumbnailBounds	bounds,
		float	scaleX,
		float	scaleY
	)

pure virtual

Returns shape thumbnail.

Parameters

bounds	Shape thumbnail bounds type.
scaleX	X scale
scaleY	Y scale

Returns: Shape thumbnail or null in case when ShapeThumbnailBounds.Appearance is used and a shape doesn't have visible elements.

Implemented in Aspose::Slides::Shape.

◆ RemovePlaceholder()

virtual void Aspose::Slides::IShape::RemovePlaceholder ( )

pure virtual

Defines that this shape isn't a placeholder.

Implemented in Aspose::Slides::Shape.

◆ set_AlternativeText()

virtual void Aspose::Slides::IShape::set_AlternativeText ( System::String value )

pure virtual

Sets the alternative text associated with a shape. Write System::String.

Implemented in Aspose::Slides::Shape.

◆ set_AlternativeTextTitle()

virtual void Aspose::Slides::IShape::set_AlternativeTextTitle ( System::String value )

pure virtual

Sets the title of alternative text associated with a shape. Write System::String.

Implemented in Aspose::Slides::Shape.

◆ set_BlackWhiteMode()

virtual void Aspose::Slides::IShape::set_BlackWhiteMode ( Aspose::Slides::BlackWhiteMode value )

pure virtual

Property specifies how a shape will render in black-and-white display mode.. Write Slides::BlackWhiteMode.

Implemented in Aspose::Slides::Shape.

◆ set_Frame()

virtual void Aspose::Slides::IShape::set_Frame ( System::SharedPtr< IShapeFrame > value )

pure virtual

Sets the shape frame's properties. Write IShapeFrame.

Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ set_Height()

virtual void Aspose::Slides::IShape::set_Height ( float value )

pure virtual

Sets the height of the shape. Write float.

Returned value is always defined (is not float.NaN). Assigned value must be defined (not float.NaN). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ set_Hidden()

virtual void Aspose::Slides::IShape::set_Hidden ( bool value )

pure virtual

Determines whether the shape is hidden. Write bool.

Implemented in Aspose::Slides::Shape.

◆ set_Name()

virtual void Aspose::Slides::IShape::set_Name ( System::String value )

pure virtual

Sets the name of a shape. Write System::String.

Implemented in Aspose::Slides::Shape.

◆ set_RawFrame()

virtual void Aspose::Slides::IShape::set_RawFrame ( System::SharedPtr< IShapeFrame > value )

pure virtual

Sets the raw shape frame's properties. Write IShapeFrame.

Code that attempts to assign undefined frame to IShape.Frame doesn't make sence in general case (particulary in case when parent GroupShape is multiple nested into other GroupShape-s). For example: {code}IShape shape = ...; shape.Frame = new ShapeFrame(float.NaN, float.NaN, float.NaN, float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, float.NaN);{code} or {code}slide.Shapes.AddAutoShape(ShapeType.RoundCornerRectangle, float.NaN, float.NaN, float.NaN, float.NaN);{code} Such code can lead to unclear situations. So restrictions had been added for using undefined values for IShape.Frame. Values of x, y, width, height, flipH, flipV and rotationAngle must be defined (not float.NaN or NullableBool.NotDefined). Example code above now throws ArgumentException exception. This applies to these use cases: {code}IShape shape = ...; shape.Frame = ...; // cannot be undefined

IShapeCollection shapes = ...; // x, y, width, height parameters cannot be float.NaN: { shapes.AddAudioFrameCD(...); shapes.AddAudioFrameEmbedded(...); shapes.AddAudioFrameLinked(...); shapes.AddAutoShape(...); shapes.AddChart(...); shapes.AddConnector(...); shapes.AddOleObjectFrame(...); shapes.AddPictureFrame(...); shapes.AddSmartArt(...); shapes.AddTable(...); shapes.AddVideoFrame(...); shapes.InsertAudioFrameEmbedded(...); shapes.InsertAudioFrameLinked(...); shapes.InsertAutoShape(...); shapes.InsertChart(...); shapes.InsertConnector(...); shapes.InsertOleObjectFrame(...); shapes.InsertPictureFrame(...); shapes.InsertTable(...); shapes.InsertVideoFrame(...); }{code}

But IShape.RawFrame frame properties can be undefined. This make sence when shape is linked to placeholder. Then undefined shape frame values is overridden from the parent placeholder shape. If there is no parent placeholder shape for that shape then that shape uses default values when it evaluates effective frame based on its IShape.RawFrame. Default values are 0 and NullableBool.False for x, y, width, height, flipH, flipV and rotationAngle. For example: {code}IShape shape = ...; // shape is linked to placeholder shape.RawFrame = new ShapeFrame(float.NaN, float.NaN, 100, float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, 0); // now shape inherits x, y, height, flipH, flipV values form placeholder and overrides width=100 and rotationAngle=0.{code}

Implemented in Aspose::Slides::Shape.

◆ set_Rotation()

virtual void Aspose::Slides::IShape::set_Rotation ( float value )

pure virtual

Sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Write float.

Returned value is always defined (is not float.NaN). Assigned value must be defined (not float.NaN). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ set_Width()

virtual void Aspose::Slides::IShape::set_Width ( float value )

pure virtual

Sets the width of the shape. Write float.

Returned value is always defined (is not float.NaN). Assigned value must be defined (not float.NaN). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ set_X()

virtual void Aspose::Slides::IShape::set_X ( float value )

pure virtual

Sets the x-coordinate of the upper-left corner of the shape. Write float.

Returned value is always defined (is not float.NaN). Assigned value must be defined (not float.NaN). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ set_Y()

virtual void Aspose::Slides::IShape::set_Y ( float value )

pure virtual

Sets the y-coordinate of the upper-left corner of the shape. Write float.

Returned value is always defined (is not float.NaN). Assigned value must be defined (not float.NaN). You can set undefined values for RawFrame instance properties.

Implemented in Aspose::Slides::Shape.

◆ WriteAsSvg() [1/2]

virtual void Aspose::Slides::IShape::WriteAsSvg ( System::SharedPtr< System::IO::Stream > stream )

pure virtual

Saves content of Shape as SVG file.

Parameters

stream Target stream

Implemented in Aspose::Slides::Shape.

◆ WriteAsSvg() [2/2]

virtual void Aspose::Slides::IShape::WriteAsSvg	(	System::SharedPtr< System::IO::Stream >	stream,
		System::SharedPtr< Export::ISVGOptions >	svgOptions
	)

pure virtual

Saves content of Shape as SVG file.

Parameters

stream	Target stream
svgOptions	SVG generation options

Implemented in Aspose::Slides::Shape.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddPlaceholder()

◆ CreateEffectFormatEffective()

◆ CreateFillFormatEffective()

◆ CreateLineFormatEffective()

◆ CreateThreeDFormatEffective()

◆ get_AlternativeText()

◆ get_AlternativeTextTitle()

◆ get_BlackWhiteMode()

◆ get_ConnectionSiteCount()

◆ get_CustomData()

◆ get_EffectFormat()

◆ get_FillFormat()

◆ get_Frame()

◆ get_Height()

◆ get_Hidden()

◆ get_IsGrouped()

◆ get_IsTextHolder()

◆ get_LineFormat()

◆ get_Name()

◆ get_OfficeInteropShapeId()

◆ get_ParentGroup()

◆ get_Placeholder()

◆ get_RawFrame()

◆ get_Rotation()

◆ get_ShapeLock()

◆ get_ThreeDFormat()

◆ get_UniqueId()

◆ get_Width()

◆ get_X()

◆ get_Y()

◆ get_ZOrderPosition()

◆ GetThumbnail() [1/2]

◆ GetThumbnail() [2/2]

◆ RemovePlaceholder()

◆ set_AlternativeText()

◆ set_AlternativeTextTitle()

◆ set_BlackWhiteMode()

◆ set_Frame()

◆ set_Height()

◆ set_Hidden()

◆ set_Name()

◆ set_RawFrame()

◆ set_Rotation()

◆ set_Width()

◆ set_X()

◆ set_Y()

◆ WriteAsSvg() [1/2]

◆ WriteAsSvg() [2/2]