CheckBoxActiveXControl

CheckBoxActiveXControl class

Represents a CheckBox ActiveX control.

class CheckBoxActiveXControl extends ActiveXControl;

Constructors

Constructor	Description
constructor(ActiveXControl)	Constructs from a parent object convertible to this.

Properties

Property	Type	Description
groupName	string	Gets and sets the group’s name.
alignment	ControlCaptionAlignmentType	Gets and set the position of the Caption relative to the control.
isWordWrapped	boolean	Indicates whether the contents of the control automatically wrap at the end of a line.
caption	string	Gets and set the descriptive text that appears on a control.
picturePosition	ControlPicturePositionType	Gets and set the location of the control’s picture relative to its caption.
specialEffect	ControlSpecialEffectType	Gets and sets the special effect of the control.
picture	Uint8Array	Gets and sets the data of the picture.
accelerator	string	Gets and sets the accelerator key for the control.
value	CheckValueType	Indicates if the control is checked or not.
isTripleState	boolean	Indicates how the specified control will display Null values.
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.
isEnabled	boolean	Indicates whether the control can receive the focus and respond to user-generated events.
isLocked	boolean	Indicates whether data in the control is locked for editing.
isTransparent	boolean	Indicates whether the control is transparent.
iMEMode	InputMethodEditorMode	Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
font	Font	Readonly. Represents the font of the control.
textAlign	TextAlignmentType	Represents how to align the text used by the control.

Methods

Method	Description
getGroupName()	@deprecated. Please use the ‘groupName’ property instead. Gets and sets the group’s name.
setGroupName(string)	@deprecated. Please use the ‘groupName’ property instead. Gets and sets the group’s name.
getAlignment()	@deprecated. Please use the ‘alignment’ property instead. Gets and set the position of the Caption relative to the control.
setAlignment(ControlCaptionAlignmentType)	@deprecated. Please use the ‘alignment’ property instead. Gets and set the position of the Caption relative to the control.
isWordWrapped()	@deprecated. Please use the ‘isWordWrapped’ property instead. Indicates whether the contents of the control automatically wrap at the end of a line.
setIsWordWrapped(boolean)	@deprecated. Please use the ‘isWordWrapped’ property instead. Indicates whether the contents of the control automatically wrap at the end of a line.
getCaption()	@deprecated. Please use the ‘caption’ property instead. Gets and set the descriptive text that appears on a control.
setCaption(string)	@deprecated. Please use the ‘caption’ property instead. Gets and set the descriptive text that appears on a control.
getPicturePosition()	@deprecated. Please use the ‘picturePosition’ property instead. Gets and set the location of the control’s picture relative to its caption.
setPicturePosition(ControlPicturePositionType)	@deprecated. Please use the ‘picturePosition’ property instead. Gets and set the location of the control’s picture relative to its caption.
getSpecialEffect()	@deprecated. Please use the ‘specialEffect’ property instead. Gets and sets the special effect of the control.
setSpecialEffect(ControlSpecialEffectType)	@deprecated. Please use the ‘specialEffect’ property instead. Gets and sets the special effect of the control.
getPicture()	@deprecated. Please use the ‘picture’ property instead. Gets and sets the data of the picture.
setPicture(Uint8Array)	@deprecated. Please use the ‘picture’ property instead. Gets and sets the data of the picture.
getAccelerator()	@deprecated. Please use the ‘accelerator’ property instead. Gets and sets the accelerator key for the control.
setAccelerator(string)	@deprecated. Please use the ‘accelerator’ property instead. Gets and sets the accelerator key for the control.
getValue()	@deprecated. Please use the ‘value’ property instead. Indicates if the control is checked or not.
setValue(CheckValueType)	@deprecated. Please use the ‘value’ property instead. Indicates if the control is checked or not.
isTripleState()	@deprecated. Please use the ‘isTripleState’ property instead. Indicates how the specified control will display Null values.
setIsTripleState(boolean)	@deprecated. Please use the ‘isTripleState’ property instead. Indicates how the specified control will display Null values.
isNull()	Checks whether the implementation object is null.
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.
isEnabled()	@deprecated. Please use the ‘isEnabled’ property instead. Indicates whether the control can receive the focus and respond to user-generated events.
setIsEnabled(boolean)	@deprecated. Please use the ‘isEnabled’ property instead. Indicates whether the control can receive the focus and respond to user-generated events.
isLocked()	@deprecated. Please use the ‘isLocked’ property instead. Indicates whether data in the control is locked for editing.
setIsLocked(boolean)	@deprecated. Please use the ‘isLocked’ property instead. Indicates whether data in the control is locked for editing.
isTransparent()	@deprecated. Please use the ‘isTransparent’ property instead. Indicates whether the control is transparent.
setIsTransparent(boolean)	@deprecated. Please use the ‘isTransparent’ property instead. Indicates whether the control is transparent.
getIMEMode()	@deprecated. Please use the ‘iMEMode’ property instead. Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
setIMEMode(InputMethodEditorMode)	@deprecated. Please use the ‘iMEMode’ property instead. Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
getFont()	@deprecated. Please use the ‘font’ property instead. Represents the font of the control.
getTextAlign()	@deprecated. Please use the ’textAlign’ property instead. Represents how to align the text used by the control.
setTextAlign(TextAlignmentType)	@deprecated. Please use the ’textAlign’ property instead. Represents how to align the text used by the control.
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.
isAutoSize()	Indicates whether the control will automatically resize to display its entire contents.
setIsAutoSize(boolean)	Indicates whether the control will automatically resize to display its entire contents.
getData()	Gets and sets the binary data of the control.

