OleObject Class

Represents the Ole Object implementation

Inheritance

System.Object

OleObject

Implements

IOleObject

Namespace: Syncfusion.XlsIO.Implementation

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

public class OleObject : Object, IOleObject

Constructors

OleObject(WorksheetImpl)

Initializes a new instance of the OleObject class.

Declaration

public OleObject(WorksheetImpl sheet)

Parameters

Type	Name	Description
WorksheetImpl	sheet

OleObject(Stream, Image, String)

Initializes a new instance of the OleObject class.

Declaration

public OleObject(Stream stream, Image image, string extension)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream.
System.Drawing.Image	image	The image.
System.String	extension	The extension.

OleObject(String, IPictureShape, OleLinkType)

Creates the Ole object

Declaration

public OleObject(string fileName, IPictureShape shape, OleLinkType linkType)

Parameters

Type	Name	Description
System.String	fileName
IPictureShape	shape
OleLinkType	linkType

OleObject(String, Image)

Initializes a new instance of the OleObject class.

Declaration

public OleObject(string fileName, Image image)

Parameters

Type	Name	Description
System.String	fileName	Name of the file.
System.Drawing.Image	image	The image.

OleObject(String, Image, OleLinkType)

Initializes a new instance of the OleObject class.

Declaration

public OleObject(string fileName, Image image, OleLinkType oleLinkType)

Parameters

Type	Name	Description
System.String	fileName	Name of the file.
System.Drawing.Image	image	The image.
OleLinkType	oleLinkType	Type of the OLE link.

Properties

Container

Gets or sets the container.

Declaration

public Stream Container { get; set; }

Property Value

Type	Description
System.IO.Stream	The container.

ContentType

Gets or sets xlsx content type.

Declaration

public string ContentType { get; set; }

Property Value

Type
System.String

DisplayAsIcon

Gets or sets a value indicating whether [display as icon].

Declaration

public bool DisplayAsIcon { get; set; }

Property Value

Type	Description
System.Boolean	true if [display as icon]; otherwise, false.

DvAspect

Gets or sets the dv aspect.

Declaration

public DVAspect DvAspect { get; set; }

Property Value

Type	Description
DVAspect	The dv aspect.

FileName

Gets or sets the name of the file.

Declaration

public string FileName { get; set; }

Property Value

Type	Description
System.String	The name of the file.

FileNativeData

Gets or sets the file native data.

Declaration

public byte[] FileNativeData { get; set; }

Property Value

Type	Description
System.Byte[]	The file native data.

IsContainer

Gets or sets a value indicating whether this instance is container.

Declaration

public bool IsContainer { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is container; otherwise, false.

IsStream

Gets or sets a value indicating whether this instance is stream.

Declaration

public bool IsStream { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is stream; otherwise, false.

Locate

Gets the locate.

Declaration

public Dictionary<string, int> Locate { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Int32>	The locate.

Location

Gets or sets the location.

Declaration

public IRange Location { get; set; }

Property Value

Type	Description
IRange	The location.

Name

Gets the name of an OLE object.

Declaration

public string Name { get; }

Property Value

Type
System.String

ObjectType

Gets or sets the type of the object.

Declaration

public string ObjectType { get; set; }

Property Value

Type	Description
System.String	The type of the object.

OleObjectType

Gets or sets the type of the OLE object.

Declaration

public OleObjectType OleObjectType { get; set; }

Property Value

Type	Description
OleObjectType	The type of the OLE object.

OleSheet

Gets or sets the index of the OLE sheet.

Declaration

public WorksheetImpl OleSheet { get; }

Property Value

Type	Description
WorksheetImpl	The index of the OLE sheet.

OleType

Gets or sets the type of the OLE.

Declaration

public OleLinkType OleType { get; set; }

Property Value

Type	Description
OleLinkType	The type of the OLE.

Picture

Gets or sets the picture.

Declaration

public Image Picture { get; set; }

Property Value

Type	Description
System.Drawing.Image	The picture.

RelationType

Gets or sets xlsx relation type.

Declaration

public string RelationType { get; set; }

Property Value

Type
System.String

Shape

Gets shape associated with this ole object.

Declaration

public IPictureShape Shape { get; set; }

Property Value

Type
IPictureShape

ShapeID

Gets or sets the shape ID.

Declaration

public int ShapeID { get; set; }

Property Value

Type	Description
System.Int32	The shape ID.

ShapeRId

Gets or sets the shape R id.

Declaration

public string ShapeRId { get; set; }

Property Value

Type	Description
System.String	The shape R id.

Size

Gets or sets the size.

Declaration

public Size Size { get; set; }

Property Value

Type	Description
System.Drawing.Size	The size.

StorageName

Gets or sets the name of the storage.

Declaration

public string StorageName { get; set; }

Property Value

Type	Description
System.String	The name of the storage.

Methods

ExtractOleData(String)

Extracts the OLE data.

Declaration

public void ExtractOleData(string fileName)

Parameters

Type	Name	Description
System.String	fileName	Name of the file.

GetWorkbookIndex()

Gets index of external workbook referenced by this ole object.

Declaration

public int GetWorkbookIndex()

Returns

Type
System.Int32

OleFromFile(String, Image)

OLEs from file.

Declaration

public static OleObject OleFromFile(string fileName, Image image)

Parameters

Type	Name	Description
System.String	fileName	Name of the file.
System.Drawing.Image	image	The image.

Returns

Type
OleObject

OleFromStream(Stream, Image, String)

OLEs from stream.

Declaration

public static OleObject OleFromStream(Stream stream, Image image, string extension)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream.
System.Drawing.Image	image	The image.
System.String	extension	The extension.

Returns

Type
OleObject

Implements

IOleObject