OleObject Class

Namespace:
GemBox.Presentation
Assembly:
GemBox.Presentation.dll

Represents an OLE object or control within a presentation.

public sealed class OleObject
Public NotInheritable Class OleObject
Inheritance:
System.Object
OleObject

Properties

ContentType

Gets the content type of the OLE object data.

public string ContentType { get; }
Public ReadOnly Property ContentType As String
Property Value
System.String

The content type of the OLE object data.

Data

Gets the data of the OLE object.

public MemoryStream Data { get; }
Public ReadOnly Property Data As MemoryStream
Property Value
System.IO.MemoryStream

A System.IO.MemoryStream containing the OLE object data.

EmbeddedObjectName

Gets or sets the identifying name class used by scripting languages. This name is also used to construct the clipboard name.

public string EmbeddedObjectName { get; set; }
Public Property EmbeddedObjectName As String
Property Value
System.String

The identifying name class used by scripting languages. This name is also used to construct the clipboard name.

Frame

Gets the graphic frame that contains this OLE object.

public GraphicFrame Frame { get; }
Public ReadOnly Property Frame As GraphicFrame
Property Value
GraphicFrame

The GraphicFrame that contains this OLE object.

ImageHeight

Gets or sets the height of the embedded control.

public Length ImageHeight { get; set; }
Public Property ImageHeight As Length
Property Value
Length

The height of the embedded control as a Length.

ImageWidth

Gets or sets the width of the embedded control.

public Length ImageWidth { get; set; }
Public Property ImageWidth As Length
Property Value
Length

The width of the embedded control as a Length.

IsLinked

Gets or sets a value indicating whether this object or control is linked.

public bool IsLinked { get; }
Public ReadOnly Property IsLinked As Boolean
Property Value
System.Boolean

true if this object or control is linked; otherwise, false if it is embedded.

Gets the link associated with the OLE object, if it is linked.

public string Link { get; }
Public ReadOnly Property Link As String
Property Value
System.String

The link to the external object.

Path

Gets the path or link associated with the OLE object.

public string Path { get; }
Public ReadOnly Property Path As String
Property Value
System.String
Exceptions
System.InvalidOperationException

Thrown if the path cannot be determined if the object is linked with a null link.

Picture

Gets or sets the preview picture or the icon (ShowAsIcon) associated with the OLE object.

public Picture Picture { get; set; }
Public Property Picture As Picture
Property Value
Picture

The preview picture or the icon (ShowAsIcon) representing the OLE object.

ProgId

Gets or sets the program identifier (ProgId) associated with the OLE object.

public string ProgId { get; set; }
Public Property ProgId As String
Property Value
System.String

The ProgId for the OLE object.

ShowAsIcon

Gets or sets a value indicating whether the OLE object is displayed as an icon or using its native representation.

public bool ShowAsIcon { get; set; }
Public Property ShowAsIcon As Boolean
Property Value
System.Boolean

true if the OLE object is displayed as an icon; otherwise, false if it is displayed using its native representation.

UpdateMode

Gets or sets the update mode for the OLE object.

public OleUpdateMode UpdateMode { get; set; }
Public Property UpdateMode As OleUpdateMode
Property Value
OleUpdateMode

The OleUpdateMode value indicating how the OLE object is updated.

Methods

SetData(Stream, String, String)

Sets the data for the OLE object from the specified stream.

public void SetData(Stream stream, string sourcePath, string explicitContentType = null)
Public Sub SetData(stream As Stream, sourcePath As String, explicitContentType As String = Nothing)
Parameters
stream
System.IO.Stream

The stream containing the OLE object data.

sourcePath
System.String

The source path of the OLE object.

explicitContentType
System.String

The explicit content type, if any.

Exceptions
System.ArgumentNullException

Thrown if stream or sourcePath is null.

SetData(String, String)

Sets the data for the OLE object from the specified file path.

public void SetData(string path, string explicitContentType = null)
Public Sub SetData(path As String, explicitContentType As String = Nothing)
Parameters
path
System.String

The file path containing the OLE object data.

explicitContentType
System.String

The explicit content type, if any.

Exceptions
System.ArgumentNullException

Thrown if path is null.

System.IO.FileNotFoundException

Thrown if the file at path does not exist.

SetLink(String, String, String)

Sets the link for the OLE object.

public void SetLink(string link, string range = null, string explicitContentType = null)
Public Sub SetLink(link As String, range As String = Nothing, explicitContentType As String = Nothing)
Parameters
link
System.String

The link to the external object.

range
System.String

The range within the linked object, if any.

explicitContentType
System.String

The explicit content type, if any.

Exceptions
System.ArgumentNullException

Thrown if link is null.