ComboBoxActiveXControl
ComboBoxActiveXControl class
Represents a ComboBox ActiveX control.
class ComboBoxActiveXControl extends ActiveXControl;
Constructors
Constructor | Description |
---|---|
constructor(ActiveXControl) | Constructs from a parent object convertible to this. |
Properties
Property | Type | Description |
---|---|---|
maxLength | number | Gets and sets the maximum number of characters |
listWidth | number | Gets and set the width in unit of points. |
boundColumn | number | Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle). |
textColumn | number | Represents the column in a ComboBox or ListBox to display to the user. |
columnCount | number | Represents the number of columns to display in a ComboBox or ListBox. |
listRows | number | Represents the maximum number of rows to display in the list. |
matchEntry | ControlMatchEntryType | Indicates how a ListBox or ComboBox searches its list as the user types. |
dropButtonStyle | DropButtonStyle | Specifies the symbol displayed on the drop button |
showDropButtonTypeWhen | ShowDropButtonType | Specifies the symbol displayed on the drop button |
listStyle | ControlListStyle | Gets and sets the visual appearance. |
borderStyle | ControlBorderType | Gets and set the type of border used by the control. |
borderOleColor | number | Gets and sets the ole color of the background. |
specialEffect | ControlSpecialEffectType | Gets and sets the special effect of the control. |
isEditable | boolean | Indicates whether the user can type into the control. |
showColumnHeads | boolean | Indicates whether column headings are displayed. |
isDragBehaviorEnabled | boolean | Indicates whether dragging and dropping is enabled for the control. |
enterFieldBehavior | 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. |
selectionMargin | boolean | Indicates whether the user can select a line of text by clicking in the region to the left of the text. |
value | string | Gets and sets the value of the control. |
hideSelection | boolean | Indicates whether selected text in the control appears highlighted when the control does not have focus. |
columnWidths | number | Gets and sets the width of the column. |
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 |
---|---|
getMaxLength() | @deprecated. Please use the ‘maxLength’ property instead. Gets and sets the maximum number of characters |
setMaxLength(number) | @deprecated. Please use the ‘maxLength’ property instead. Gets and sets the maximum number of characters |
getListWidth() | @deprecated. Please use the ’listWidth’ property instead. Gets and set the width in unit of points. |
setListWidth(number) | @deprecated. Please use the ’listWidth’ property instead. Gets and set the width in unit of points. |
getBoundColumn() | @deprecated. Please use the ‘boundColumn’ property instead. Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle). |
setBoundColumn(number) | @deprecated. Please use the ‘boundColumn’ property instead. Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle). |
getTextColumn() | @deprecated. Please use the ’textColumn’ property instead. Represents the column in a ComboBox or ListBox to display to the user. |
setTextColumn(number) | @deprecated. Please use the ’textColumn’ property instead. Represents the column in a ComboBox or ListBox to display to the user. |
getColumnCount() | @deprecated. Please use the ‘columnCount’ property instead. Represents the number of columns to display in a ComboBox or ListBox. |
setColumnCount(number) | @deprecated. Please use the ‘columnCount’ property instead. Represents the number of columns to display in a ComboBox or ListBox. |
getListRows() | @deprecated. Please use the ’listRows’ property instead. Represents the maximum number of rows to display in the list. |
setListRows(number) | @deprecated. Please use the ’listRows’ property instead. Represents the maximum number of rows to display in the list. |
getMatchEntry() | @deprecated. Please use the ‘matchEntry’ property instead. Indicates how a ListBox or ComboBox searches its list as the user types. |
setMatchEntry(ControlMatchEntryType) | @deprecated. Please use the ‘matchEntry’ property instead. Indicates how a ListBox or ComboBox searches its list as the user types. |
getDropButtonStyle() | @deprecated. Please use the ‘dropButtonStyle’ property instead. Specifies the symbol displayed on the drop button |
setDropButtonStyle(DropButtonStyle) | @deprecated. Please use the ‘dropButtonStyle’ property instead. Specifies the symbol displayed on the drop button |
getShowDropButtonTypeWhen() | @deprecated. Please use the ‘showDropButtonTypeWhen’ property instead. Specifies the symbol displayed on the drop button |
setShowDropButtonTypeWhen(ShowDropButtonType) | @deprecated. Please use the ‘showDropButtonTypeWhen’ property instead. Specifies the symbol displayed on the drop button |
getListStyle() | @deprecated. Please use the ’listStyle’ property instead. Gets and sets the visual appearance. |
setListStyle(ControlListStyle) | @deprecated. Please use the ’listStyle’ property instead. Gets and sets the visual appearance. |
getBorderStyle() | @deprecated. Please use the ‘borderStyle’ property instead. Gets and set the type of border used by the control. |
setBorderStyle(ControlBorderType) | @deprecated. Please use the ‘borderStyle’ property instead. Gets and set the type of border used by the control. |
getBorderOleColor() | @deprecated. Please use the ‘borderOleColor’ property instead. Gets and sets the ole color of the background. |
setBorderOleColor(number) | @deprecated. Please use the ‘borderOleColor’ property instead. Gets and sets the ole color of the background. |
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. |
isEditable() | @deprecated. Please use the ‘isEditable’ property instead. Indicates whether the user can type into the control. |
setIsEditable(boolean) | @deprecated. Please use the ‘isEditable’ property instead. Indicates whether the user can type into the control. |
getShowColumnHeads() | @deprecated. Please use the ‘showColumnHeads’ property instead. Indicates whether column headings are displayed. |
setShowColumnHeads(boolean) | @deprecated. Please use the ‘showColumnHeads’ property instead. Indicates whether column headings are displayed. |
isDragBehaviorEnabled() | @deprecated. Please use the ‘isDragBehaviorEnabled’ property instead. Indicates whether dragging and dropping is enabled for the control. |
setIsDragBehaviorEnabled(boolean) | @deprecated. Please use the ‘isDragBehaviorEnabled’ property instead. Indicates whether dragging and dropping is enabled for the control. |
getEnterFieldBehavior() | @deprecated. Please use the ’enterFieldBehavior’ property instead. 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) | @deprecated. Please use the ’enterFieldBehavior’ property instead. 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() | @deprecated. Please use the ‘selectionMargin’ property instead. Indicates whether the user can select a line of text by clicking in the region to the left of the text. |
setSelectionMargin(boolean) | @deprecated. Please use the ‘selectionMargin’ property instead. Indicates whether the user can select a line of text by clicking in the region to the left of the text. |
getValue() | @deprecated. Please use the ‘value’ property instead. Gets and sets the value of the control. |
setValue(string) | @deprecated. Please use the ‘value’ property instead. Gets and sets the value of the control. |
getHideSelection() | @deprecated. Please use the ‘hideSelection’ property instead. Indicates whether selected text in the control appears highlighted when the control does not have focus. |
setHideSelection(boolean) | @deprecated. Please use the ‘hideSelection’ property instead. Indicates whether selected text in the control appears highlighted when the control does not have focus. |
getColumnWidths() | @deprecated. Please use the ‘columnWidths’ property instead. Gets and sets the width of the column. |
setColumnWidths(number) | @deprecated. Please use the ‘columnWidths’ property instead. Gets and sets the width of the column. |
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. |
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. |
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. |
maxLength
Gets and sets the maximum number of characters
maxLength : number;
listWidth
Gets and set the width in unit of points.
listWidth : number;
boundColumn
Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle).
boundColumn : number;
textColumn
Represents the column in a ComboBox or ListBox to display to the user.
textColumn : number;
columnCount
Represents the number of columns to display in a ComboBox or ListBox.
columnCount : number;
listRows
Represents the maximum number of rows to display in the list.
listRows : number;
matchEntry
Indicates how a ListBox or ComboBox searches its list as the user types.
matchEntry : ControlMatchEntryType;
dropButtonStyle
Specifies the symbol displayed on the drop button
dropButtonStyle : DropButtonStyle;
showDropButtonTypeWhen
Specifies the symbol displayed on the drop button
showDropButtonTypeWhen : ShowDropButtonType;
listStyle
Gets and sets the visual appearance.
listStyle : ControlListStyle;
borderStyle
Gets and set the type of border used by the control.
borderStyle : ControlBorderType;
borderOleColor
Gets and sets the ole color of the background.
borderOleColor : number;
specialEffect
Gets and sets the special effect of the control.
specialEffect : ControlSpecialEffectType;
isEditable
Indicates whether the user can type into the control.
isEditable : boolean;
showColumnHeads
Indicates whether column headings are displayed.
showColumnHeads : boolean;
isDragBehaviorEnabled
Indicates whether dragging and dropping is enabled for the control.
isDragBehaviorEnabled : boolean;
enterFieldBehavior
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.
enterFieldBehavior : boolean;
selectionMargin
Indicates whether the user can select a line of text by clicking in the region to the left of the text.
selectionMargin : boolean;
value
Gets and sets the value of the control.
value : string;
hideSelection
Indicates whether selected text in the control appears highlighted when the control does not have focus.
hideSelection : boolean;
columnWidths
Gets and sets the width of the column.
columnWidths : number;
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;
getMaxLength()
@deprecated. Please use the ‘maxLength’ property instead. Gets and sets the maximum number of characters
getMaxLength() : number;
setMaxLength(number)
@deprecated. Please use the ‘maxLength’ property instead. Gets and sets the maximum number of characters
setMaxLength(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getListWidth()
@deprecated. Please use the ’listWidth’ property instead. Gets and set the width in unit of points.
getListWidth() : number;
setListWidth(number)
@deprecated. Please use the ’listWidth’ property instead. Gets and set the width in unit of points.
setListWidth(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getBoundColumn()
@deprecated. Please use the ‘boundColumn’ property instead. Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle).
getBoundColumn() : number;
setBoundColumn(number)
@deprecated. Please use the ‘boundColumn’ property instead. 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()
@deprecated. Please use the ’textColumn’ property instead. Represents the column in a ComboBox or ListBox to display to the user.
getTextColumn() : number;
setTextColumn(number)
@deprecated. Please use the ’textColumn’ property instead. 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()
@deprecated. Please use the ‘columnCount’ property instead. Represents the number of columns to display in a ComboBox or ListBox.
getColumnCount() : number;
setColumnCount(number)
@deprecated. Please use the ‘columnCount’ property instead. 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()
@deprecated. Please use the ’listRows’ property instead. Represents the maximum number of rows to display in the list.
getListRows() : number;
setListRows(number)
@deprecated. Please use the ’listRows’ property instead. 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()
@deprecated. Please use the ‘matchEntry’ property instead. Indicates how a ListBox or ComboBox searches its list as the user types.
getMatchEntry() : ControlMatchEntryType;
Returns
setMatchEntry(ControlMatchEntryType)
@deprecated. Please use the ‘matchEntry’ property instead. 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()
@deprecated. Please use the ‘dropButtonStyle’ property instead. Specifies the symbol displayed on the drop button
getDropButtonStyle() : DropButtonStyle;
Returns
setDropButtonStyle(DropButtonStyle)
@deprecated. Please use the ‘dropButtonStyle’ property instead. Specifies the symbol displayed on the drop button
setDropButtonStyle(value: DropButtonStyle) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | DropButtonStyle | The value to set. |
getShowDropButtonTypeWhen()
@deprecated. Please use the ‘showDropButtonTypeWhen’ property instead. Specifies the symbol displayed on the drop button
getShowDropButtonTypeWhen() : ShowDropButtonType;
Returns
setShowDropButtonTypeWhen(ShowDropButtonType)
@deprecated. Please use the ‘showDropButtonTypeWhen’ property instead. Specifies the symbol displayed on the drop button
setShowDropButtonTypeWhen(value: ShowDropButtonType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | ShowDropButtonType | The value to set. |
getListStyle()
@deprecated. Please use the ’listStyle’ property instead. Gets and sets the visual appearance.
getListStyle() : ControlListStyle;
Returns
setListStyle(ControlListStyle)
@deprecated. Please use the ’listStyle’ property instead. Gets and sets the visual appearance.
setListStyle(value: ControlListStyle) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | ControlListStyle | The value to set. |
getBorderStyle()
@deprecated. Please use the ‘borderStyle’ property instead. Gets and set the type of border used by the control.
getBorderStyle() : ControlBorderType;
Returns
setBorderStyle(ControlBorderType)
@deprecated. Please use the ‘borderStyle’ property instead. 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()
@deprecated. Please use the ‘borderOleColor’ property instead. Gets and sets the ole color of the background.
getBorderOleColor() : number;
setBorderOleColor(number)
@deprecated. Please use the ‘borderOleColor’ property instead. Gets and sets the ole color of the background.
setBorderOleColor(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getSpecialEffect()
@deprecated. Please use the ‘specialEffect’ property instead. Gets and sets the special effect of the control.
getSpecialEffect() : ControlSpecialEffectType;
Returns
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. |
isEditable()
@deprecated. Please use the ‘isEditable’ property instead. Indicates whether the user can type into the control.
isEditable() : boolean;
setIsEditable(boolean)
@deprecated. Please use the ‘isEditable’ property instead. Indicates whether the user can type into the control.
setIsEditable(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getShowColumnHeads()
@deprecated. Please use the ‘showColumnHeads’ property instead. Indicates whether column headings are displayed.
getShowColumnHeads() : boolean;
setShowColumnHeads(boolean)
@deprecated. Please use the ‘showColumnHeads’ property instead. Indicates whether column headings are displayed.
setShowColumnHeads(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
isDragBehaviorEnabled()
@deprecated. Please use the ‘isDragBehaviorEnabled’ property instead. Indicates whether dragging and dropping is enabled for the control.
isDragBehaviorEnabled() : boolean;
setIsDragBehaviorEnabled(boolean)
@deprecated. Please use the ‘isDragBehaviorEnabled’ property instead. 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()
@deprecated. Please use the ’enterFieldBehavior’ property instead. 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)
@deprecated. Please use the ’enterFieldBehavior’ property instead. 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()
@deprecated. Please use the ‘selectionMargin’ property instead. 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)
@deprecated. Please use the ‘selectionMargin’ property instead. 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()
@deprecated. Please use the ‘value’ property instead. Gets and sets the value of the control.
getValue() : string;
setValue(string)
@deprecated. Please use the ‘value’ property instead. Gets and sets the value of the control.
setValue(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
getHideSelection()
@deprecated. Please use the ‘hideSelection’ property instead. Indicates whether selected text in the control appears highlighted when the control does not have focus.
getHideSelection() : boolean;
setHideSelection(boolean)
@deprecated. Please use the ‘hideSelection’ property instead. 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()
@deprecated. Please use the ‘columnWidths’ property instead. Gets and sets the width of the column.
getColumnWidths() : number;
setColumnWidths(number)
@deprecated. Please use the ‘columnWidths’ property instead. Gets and sets the width of the column.
setColumnWidths(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
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
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
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
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
getTextAlign()
@deprecated. Please use the ’textAlign’ property instead. Represents how to align the text used by the control.
getTextAlign() : TextAlignmentType;
Returns
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
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. |
getData()
Gets and sets the binary data of the control.
getData() : Uint8Array;