TextBoxActiveXControl

TextBoxActiveXControl class

Represents a text box ActiveX control.

class TextBoxActiveXControl extends ActiveXControl;

Constructors

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

Properties

PropertyTypeDescription
borderStyleControlBorderTypeGets and set the type of border used by the control.
borderOleColornumberGets and sets the ole color of the background.
specialEffectControlSpecialEffectTypeGets and sets the special effect of the control.
maxLengthnumberGets and sets the maximum number of characters
scrollBarsControlScrollBarTypeIndicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
passwordCharstringGets and sets a character to be displayed in place of the characters entered.
isEditablebooleanIndicates whether the user can type into the control.
integralHeightbooleanIndicates whether the control will only show complete lines of text without showing any partial lines.
isDragBehaviorEnabledbooleanIndicates whether dragging and dropping is enabled for the control.
enterKeyBehaviorbooleanSpecifies the behavior of the ENTER key. True specifies that pressing ENTER will create a new line. False specifies that pressing ENTER will move the focus to the next object in the tab order.
enterFieldBehaviorbooleanSpecifies 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.
tabKeyBehaviorbooleanIndicates whether tab characters are allowed in the text of the control.
hideSelectionbooleanIndicates whether selected text in the control appears highlighted when the control does not have focus.
isAutoTabbooleanIndicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
isMultiLinebooleanIndicates whether the control can display more than one line of text.
isWordWrappedbooleanIndicates whether the contents of the control automatically wrap at the end of a line.
textstringGets and set text of the control.
dropButtonStyleDropButtonStyleSpecifies the symbol displayed on the drop button
showDropButtonTypeWhenShowDropButtonTypeSpecifies the symbol displayed on the drop button
workbookWorkbookReadonly. Gets the Workbook object.
mouseIconUint8ArrayGets and sets a custom icon to display as the mouse pointer for the control.
mousePointerControlMousePointerTypeGets and sets the type of icon displayed as the mouse pointer for the control.
linkedCellstringGets and sets the linked cell.
listFillRangestringGets and sets the list fill range.
isEnabledbooleanIndicates whether the control can receive the focus and respond to user-generated events.
isLockedbooleanIndicates whether data in the control is locked for editing.
isTransparentbooleanIndicates whether the control is transparent.
iMEModeInputMethodEditorModeGets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
fontFontReadonly. Represents the font of the control.
textAlignTextAlignmentTypeRepresents how to align the text used by the control.

Methods

MethodDescription
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.
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
getScrollBars()@deprecated. Please use the ‘scrollBars’ property instead. Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
setScrollBars(ControlScrollBarType)@deprecated. Please use the ‘scrollBars’ property instead. Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
getPasswordChar()@deprecated. Please use the ‘passwordChar’ property instead. Gets and sets a character to be displayed in place of the characters entered.
setPasswordChar(string)@deprecated. Please use the ‘passwordChar’ property instead. Gets and sets a character to be displayed in place of the characters entered.
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.
getIntegralHeight()@deprecated. Please use the ‘integralHeight’ property instead. Indicates whether the control will only show complete lines of text without showing any partial lines.
setIntegralHeight(boolean)@deprecated. Please use the ‘integralHeight’ property instead. Indicates whether the control will only show complete lines of text without showing any partial lines.
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.
getEnterKeyBehavior()@deprecated. Please use the ’enterKeyBehavior’ property instead. Specifies the behavior of the ENTER key. True specifies that pressing ENTER will create a new line. False specifies that pressing ENTER will move the focus to the next object in the tab order.
setEnterKeyBehavior(boolean)@deprecated. Please use the ’enterKeyBehavior’ property instead. Specifies the behavior of the ENTER key. True specifies that pressing ENTER will create a new line. False specifies that pressing ENTER will move the focus to the next object in the tab order.
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.
getTabKeyBehavior()@deprecated. Please use the ’tabKeyBehavior’ property instead. Indicates whether tab characters are allowed in the text of the control.
setTabKeyBehavior(boolean)@deprecated. Please use the ’tabKeyBehavior’ property instead. Indicates whether tab characters are allowed in the text 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.
isAutoTab()@deprecated. Please use the ‘isAutoTab’ property instead. Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
setIsAutoTab(boolean)@deprecated. Please use the ‘isAutoTab’ property instead. Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
isMultiLine()@deprecated. Please use the ‘isMultiLine’ property instead. Indicates whether the control can display more than one line of text.
setIsMultiLine(boolean)@deprecated. Please use the ‘isMultiLine’ property instead. Indicates whether the control can display more than one line of text.
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.
getText()@deprecated. Please use the ’text’ property instead. Gets and set text of the control.
setText(string)@deprecated. Please use the ’text’ property instead. Gets and set text of the control.
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
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:

