ComboBoxActiveXControl

ComboBoxActiveXControl class

Represents a ComboBox ActiveX control.

class ComboBoxActiveXControl 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.
getMaxLength()	Gets and sets the maximum number of characters
setMaxLength(number)	Gets and sets the maximum number of characters
getListWidth()	Gets and set the width in unit of points.
setListWidth(number)	Gets and set the width in unit of points.
getBoundColumn()	Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle).
setBoundColumn(number)	Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle).
getTextColumn()	Represents the column in a ComboBox or ListBox to display to the user.
setTextColumn(number)	Represents the column in a ComboBox or ListBox to display to the user.
getColumnCount()	Represents the number of columns to display in a ComboBox or ListBox.
setColumnCount(number)	Represents the number of columns to display in a ComboBox or ListBox.
getListRows()	Represents the maximum number of rows to display in the list.
setListRows(number)	Represents the maximum number of rows to display in the list.
getMatchEntry()	Indicates how a ListBox or ComboBox searches its list as the user types.
setMatchEntry(ControlMatchEntryType)	Indicates how a ListBox or ComboBox searches its list as the user types.
getDropButtonStyle()	Specifies the symbol displayed on the drop button
setDropButtonStyle(DropButtonStyle)	Specifies the symbol displayed on the drop button
getShowDropButtonTypeWhen()	Specifies the symbol displayed on the drop button
setShowDropButtonTypeWhen(ShowDropButtonType)	Specifies the symbol displayed on the drop button
getListStyle()	Gets and sets the visual appearance.
setListStyle(ControlListStyle)	Gets and sets the visual appearance.
getBorderStyle()	Gets and set the type of border used by the control.
setBorderStyle(ControlBorderType)	Gets and set the type of border used by the control.
getBorderOleColor()	Gets and sets the ole color of the background.
setBorderOleColor(number)	Gets and sets the ole color of the background.
getSpecialEffect()	Gets and sets the special effect of the control.
setSpecialEffect(ControlSpecialEffectType)	Gets and sets the special effect of the control.
isEditable()	Indicates whether the user can type into the control.
setIsEditable(boolean)	Indicates whether the user can type into the control.
getShowColumnHeads()	Indicates whether column headings are displayed.
setShowColumnHeads(boolean)	Indicates whether column headings are displayed.
isDragBehaviorEnabled()	Indicates whether dragging and dropping is enabled for the control.
setIsDragBehaviorEnabled(boolean)	Indicates whether dragging and dropping is enabled for the control.
getEnterFieldBehavior()	Specifies selection behavior when entering the control. True specifies that the selection remains unchanged from last time the control was active. False specifies that all the text in the control will be selected when entering the control.
setEnterFieldBehavior(boolean)	Specifies selection behavior when entering the control. True specifies that the selection remains unchanged from last time the control was active. False specifies that all the text in the control will be selected when entering the control.
getSelectionMargin()	Indicates whether the user can select a line of text by clicking in the region to the left of the text.
setSelectionMargin(boolean)	Indicates whether the user can select a line of text by clicking in the region to the left of the text.
getValue()	Gets and sets the value of the control.
setValue(string)	Gets and sets the value of the control.
getHideSelection()	Indicates whether selected text in the control appears highlighted when the control does not have focus.
setHideSelection(boolean)	Indicates whether selected text in the control appears highlighted when the control does not have focus.
getColumnWidths()	Gets and sets the width of the column.
setColumnWidths(number)	Gets and sets the width of the column.
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.
isAutoWordSelected()	Specifies the basic unit used to extend a selection. True specifies that the basic unit is a single character. false specifies that the basic unit is a whole word.
setIsAutoWordSelected(boolean)	Specifies the basic unit used to extend a selection. True specifies that the basic unit is a single character. false specifies that the basic unit is a whole word.
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

getMaxLength()

Gets and sets the maximum number of characters

getMaxLength() : number;

setMaxLength(number)

Gets and sets the maximum number of characters

setMaxLength(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getListWidth()

Gets and set the width in unit of points.

getListWidth() : number;

setListWidth(number)

Gets and set the width in unit of points.

setListWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getBoundColumn()

Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle).

getBoundColumn() : number;

setBoundColumn(number)

Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle).

