OleObjectCollection

OleObjectCollection class

Represents embedded OLE objects.

class OleObjectCollection;

Method	Description
get(number)	Gets the OleObject element at the specified index.
add(number, number, number, number, Uint8Array)	Adds an OleObject to the collection.
add(number, number, number, number, Uint8Array, string)	Adds a linked OleObject to the collection.
clear()	Remove all embedded OLE objects.
removeAt(number)	Removes the element at the specified index.
getCount()	@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.
isNull()	Checks whether the implementation object is null.

Gets the OleObject element at the specified index.

get(index: number) : OleObject;

Parameters:

Parameter	Type	Description
index	number	The zero based index of the element.

Returns

The element at the specified index.

Adds an OleObject to the collection.

add(upperLeftRow: number, upperLeftColumn: number, height: number, width: number, imageData: Uint8Array) : number;

Parameters:

Parameter	Type	Description
upperLeftRow	number	Upper left row index.
upperLeftColumn	number	Upper left column index.
height	number	Height of oleObject, in unit of pixel.
width	number	Width of oleObject, in unit of pixel.
imageData	number[]	Image of ole object as byte array.

Returns

OleObject object index.

Adds a linked OleObject to the collection.

add(upperLeftRow: number, upperLeftColumn: number, height: number, width: number, imageData: Uint8Array, linkedFile: string) : number;

Parameters:

Parameter	Type	Description
upperLeftRow	number	Upper left row index.
upperLeftColumn	number	Upper left column index.
height	number	Height of oleObject, in unit of pixel.
width	number	Width of oleObject, in unit of pixel.
imageData	number[]	Image of ole object as byte array.
linkedFile	string

Returns

OleObject object index.

Remove all embedded OLE objects.

clear() : void;

Removes the element at the specified index.

removeAt(index: number) : void;

Parameters:

Parameter	Type	Description
index	number	The specified index.

@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.

getCount() : number;

Checks whether the implementation object is null.

isNull() : boolean;