OleObjectCollection

OleObjectCollection class

Represents embedded OLE objects.

class OleObjectCollection;

Methods

MethodDescription
get(number)Gets the OleObject element at the specified index.
add(number, number, number, number, number[])Adds an OleObject to the collection.
add(number, number, number, number, number[], string)Adds a linked OleObject to the collection.
clear()Remove all embedded OLE objects.
removeAt(number)Removes the element at the specified index.
getCount()Gets the number of elements contained in.
isNull()Checks whether the implementation object is null.

get(number)

Gets the OleObject element at the specified index.

get(index: number) : OleObject;

Parameters:

ParameterTypeDescription
indexnumberThe zero based index of the element.

Returns

The element at the specified index.

add(number, number, number, number, number[])

Adds an OleObject to the collection.

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

Parameters:

ParameterTypeDescription
upperLeftRownumberUpper left row index.
upperLeftColumnnumberUpper left column index.
heightnumberHeight of oleObject, in unit of pixel.
widthnumberWidth of oleObject, in unit of pixel.
imageDatanumber[]Image of ole object as byte array.

Returns

OleObject object index.

add(number, number, number, number, number[], string)

Adds a linked OleObject to the collection.

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

Parameters:

ParameterTypeDescription
upperLeftRownumberUpper left row index.
upperLeftColumnnumberUpper left column index.
heightnumberHeight of oleObject, in unit of pixel.
widthnumberWidth of oleObject, in unit of pixel.
imageDatanumber[]Image of ole object as byte array.
linkedFilestring

Returns

OleObject object index.

clear()

Remove all embedded OLE objects.

clear() : void;

removeAt(number)

Removes the element at the specified index.

removeAt(index: number) : void;

Parameters:

ParameterTypeDescription
indexnumberThe specified index.

getCount()

Gets the number of elements contained in.

getCount() : number;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;