setBoundColumn(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTextColumn()

Represents the column in a ComboBox or ListBox to display to the user.

getTextColumn() : number;

setTextColumn(number)

Represents the column in a ComboBox or ListBox to display to the user.

setTextColumn(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getColumnCount()

Represents the number of columns to display in a ComboBox or ListBox.

getColumnCount() : number;

setColumnCount(number)

Represents the number of columns to display in a ComboBox or ListBox.

setColumnCount(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getListRows()

Represents the maximum number of rows to display in the list.

getListRows() : number;

setListRows(number)

Represents the maximum number of rows to display in the list.

setListRows(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getMatchEntry()

Indicates how a ListBox or ComboBox searches its list as the user types.

getMatchEntry() : ControlMatchEntryType;

Returns

ControlMatchEntryType

setMatchEntry(ControlMatchEntryType)

Indicates how a ListBox or ComboBox searches its list as the user types.

setMatchEntry(value: ControlMatchEntryType) : void;

Parameters:

Parameter	Type	Description
value	ControlMatchEntryType	The value to set.

getDropButtonStyle()

Specifies the symbol displayed on the drop button

getDropButtonStyle() : DropButtonStyle;

Returns

DropButtonStyle

setDropButtonStyle(DropButtonStyle)

Specifies the symbol displayed on the drop button

setDropButtonStyle(value: DropButtonStyle) : void;

Parameters:

Parameter	Type	Description
value	DropButtonStyle	The value to set.

getShowDropButtonTypeWhen()

Specifies the symbol displayed on the drop button

getShowDropButtonTypeWhen() : ShowDropButtonType;

Returns

ShowDropButtonType

setShowDropButtonTypeWhen(ShowDropButtonType)

Specifies the symbol displayed on the drop button

setShowDropButtonTypeWhen(value: ShowDropButtonType) : void;

Parameters:

Parameter	Type	Description
value	ShowDropButtonType	The value to set.

getListStyle()

Gets and sets the visual appearance.

getListStyle() : ControlListStyle;

Returns

ControlListStyle

setListStyle(ControlListStyle)

Gets and sets the visual appearance.

setListStyle(value: ControlListStyle) : void;

Parameters:

Parameter	Type	Description
value	ControlListStyle	The value to set.

getBorderStyle()

Gets and set the type of border used by the control.

getBorderStyle() : ControlBorderType;

Returns

ControlBorderType

setBorderStyle(ControlBorderType)

Gets and set the type of border used by the control.

setBorderStyle(value: ControlBorderType) : void;

Parameters:

Parameter	Type	Description
value	ControlBorderType	The value to set.

getBorderOleColor()

Gets and sets the ole color of the background.

getBorderOleColor() : number;

setBorderOleColor(number)

Gets and sets the ole color of the background.

setBorderOleColor(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	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.

isEditable()

Indicates whether the user can type into the control.

isEditable() : boolean;

setIsEditable(boolean)

Indicates whether the user can type into the control.

setIsEditable(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowColumnHeads()

Indicates whether column headings are displayed.

getShowColumnHeads() : boolean;

setShowColumnHeads(boolean)

Indicates whether column headings are displayed.

setShowColumnHeads(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isDragBehaviorEnabled()

Indicates whether dragging and dropping is enabled for the control.

isDragBehaviorEnabled() : boolean;

setIsDragBehaviorEnabled(boolean)

Indicates whether dragging and dropping is enabled for the control.

setIsDragBehaviorEnabled(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getEnterFieldBehavior()

Specifies selection behavior when entering the control. True specifies that the selection remains unchanged from last time the control was active. False specifies that all the text in the control will be selected when entering the control.

getEnterFieldBehavior() : boolean;

setEnterFieldBehavior(boolean)

Specifies selection behavior when entering the control. True specifies that the selection remains unchanged from last time the control was active. False specifies that all the text in the control will be selected when entering the control.

setEnterFieldBehavior(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSelectionMargin()

Indicates whether the user can select a line of text by clicking in the region to the left of the text.

getSelectionMargin() : boolean;

setSelectionMargin(boolean)

Indicates whether the user can select a line of text by clicking in the region to the left of the text.

setSelectionMargin(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getValue()

Gets and sets the value of the control.

getValue() : string;

setValue(string)

Gets and sets the value of the control.

setValue(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getHideSelection()

Indicates whether selected text in the control appears highlighted when the control does not have focus.

getHideSelection() : boolean;

setHideSelection(boolean)

Indicates whether selected text in the control appears highlighted when the control does not have focus.

setHideSelection(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getColumnWidths()

Gets and sets the width of the column.

getColumnWidths() : number;

setColumnWidths(number)

Gets and sets the width of the column.

setColumnWidths(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

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[]

isAutoWordSelected()

Specifies the basic unit used to extend a selection. True specifies that the basic unit is a single character. false specifies that the basic unit is a whole word.

isAutoWordSelected() : boolean;

setIsAutoWordSelected(boolean)

Specifies the basic unit used to extend a selection. True specifies that the basic unit is a single character. false specifies that the basic unit is a whole word.

setIsAutoWordSelected(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.