Represents an OLE object on a slide. More...

Inherits Aspose::Slides::IGraphicalObject.

Inherited by Aspose::Slides::OleObjectFrame.

Public Member Functions
virtual System::SharedPtr< IPictureFillFormat >	get_SubstitutePictureFormat ()=0
	Returns OleObject image fill properties object. Read-only IPictureFillFormat. More...

virtual System::String	get_ObjectName ()=0
	Returns the name of an object. Read System::String. More...

virtual void	set_ObjectName (System::String value)=0
	Sets the name of an object. Write System::String. More...

virtual System::SharedPtr< IOleEmbeddedDataInfo >	get_EmbeddedData ()=0
	Gets information about OLE embedded data. Read only IOleEmbeddedDataInfo. More...

virtual System::String	get_ObjectProgId ()=0
	Returns the ProgID of an object. Read olny System::String. More...

virtual void	set_ObjectProgId (System::String value)=0
	Returns the ProgID of an object. Read olny System::String. More...

virtual System::ArrayPtr< uint8_t >	get_ObjectData ()=0
	Gets embedded object as byte array. Read uint8_t[]. More...

virtual void	set_ObjectData (System::ArrayPtr< uint8_t > value)=0
	Sets embedded object as byte array. Write uint8_t[]. More...

virtual System::String	get_LinkFileName ()=0
	Returns the full path to a linked file. Short file name will be used. Read-only System::String. More...

virtual System::String	get_LinkPathLong ()=0
	Returns the full path to a linked file. Long file name will be used. Read System::String. More...

virtual void	set_LinkPathLong (System::String value)=0
	Returns the full path to a linked file. Long file name will be used. Write System::String. More...

virtual System::String	get_EmbeddedFileLabel ()=0
	Returns the file name of embedded OLE object More...

virtual System::String	get_EmbeddedFileName ()=0
	Returns the path of embedded OLE object More...

virtual System::String	get_EmbeddedFileExtension ()=0
	Returns the file extension for the current embedded object or empty string if object is not a link More...

virtual System::ArrayPtr< uint8_t >	get_EmbeddedFileData ()=0
	Returns the file data of embedded OLE object More...

virtual bool	get_IsObjectIcon ()=0
	Determines whether an object is visible as icon. Read bool. More...

virtual void	set_IsObjectIcon (bool value)=0
	Determines whether an object is visible as icon. Write bool. More...

virtual bool	get_IsObjectLink ()=0
	Determines whether an object is linked to external file. Read-only bool. More...

virtual bool	get_UpdateAutomatic ()=0
	Determines if the linked embedded object is automatically updated when the presentation is opened or printed. Read bool. More...

virtual void	set_UpdateAutomatic (bool value)=0
	Determines if the linked embedded object is automatically updated when the presentation is opened or printed. Write bool. More...

virtual System::String	get_SubstitutePictureTitle ()=0
	Returns the title for OleObject icon. Read System::String. More...

virtual void	set_SubstitutePictureTitle (System::String value)=0
	Sets the title for OleObject icon. Write System::String. More...

virtual void	SetEmbeddedData (System::SharedPtr< IOleEmbeddedDataInfo > embeddedData)=0
	Sets information about OLE embedded data. More...

Public Member Functions inherited from Aspose::Slides::IGraphicalObject
virtual System::SharedPtr< IGraphicalObjectLock >	get_GraphicalObjectLock ()=0
	Returns shape's locks. Read-only IGraphicalObjectLock. More...

