ActiveXControlBase

ActiveXControlBase class

Represents the ActiveX control.

class ActiveXControlBase;

Properties

Property	Type	Description
workbook	Workbook	Readonly. Gets the Workbook object.
mouseIcon	Uint8Array	Gets and sets a custom icon to display as the mouse pointer for the control.
mousePointer	ControlMousePointerType	Gets and sets the type of icon displayed as the mouse pointer for the control.
linkedCell	string	Gets and sets the linked cell.
listFillRange	string	Gets and sets the list fill range.

Methods

Method	Description
getWorkbook()	@deprecated. Please use the ‘workbook’ property instead. Gets the Workbook object.
getMouseIcon()	@deprecated. Please use the ‘mouseIcon’ property instead. Gets and sets a custom icon to display as the mouse pointer for the control.
setMouseIcon(Uint8Array)	@deprecated. Please use the ‘mouseIcon’ property instead. Gets and sets a custom icon to display as the mouse pointer for the control.
getMousePointer()	@deprecated. Please use the ‘mousePointer’ property instead. Gets and sets the type of icon displayed as the mouse pointer for the control.
setMousePointer(ControlMousePointerType)	@deprecated. Please use the ‘mousePointer’ property instead. Gets and sets the type of icon displayed as the mouse pointer for the control.
getLinkedCell()	@deprecated. Please use the ’linkedCell’ property instead. Gets and sets the linked cell.
setLinkedCell(string)	@deprecated. Please use the ’linkedCell’ property instead. Gets and sets the linked cell.
getListFillRange()	@deprecated. Please use the ’listFillRange’ property instead. Gets and sets the list fill range.
setListFillRange(string)	@deprecated. Please use the ’listFillRange’ property instead. Gets and sets the list fill range.
isNull()	Checks whether the implementation object is null.
getType()	Gets the type of the ActiveX control.
getWidth()	Gets and sets the width of the control in unit of points.
setWidth(number)	Gets and sets the width of the control in unit of points.
getHeight()	Gets and sets the height of the control in unit of points.
setHeight(number)	Gets and sets the height of the control in unit of points.
getForeOleColor()	Gets and sets the ole color of the foreground.
setForeOleColor(number)	Gets and sets the ole color of the foreground.
getBackOleColor()	Gets and sets the ole color of the background.
setBackOleColor(number)	Gets and sets the ole color of the background.
isVisible()	Indicates whether this control is visible.
setIsVisible(boolean)	Indicates whether this control is visible.
getShadow()	Indicates whether to show a shadow.
setShadow(boolean)	Indicates whether to show a shadow.
getData()	Gets and sets the binary data of the control.

workbook

Readonly. Gets the Workbook object.

workbook : Workbook;

mouseIcon

Gets and sets a custom icon to display as the mouse pointer for the control.

mouseIcon : Uint8Array;

mousePointer

Gets and sets the type of icon displayed as the mouse pointer for the control.

mousePointer : ControlMousePointerType;

linkedCell

Gets and sets the linked cell.

linkedCell : string;

listFillRange

Gets and sets the list fill range.

listFillRange : string;

getWorkbook()

@deprecated. Please use the ‘workbook’ property instead. Gets the Workbook object.

getWorkbook() : Workbook;

Returns

Workbook

getMouseIcon()

@deprecated. Please use the ‘mouseIcon’ property instead. Gets and sets a custom icon to display as the mouse pointer for the control.

getMouseIcon() : Uint8Array;

setMouseIcon(Uint8Array)

@deprecated. Please use the ‘mouseIcon’ property instead. Gets and sets a custom icon to display as the mouse pointer for the control.

setMouseIcon(value: Uint8Array) : void;

Parameters:

Parameter	Type	Description
value	number[]	The value to set.

getMousePointer()

@deprecated. Please use the ‘mousePointer’ property instead. Gets and sets the type of icon displayed as the mouse pointer for the control.

getMousePointer() : ControlMousePointerType;

Returns

ControlMousePointerType

setMousePointer(ControlMousePointerType)

@deprecated. Please use the ‘mousePointer’ property instead. Gets and sets the type of icon displayed as the mouse pointer for the control.

setMousePointer(value: ControlMousePointerType) : void;

Parameters:

Parameter	Type	Description
value	ControlMousePointerType	The value to set.

getLinkedCell()

@deprecated. Please use the ’linkedCell’ property instead. Gets and sets the linked cell.

getLinkedCell() : string;

setLinkedCell(string)

@deprecated. Please use the ’linkedCell’ property instead. Gets and sets the linked cell.

setLinkedCell(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getListFillRange()

@deprecated. Please use the ’listFillRange’ property instead. Gets and sets the list fill range.

getListFillRange() : string;

setListFillRange(string)

@deprecated. Please use the ’listFillRange’ property instead. Gets and sets the list fill range.

setListFillRange(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getType()

Gets the type of the ActiveX control.

getType() : ControlType;

Returns

ControlType

getWidth()

Gets and sets the width of the control in unit of points.

getWidth() : number;

setWidth(number)

Gets and sets the width of the control in unit of points.

setWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHeight()

Gets and sets the height of the control in unit of points.

getHeight() : number;

setHeight(number)

Gets and sets the height of the control in unit of points.

setHeight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getForeOleColor()

Gets and sets the ole color of the foreground.

getForeOleColor() : number;

Remarks

Not applies to Image control.

setForeOleColor(number)

Gets and sets the ole color of the foreground.

setForeOleColor(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

Not applies to Image control.

getBackOleColor()

Gets and sets the ole color of the background.

getBackOleColor() : number;

setBackOleColor(number)

Gets and sets the ole color of the background.

setBackOleColor(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isVisible()

Indicates whether this control is visible.

isVisible() : boolean;

setIsVisible(boolean)

Indicates whether this control is visible.

setIsVisible(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShadow()

Indicates whether to show a shadow.

getShadow() : boolean;

setShadow(boolean)

Indicates whether to show a shadow.

setShadow(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getData()

Gets and sets the binary data of the control.

getData() : Uint8Array;