constructor(ActiveXControl)

Constructs from a parent object convertible to this.

constructor(obj: ActiveXControl);

Parameters:

Parameter	Type	Description
obj	ActiveXControl	The parent object.

groupName

Gets and sets the group’s name.

groupName : string;

alignment

Gets and set the position of the Caption relative to the control.

alignment : ControlCaptionAlignmentType;

isWordWrapped

Indicates whether the contents of the control automatically wrap at the end of a line.

isWordWrapped : boolean;

caption

Gets and set the descriptive text that appears on a control.

caption : string;

picturePosition

Gets and set the location of the control’s picture relative to its caption.

picturePosition : ControlPicturePositionType;

specialEffect

Gets and sets the special effect of the control.

specialEffect : ControlSpecialEffectType;

picture

Gets and sets the data of the picture.

picture : Uint8Array;

accelerator

Gets and sets the accelerator key for the control.

accelerator : string;

value

Indicates if the control is checked or not.

value : CheckValueType;

isTripleState

Indicates how the specified control will display Null values.

isTripleState : boolean;

Remarks

list type=“table”> Setting Description True The control will cycle through states for Yes, No, and Null values. The control appears dimmed (grayed) when its Value property is set to Null. False (Default) The control will cycle through states for Yes and No values. Null values display as if they were No values. </list

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;

isEnabled

Indicates whether the control can receive the focus and respond to user-generated events.

isEnabled : boolean;

isLocked

Indicates whether data in the control is locked for editing.

isLocked : boolean;

isTransparent

Indicates whether the control is transparent.

isTransparent : boolean;

iMEMode

Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.

iMEMode : InputMethodEditorMode;

font

Readonly. Represents the font of the control.

font : Font;

textAlign

Represents how to align the text used by the control.

textAlign : TextAlignmentType;

getGroupName()

@deprecated. Please use the ‘groupName’ property instead. Gets and sets the group’s name.

getGroupName() : string;

setGroupName(string)

@deprecated. Please use the ‘groupName’ property instead. Gets and sets the group’s name.

setGroupName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getAlignment()

@deprecated. Please use the ‘alignment’ property instead. Gets and set the position of the Caption relative to the control.

getAlignment() : ControlCaptionAlignmentType;

Returns

ControlCaptionAlignmentType

setAlignment(ControlCaptionAlignmentType)

@deprecated. Please use the ‘alignment’ property instead. Gets and set the position of the Caption relative to the control.