Public Member Functions inherited from Aspose::Slides::IShape
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 IShape::get_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 IShape::get_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< 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 reference 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 int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () 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 (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

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...

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 ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Detailed Description

Represents an OLE object on a slide.

Member Function Documentation

◆ get_EmbeddedData()

virtual System::SharedPtr<IOleEmbeddedDataInfo> Aspose::Slides::IOleObjectFrame::get_EmbeddedData ( )

pure virtual

Gets information about OLE embedded data. Read only IOleEmbeddedDataInfo.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_EmbeddedFileData()

virtual System::ArrayPtr<uint8_t> Aspose::Slides::IOleObjectFrame::get_EmbeddedFileData ( )

pure virtual

Returns the file data of embedded OLE object

Deprecated:: Use OleObjectFrame.SetEmbeddedData method and EmbeddedData property instead. The property will be removed after release of version 21.11.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_EmbeddedFileExtension()

virtual System::String Aspose::Slides::IOleObjectFrame::get_EmbeddedFileExtension ( )

pure virtual

Returns the file extension for the current embedded object or empty string if object is not a link

Deprecated:: Use OleObjectFrame.SetEmbeddedData method and EmbeddedData property instead. The property will be removed after release of version 21.11.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_EmbeddedFileLabel()

virtual System::String Aspose::Slides::IOleObjectFrame::get_EmbeddedFileLabel ( )

pure virtual

Returns the file name of embedded OLE object

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_EmbeddedFileName()

virtual System::String Aspose::Slides::IOleObjectFrame::get_EmbeddedFileName ( )

pure virtual

Returns the path of embedded OLE object

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_IsObjectIcon()

virtual bool Aspose::Slides::IOleObjectFrame::get_IsObjectIcon ( )

pure virtual

Determines whether an object is visible as icon. Read bool.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_IsObjectLink()

virtual bool Aspose::Slides::IOleObjectFrame::get_IsObjectLink ( )

pure virtual

Determines whether an object is linked to external file. Read-only bool.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_LinkFileName()

virtual System::String Aspose::Slides::IOleObjectFrame::get_LinkFileName ( )

pure virtual

Returns the full path to a linked file. Short file name will be used. Read-only System::String.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_LinkPathLong()

virtual System::String Aspose::Slides::IOleObjectFrame::get_LinkPathLong ( )

pure virtual

Returns the full path to a linked file. Long file name will be used. Read System::String.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_ObjectData()

virtual System::ArrayPtr<uint8_t> Aspose::Slides::IOleObjectFrame::get_ObjectData ( )

pure virtual

Gets embedded object as byte array. Read uint8_t[].

Deprecated:: Use OleObjectFrame.SetEmbeddedData method and EmbeddedData property instead. The property will be removed after release of version 21.11.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_ObjectName()

virtual System::String Aspose::Slides::IOleObjectFrame::get_ObjectName ( )

pure virtual

Returns the name of an object. Read System::String.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_ObjectProgId()

virtual System::String Aspose::Slides::IOleObjectFrame::get_ObjectProgId ( )

pure virtual

Returns the ProgID of an object. Read olny System::String.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_SubstitutePictureFormat()

virtual System::SharedPtr<IPictureFillFormat> Aspose::Slides::IOleObjectFrame::get_SubstitutePictureFormat ( )

pure virtual

Returns OleObject image fill properties object. Read-only IPictureFillFormat.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_SubstitutePictureTitle()

virtual System::String Aspose::Slides::IOleObjectFrame::get_SubstitutePictureTitle ( )

pure virtual

Returns the title for OleObject icon. Read System::String.

When IsObjectIcon == false this value is ignored. The string can be truncated according to the size of the OLE icon.

Implemented in Aspose::Slides::OleObjectFrame.

◆ get_UpdateAutomatic()

virtual bool Aspose::Slides::IOleObjectFrame::get_UpdateAutomatic ( )

pure virtual

Determines if the linked embedded object is automatically updated when the presentation is opened or printed. Read bool.

Implemented in Aspose::Slides::OleObjectFrame.

◆ set_IsObjectIcon()

virtual void Aspose::Slides::IOleObjectFrame::set_IsObjectIcon ( bool value )

pure virtual

Determines whether an object is visible as icon. Write bool.

Implemented in Aspose::Slides::OleObjectFrame.

◆ set_LinkPathLong()

virtual void Aspose::Slides::IOleObjectFrame::set_LinkPathLong ( System::String value )

pure virtual

Returns the full path to a linked file. Long file name will be used. Write System::String.

Implemented in Aspose::Slides::OleObjectFrame.

◆ set_ObjectData()

virtual void Aspose::Slides::IOleObjectFrame::set_ObjectData ( System::ArrayPtr< uint8_t > value )

pure virtual

Sets embedded object as byte array. Write uint8_t[].

Deprecated:: Use OleObjectFrame.SetEmbeddedData method and EmbeddedData property instead. The property will be removed after release of version 21.11.

Implemented in Aspose::Slides::OleObjectFrame.

◆ set_ObjectName()

virtual void Aspose::Slides::IOleObjectFrame::set_ObjectName ( System::String value )

pure virtual

Sets the name of an object. Write System::String.

Implemented in Aspose::Slides::OleObjectFrame.

◆ set_ObjectProgId()

virtual void Aspose::Slides::IOleObjectFrame::set_ObjectProgId ( System::String value )

pure virtual

Returns the ProgID of an object. Read olny System::String.

Implemented in Aspose::Slides::OleObjectFrame.

◆ set_SubstitutePictureTitle()

virtual void Aspose::Slides::IOleObjectFrame::set_SubstitutePictureTitle ( System::String value )

pure virtual

Sets the title for OleObject icon. Write System::String.

When IsObjectIcon == false this value is ignored. The string can be truncated according to the size of the OLE icon.

Implemented in Aspose::Slides::OleObjectFrame.

◆ set_UpdateAutomatic()

virtual void Aspose::Slides::IOleObjectFrame::set_UpdateAutomatic ( bool value )

pure virtual

Determines if the linked embedded object is automatically updated when the presentation is opened or printed. Write bool.

Implemented in Aspose::Slides::OleObjectFrame.

◆ SetEmbeddedData()

virtual void Aspose::Slides::IOleObjectFrame::SetEmbeddedData ( System::SharedPtr< IOleEmbeddedDataInfo > embeddedData )

pure virtual

Sets information about OLE embedded data.

This method changes the properties of the object to reflect the new data and sets the IsObjectLink flag to false, indicating that the OLE object is embedded.

Parameters

embeddedData Embedded data IOleEmbeddedDataInfo

Exceptions

System::ArgumentNullException When embeddedData parameter is null.

Following example demonstrates how to change OLE embedded data and its type for existing IOleObjectFrame object

System::SharedPtr<Presentation> pres = System::MakeObject<Presentation>(u"SomePresentation.pptx");
 
System::SharedPtr<OleObjectFrame> oof = System::DynamicCast_noexcept<Aspose::Slides::OleObjectFrame>(pres->get_Slides()->idx_get(0)->get_Shapes()->idx_get(0));
if (oof != nullptr)
{
    System::SharedPtr<IOleEmbeddedDataInfo> newData = System::MakeObject<OleEmbeddedDataInfo>(System::IO::File::ReadAllBytes(u"Picture.png"), u"png");
    oof->SetEmbeddedData(newData);
}

Implemented in Aspose::Slides::OleObjectFrame.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_EmbeddedData()

◆ get_EmbeddedFileData()

◆ get_EmbeddedFileExtension()

◆ get_EmbeddedFileLabel()

◆ get_EmbeddedFileName()

◆ get_IsObjectIcon()

◆ get_IsObjectLink()

◆ get_LinkFileName()

◆ get_LinkPathLong()

◆ get_ObjectData()

◆ get_ObjectName()

◆ get_ObjectProgId()

◆ get_SubstitutePictureFormat()

◆ get_SubstitutePictureTitle()

◆ get_UpdateAutomatic()

◆ set_IsObjectIcon()

◆ set_LinkPathLong()

◆ set_ObjectData()

◆ set_ObjectName()

◆ set_ObjectProgId()

◆ set_SubstitutePictureTitle()

◆ set_UpdateAutomatic()

◆ SetEmbeddedData()