CheckBoxActiveXControl

CheckBoxActiveXControl class

Represents a CheckBox ActiveX control.

class CheckBoxActiveXControl extends ActiveXControl;

Constructors

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

Methods

Method	Description
getType()	Gets the type of the ActiveX control.
getGroupName()	Gets and sets the group’s name.
setGroupName(string)	Gets and sets the group’s name.
getAlignment()	Gets and set the position of the Caption relative to the control.
setAlignment(ControlCaptionAlignmentType)	Gets and set the position of the Caption relative to the control.
isWordWrapped()	Indicates whether the contents of the control automatically wrap at the end of a line.
setIsWordWrapped(boolean)	Indicates whether the contents of the control automatically wrap at the end of a line.
getCaption()	Gets and set the descriptive text that appears on a control.
setCaption(string)	Gets and set the descriptive text that appears on a control.
getPicturePosition()	Gets and set the location of the control’s picture relative to its caption.
setPicturePosition(ControlPicturePositionType)	Gets and set the location of the control’s picture relative to its caption.
getSpecialEffect()	Gets and sets the special effect of the control.
setSpecialEffect(ControlSpecialEffectType)	Gets and sets the special effect of the control.
getPicture()	Gets and sets the data of the picture.
setPicture(number[])	Gets and sets the data of the picture.
getAccelerator()	Gets and sets the accelerator key for the control.
setAccelerator(string)	Gets and sets the accelerator key for the control.
getValue()	Indicates if the control is checked or not.
setValue(CheckValueType)	Indicates if the control is checked or not.
isTripleState()	Indicates how the specified control will display Null values.
setIsTripleState(boolean)	Indicates how the specified control will display Null values.
isNull()	Checks whether the implementation object is null.
getWorkbook()	Gets the Workbook object.
getMouseIcon()	Gets and sets a custom icon to display as the mouse pointer for the control.
setMouseIcon(number[])	Gets and sets a custom icon to display as the mouse pointer for the control.
getMousePointer()	Gets and sets the type of icon displayed as the mouse pointer for the control.
setMousePointer(ControlMousePointerType)	Gets and sets the type of icon displayed as the mouse pointer for the control.
getLinkedCell()	Gets and sets the linked cell.
setLinkedCell(string)	Gets and sets the linked cell.
getListFillRange()	Gets and sets the list fill range.
setListFillRange(string)	Gets and sets the list fill range.
isEnabled()	Indicates whether the control can receive the focus and respond to user-generated events.
setIsEnabled(boolean)	Indicates whether the control can receive the focus and respond to user-generated events.
isLocked()	Indicates whether data in the control is locked for editing.
setIsLocked(boolean)	Indicates whether data in the control is locked for editing.
isTransparent()	Indicates whether the control is transparent.
setIsTransparent(boolean)	Indicates whether the control is transparent.
getIMEMode()	Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
setIMEMode(InputMethodEditorMode)	Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
getFont()	Represents the font of the control.
getTextAlign()	Represents how to align the text used by the control.
setTextAlign(TextAlignmentType)	Represents how to align the text used by the control.
getData()	Gets and sets the binary data of the 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.

constructor(ActiveXControl)

Constructs from a parent object convertible to this.

constructor(obj: ActiveXControl);

Parameters:

Parameter	Type	Description
obj	ActiveXControl	The parent object.

getType()

Gets the type of the ActiveX control.

getType() : ControlType;

Returns

ControlType

getGroupName()

Gets and sets the group’s name.

getGroupName() : string;

setGroupName(string)

Gets and sets the group’s name.

setGroupName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getAlignment()

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

getAlignment() : ControlCaptionAlignmentType;

Returns

ControlCaptionAlignmentType

setAlignment(ControlCaptionAlignmentType)

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()

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

isWordWrapped() : boolean;

setIsWordWrapped(boolean)

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()

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

getCaption() : string;

setCaption(string)

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()

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

getPicturePosition() : ControlPicturePositionType;

Returns

ControlPicturePositionType

setPicturePosition(ControlPicturePositionType)

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()

Gets and sets the special effect of the control.

getSpecialEffect() : ControlSpecialEffectType;

Returns

ControlSpecialEffectType

setSpecialEffect(ControlSpecialEffectType)

Gets and sets the special effect of the control.

setSpecialEffect(value: ControlSpecialEffectType) : void;

Parameters:

Parameter	Type	Description
value	ControlSpecialEffectType	The value to set.

getPicture()

Gets and sets the data of the picture.

getPicture() : number[];

Returns

number[]

setPicture(number[])

Gets and sets the data of the picture.

setPicture(value: number[]) : void;

Parameters:

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

getAccelerator()

Gets and sets the accelerator key for the control.

getAccelerator() : string;

setAccelerator(string)

Gets and sets the accelerator key for the control.

setAccelerator(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getValue()

Indicates if the control is checked or not.

getValue() : CheckValueType;

Returns

CheckValueType

setValue(CheckValueType)

Indicates if the control is checked or not.

setValue(value: CheckValueType) : void;

Parameters:

Parameter	Type	Description
value	CheckValueType	The value to set.

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

setIsTripleState(boolean)

Indicates how the specified control will display Null values.

setIsTripleState(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getWorkbook()

Gets the Workbook object.

getWorkbook() : Workbook;

Returns

Workbook

getMouseIcon()

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

getMouseIcon() : number[];

Returns

number[]

setMouseIcon(number[])

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

setMouseIcon(value: number[]) : void;

Parameters:

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

getMousePointer()

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

getMousePointer() : ControlMousePointerType;

Returns

ControlMousePointerType

setMousePointer(ControlMousePointerType)

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()

Gets and sets the linked cell.

getLinkedCell() : string;

setLinkedCell(string)

Gets and sets the linked cell.

setLinkedCell(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getListFillRange()

Gets and sets the list fill range.

getListFillRange() : string;

setListFillRange(string)

Gets and sets the list fill range.

setListFillRange(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

isEnabled()

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

isEnabled() : boolean;

setIsEnabled(boolean)

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()

Indicates whether data in the control is locked for editing.

isLocked() : boolean;

setIsLocked(boolean)

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()

Indicates whether the control is transparent.

isTransparent() : boolean;

setIsTransparent(boolean)

Indicates whether the control is transparent.

setIsTransparent(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getIMEMode()

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)

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()

Represents the font of the control.

getFont() : Font;

Returns

Font

getTextAlign()

Represents how to align the text used by the control.

getTextAlign() : TextAlignmentType;

Returns

TextAlignmentType

setTextAlign(TextAlignmentType)

Represents how to align the text used by the control.

setTextAlign(value: TextAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	TextAlignmentType	The value to set.

getData()

Gets and sets the binary data of the control.

getData() : number[];

Returns

number[]

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.