ParameterTypeDescription
objActiveXControlThe parent object.

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;

maxLength

Gets and sets the maximum number of characters

maxLength : number;

scrollBars

Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.

scrollBars : ControlScrollBarType;

passwordChar

Gets and sets a character to be displayed in place of the characters entered.

passwordChar : string;

isEditable

Indicates whether the user can type into the control.

isEditable : boolean;

integralHeight

Indicates whether the control will only show complete lines of text without showing any partial lines.

integralHeight : boolean;

isDragBehaviorEnabled

Indicates whether dragging and dropping is enabled for the control.

isDragBehaviorEnabled : boolean;

enterKeyBehavior

Specifies the behavior of the ENTER key. True specifies that pressing ENTER will create a new line. False specifies that pressing ENTER will move the focus to the next object in the tab order.

enterKeyBehavior : 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;

tabKeyBehavior

Indicates whether tab characters are allowed in the text of the control.

tabKeyBehavior : boolean;

hideSelection

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

hideSelection : boolean;

isAutoTab

Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.

isAutoTab : boolean;

isMultiLine

Indicates whether the control can display more than one line of text.

isMultiLine : boolean;

isWordWrapped

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

isWordWrapped : boolean;

text

Gets and set text of the control.

text : string;

dropButtonStyle

Specifies the symbol displayed on the drop button

dropButtonStyle : DropButtonStyle;

showDropButtonTypeWhen

Specifies the symbol displayed on the drop button

showDropButtonTypeWhen : ShowDropButtonType;

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;

getBorderStyle()

@deprecated. Please use the ‘borderStyle’ property instead. Gets and set the type of border used by the control.

getBorderStyle() : ControlBorderType;

Returns

ControlBorderType

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:

ParameterTypeDescription
valueControlBorderTypeThe 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:

ParameterTypeDescription
valuenumberThe 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:

ParameterTypeDescription
valueControlSpecialEffectTypeThe value to set.

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:

ParameterTypeDescription
valuenumberThe value to set.

getScrollBars()

@deprecated. Please use the ‘scrollBars’ property instead. Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.

getScrollBars() : ControlScrollBarType;

Returns

ControlScrollBarType

setScrollBars(ControlScrollBarType)

@deprecated. Please use the ‘scrollBars’ property instead. Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.

setScrollBars(value: ControlScrollBarType) : void;

Parameters:

ParameterTypeDescription
valueControlScrollBarTypeThe value to set.

getPasswordChar()

@deprecated. Please use the ‘passwordChar’ property instead. Gets and sets a character to be displayed in place of the characters entered.

getPasswordChar() : string;

setPasswordChar(string)

@deprecated. Please use the ‘passwordChar’ property instead. Gets and sets a character to be displayed in place of the characters entered.

