TextBoxActiveXControl

TextBoxActiveXControl class

Represents a text box ActiveX control.

class TextBoxActiveXControl 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.
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.
getMaxLength()	Gets and sets the maximum number of characters
setMaxLength(number)	Gets and sets the maximum number of characters
getScrollBars()	Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
setScrollBars(ControlScrollBarType)	Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
getPasswordChar()	Gets and sets a character to be displayed in place of the characters entered.
setPasswordChar(string)	Gets and sets a character to be displayed in place of the characters entered.
isEditable()	Indicates whether the user can type into the control.
setIsEditable(boolean)	Indicates whether the user can type into the control.
getIntegralHeight()	Indicates whether the control will only show complete lines of text without showing any partial lines.
setIntegralHeight(boolean)	Indicates whether the control will only show complete lines of text without showing any partial lines.
isDragBehaviorEnabled()	Indicates whether dragging and dropping is enabled for the control.
setIsDragBehaviorEnabled(boolean)	Indicates whether dragging and dropping is enabled for the control.
getEnterKeyBehavior()	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)	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()	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.
getTabKeyBehavior()	Indicates whether tab characters are allowed in the text of the control.
setTabKeyBehavior(boolean)	Indicates whether tab characters are allowed in the text 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.
isAutoTab()	Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
setIsAutoTab(boolean)	Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
isMultiLine()	Indicates whether the control can display more than one line of text.
setIsMultiLine(boolean)	Indicates whether the control can display more than one line of text.
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.
getText()	Gets and set text of the control.
setText(string)	Gets and set text of the control.
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
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

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.

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.

getScrollBars()

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

getScrollBars() : ControlScrollBarType;

Returns

ControlScrollBarType

setScrollBars(ControlScrollBarType)

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

setScrollBars(value: ControlScrollBarType) : void;

Parameters:

Parameter	Type	Description
value	ControlScrollBarType	The value to set.

getPasswordChar()

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

getPasswordChar() : string;

setPasswordChar(string)

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

setPasswordChar(value: string) : void;

Parameters:

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

getIntegralHeight()

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

getIntegralHeight() : boolean;

setIntegralHeight(boolean)

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

setIntegralHeight(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.

getEnterKeyBehavior()

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)

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:

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.

getTabKeyBehavior()

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

getTabKeyBehavior() : boolean;

setTabKeyBehavior(boolean)

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

setTabKeyBehavior(value: boolean) : void;

Parameters:

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

isAutoTab()

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

isAutoTab() : boolean;

setIsAutoTab(boolean)

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:

Parameter	Type	Description
value	boolean	The value to set.

isMultiLine()

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

isMultiLine() : boolean;

setIsMultiLine(boolean)

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

setIsMultiLine(value: boolean) : void;

Parameters:

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

getText()

Gets and set text of the control.

getText() : string;

setText(string)

Gets and set text of the control.

setText(value: string) : void;

Parameters:

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

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.