setAlignment(value: ControlCaptionAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	ControlCaptionAlignmentType	The value to set.

isWordWrapped()

@deprecated. Please use the ‘isWordWrapped’ property instead. Indicates whether the contents of the control automatically wrap at the end of a line.

isWordWrapped() : boolean;

setIsWordWrapped(boolean)

@deprecated. Please use the ‘isWordWrapped’ property instead. Indicates whether the contents of the control automatically wrap at the end of a line.

setIsWordWrapped(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCaption()

@deprecated. Please use the ‘caption’ property instead. Gets and set the descriptive text that appears on a control.

getCaption() : string;

setCaption(string)

@deprecated. Please use the ‘caption’ property instead. Gets and set the descriptive text that appears on a control.

setCaption(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getPicturePosition()

@deprecated. Please use the ‘picturePosition’ property instead. Gets and set the location of the control’s picture relative to its caption.

getPicturePosition() : ControlPicturePositionType;

Returns

ControlPicturePositionType

setPicturePosition(ControlPicturePositionType)

@deprecated. Please use the ‘picturePosition’ property instead. Gets and set the location of the control’s picture relative to its caption.

setPicturePosition(value: ControlPicturePositionType) : void;

Parameters:

Parameter	Type	Description
value	ControlPicturePositionType	The value to set.

getSpecialEffect()

@deprecated. Please use the ‘specialEffect’ property instead. Gets and sets the special effect of the control.

getSpecialEffect() : ControlSpecialEffectType;

Returns

ControlSpecialEffectType

setSpecialEffect(ControlSpecialEffectType)

@deprecated. Please use the ‘specialEffect’ property instead. Gets and sets the special effect of the control.

setSpecialEffect(value: ControlSpecialEffectType) : void;

Parameters:

Parameter	Type	Description
value	ControlSpecialEffectType	The value to set.

getPicture()

@deprecated. Please use the ‘picture’ property instead. Gets and sets the data of the picture.

getPicture() : Uint8Array;

setPicture(Uint8Array)

@deprecated. Please use the ‘picture’ property instead. Gets and sets the data of the picture.

setPicture(value: Uint8Array) : void;

Parameters:

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

getAccelerator()

@deprecated. Please use the ‘accelerator’ property instead. Gets and sets the accelerator key for the control.

getAccelerator() : string;

setAccelerator(string)

@deprecated. Please use the ‘accelerator’ property instead. Gets and sets the accelerator key for the control.

setAccelerator(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getValue()

@deprecated. Please use the ‘value’ property instead. Indicates if the control is checked or not.

getValue() : CheckValueType;

Returns

CheckValueType

setValue(CheckValueType)

@deprecated. Please use the ‘value’ property instead. Indicates if the control is checked or not.

setValue(value: CheckValueType) : void;

Parameters:

Parameter	Type	Description
value	CheckValueType	The value to set.

isTripleState()

@deprecated. Please use the ‘isTripleState’ property instead. Indicates how the specified control will display Null values.

isTripleState() : boolean;

Remarks

setIsTripleState(boolean)

@deprecated. Please use the ‘isTripleState’ property instead. Indicates how the specified control will display Null values.

setIsTripleState(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

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.

isEnabled()

@deprecated. Please use the ‘isEnabled’ property instead. Indicates whether the control can receive the focus and respond to user-generated events.

isEnabled() : boolean;

setIsEnabled(boolean)

@deprecated. Please use the ‘isEnabled’ property instead. Indicates whether the control can receive the focus and respond to user-generated events.

setIsEnabled(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isLocked()

@deprecated. Please use the ‘isLocked’ property instead. Indicates whether data in the control is locked for editing.

isLocked() : boolean;

setIsLocked(boolean)

@deprecated. Please use the ‘isLocked’ property instead. Indicates whether data in the control is locked for editing.

setIsLocked(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isTransparent()

@deprecated. Please use the ‘isTransparent’ property instead. Indicates whether the control is transparent.

isTransparent() : boolean;

setIsTransparent(boolean)

@deprecated. Please use the ‘isTransparent’ property instead. Indicates whether the control is transparent.

setIsTransparent(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getIMEMode()

@deprecated. Please use the ‘iMEMode’ property instead. Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.

getIMEMode() : InputMethodEditorMode;

Returns

InputMethodEditorMode

setIMEMode(InputMethodEditorMode)

@deprecated. Please use the ‘iMEMode’ property instead. Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.

setIMEMode(value: InputMethodEditorMode) : void;

Parameters:

Parameter	Type	Description
value	InputMethodEditorMode	The value to set.

getFont()

@deprecated. Please use the ‘font’ property instead. Represents the font of the control.

getFont() : Font;

Returns

Font

getTextAlign()

@deprecated. Please use the ’textAlign’ property instead. Represents how to align the text used by the control.

getTextAlign() : TextAlignmentType;

Returns

TextAlignmentType

setTextAlign(TextAlignmentType)

@deprecated. Please use the ’textAlign’ property instead. Represents how to align the text used by the control.

setTextAlign(value: TextAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	TextAlignmentType	The value to set.

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.

isAutoSize()

Indicates whether the control will automatically resize to display its entire contents.

isAutoSize() : boolean;

setIsAutoSize(boolean)

Indicates whether the control will automatically resize to display its entire contents.

setIsAutoSize(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;