setPasswordChar(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe 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:

ParameterTypeDescription
valuebooleanThe value to set.

getIntegralHeight()

@deprecated. Please use the ‘integralHeight’ property instead. Indicates whether the control will only show complete lines of text without showing any partial lines.

getIntegralHeight() : boolean;

setIntegralHeight(boolean)

@deprecated. Please use the ‘integralHeight’ property instead. Indicates whether the control will only show complete lines of text without showing any partial lines.

setIntegralHeight(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe value to set.

getEnterKeyBehavior()

@deprecated. Please use the ’enterKeyBehavior’ property instead. Specifies the behavior of the ENTER key. True specifies that pressing ENTER will create a new line. False specifies that pressing ENTER will move the focus to the next object in the tab order.

getEnterKeyBehavior() : boolean;

setEnterKeyBehavior(boolean)

@deprecated. Please use the ’enterKeyBehavior’ property instead. Specifies the behavior of the ENTER key. True specifies that pressing ENTER will create a new line. False specifies that pressing ENTER will move the focus to the next object in the tab order.

setEnterKeyBehavior(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe value to set.

getTabKeyBehavior()

@deprecated. Please use the ’tabKeyBehavior’ property instead. Indicates whether tab characters are allowed in the text of the control.

getTabKeyBehavior() : boolean;

setTabKeyBehavior(boolean)

@deprecated. Please use the ’tabKeyBehavior’ property instead. Indicates whether tab characters are allowed in the text of the control.

setTabKeyBehavior(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe value to set.

isAutoTab()

@deprecated. Please use the ‘isAutoTab’ property instead. Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.

isAutoTab() : boolean;

setIsAutoTab(boolean)

@deprecated. Please use the ‘isAutoTab’ property instead. Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.

setIsAutoTab(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isMultiLine()

@deprecated. Please use the ‘isMultiLine’ property instead. Indicates whether the control can display more than one line of text.

isMultiLine() : boolean;

setIsMultiLine(boolean)

@deprecated. Please use the ‘isMultiLine’ property instead. Indicates whether the control can display more than one line of text.

setIsMultiLine(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe value to set.

getText()

@deprecated. Please use the ’text’ property instead. Gets and set text of the control.

getText() : string;

setText(string)

@deprecated. Please use the ’text’ property instead. Gets and set text of the control.

setText(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getDropButtonStyle()

@deprecated. Please use the ‘dropButtonStyle’ property instead. Specifies the symbol displayed on the drop button

getDropButtonStyle() : DropButtonStyle;

Returns

DropButtonStyle

setDropButtonStyle(DropButtonStyle)

@deprecated. Please use the ‘dropButtonStyle’ property instead. Specifies the symbol displayed on the drop button

setDropButtonStyle(value: DropButtonStyle) : void;

Parameters:

ParameterTypeDescription
valueDropButtonStyleThe value to set.

getShowDropButtonTypeWhen()

@deprecated. Please use the ‘showDropButtonTypeWhen’ property instead. Specifies the symbol displayed on the drop button

getShowDropButtonTypeWhen() : ShowDropButtonType;

Returns

ShowDropButtonType

setShowDropButtonTypeWhen(ShowDropButtonType)

@deprecated. Please use the ‘showDropButtonTypeWhen’ property instead. Specifies the symbol displayed on the drop button

setShowDropButtonTypeWhen(value: ShowDropButtonType) : void;

Parameters:

ParameterTypeDescription
valueShowDropButtonTypeThe 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

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:

ParameterTypeDescription
valuenumber[]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:

ParameterTypeDescription
valueControlMousePointerTypeThe 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:

ParameterTypeDescription
valuestringThe 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:

ParameterTypeDescription
valuestringThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valueInputMethodEditorModeThe 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:

ParameterTypeDescription
valueTextAlignmentTypeThe value to set.

getType()

Gets the type of the ActiveX control.

getType() : ControlType;

Returns

ControlType

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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuenumberThe 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:

ParameterTypeDescription
valuenumberThe 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:

ParameterTypeDescription
valuenumberThe 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:

ParameterTypeDescription
valuenumberThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe value to set.

getData()

Gets and sets the binary data of the control.

getData() : Uint8Array;