asposecells.api

Classes

Constants

Class TextBoxActiveXControl

Represents a text box ActiveX control.

Property Getters/Setters Summary
`method`	`getBackOleColor()`
`method`	`setBackOleColor(value)`
	Gets and sets the ole color of the background.
`method`	`getBorderOleColor()`
`method`	`setBorderOleColor(value)`
	Gets and sets the ole color of the background.
`method`	`getBorderStyle()`
`method`	`setBorderStyle(value)`
	Gets and set the type of border used by the control. The value of the property is ControlBorderType integer constant.
`method`	`getData()`
	Gets and sets the binary data of the control.
`method`	`getDropButtonStyle()`
`method`	`setDropButtonStyle(value)`
	Specifies the symbol displayed on the drop button The value of the property is DropButtonStyle integer constant.
`method`	`getEnterFieldBehavior()`
`method`	`setEnterFieldBehavior(value)`
	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.
`method`	`getEnterKeyBehavior()`
`method`	`setEnterKeyBehavior(value)`
	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.
`method`	`getFont()`
	Represents the font of the control.
`method`	`getForeOleColor()`
`method`	`setForeOleColor(value)`
	Gets and sets the ole color of the foreground.
`method`	`getHeight()`
`method`	`setHeight(value)`
	Gets and sets the height of the control in unit of points.
`method`	`getHideSelection()`
`method`	`setHideSelection(value)`
	Indicates whether selected text in the control appears highlighted when the control does not have focus.
`method`	`getIMEMode()`
`method`	`setIMEMode(value)`
	Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus. The value of the property is InputMethodEditorMode integer constant.
`method`	`getIntegralHeight()`
`method`	`setIntegralHeight(value)`
	Indicates whether the control will only show complete lines of text without showing any partial lines.
`method`	`isAutoSize()`
`method`	`setAutoSize(value)`
	Indicates whether the control will automatically resize to display its entire contents.
`method`	`isAutoTab()`
`method`	`setAutoTab(value)`
	Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
`method`	`isAutoWordSelected()`
`method`	`setAutoWordSelected(value)`
	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.
`method`	`isDragBehaviorEnabled()`
`method`	`setDragBehaviorEnabled(value)`
	Indicates whether dragging and dropping is enabled for the control.
`method`	`isEditable()`
`method`	`setEditable(value)`
	Indicates whether the user can type into the control.
`method`	`isEnabled()`
`method`	`setEnabled(value)`
	Indicates whether the control can receive the focus and respond to user-generated events.
`method`	`isLocked()`
`method`	`setLocked(value)`
	Indicates whether data in the control is locked for editing.
`method`	`isMultiLine()`
`method`	`setMultiLine(value)`
	Indicates whether the control can display more than one line of text.
`method`	`isTransparent()`
`method`	`setTransparent(value)`
	Indicates whether the control is transparent.
`method`	`isVisible()`
`method`	`setVisible(value)`
	Indicates whether this control is visible.
`method`	`isWordWrapped()`
`method`	`setWordWrapped(value)`
	Indicates whether the contents of the control automatically wrap at the end of a line.
`method`	`getLinkedCell()`
`method`	`setLinkedCell(value)`
	Gets and sets the linked cell.
`method`	`getListFillRange()`
`method`	`setListFillRange(value)`
	Gets and sets the list fill range.
`method`	`getMaxLength()`
`method`	`setMaxLength(value)`
	Gets and sets the maximum number of characters
`method`	`getMouseIcon()`
`method`	`setMouseIcon(value)`
	Gets and sets a custom icon to display as the mouse pointer for the control.
`method`	`getMousePointer()`
`method`	`setMousePointer(value)`
	Gets and sets the type of icon displayed as the mouse pointer for the control. The value of the property is ControlMousePointerType integer constant.
`method`	`getPasswordChar()`
`method`	`setPasswordChar(value)`
	Gets and sets a character to be displayed in place of the characters entered.
`method`	`getScrollBars()`
`method`	`setScrollBars(value)`
	Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. The value of the property is ControlScrollBarType integer constant.
`method`	`getShadow()`
`method`	`setShadow(value)`
	Indicates whether to show a shadow.
`method`	`getShowDropButtonTypeWhen()`
`method`	`setShowDropButtonTypeWhen(value)`
	Specifies the symbol displayed on the drop button The value of the property is ShowDropButtonType integer constant.
`method`	`getSpecialEffect()`
`method`	`setSpecialEffect(value)`
	Gets and sets the special effect of the control. The value of the property is ControlSpecialEffectType integer constant.
`method`	`getTabKeyBehavior()`
`method`	`setTabKeyBehavior(value)`
	Indicates whether tab characters are allowed in the text of the control.
`method`	`getText()`
`method`	`setText(value)`
	Gets and set text of the control.
`method`	`getTextAlign()`
`method`	`setTextAlign(value)`
	Represents how to align the text used by the control. The value of the property is TextAlignmentType integer constant.
`method`	`getType()`
	Gets the type of the ActiveX control. The value of the property is ControlType integer constant.
`method`	`getWidth()`
`method`	`setWidth(value)`
	Gets and sets the width of the control in unit of points.
`method`	`getWorkbook()`
	Gets the Workbook object.

- Property Getters/Setters Detail
  - getType : int
```
int getType()
```
    Gets the type of the ActiveX control. The value of the property is ControlType integer constant.
  - getBorderStyle/setBorderStyle : int
```
int getBorderStyle() / setBorderStyle(value)
```
    Gets and set the type of border used by the control. The value of the property is ControlBorderType integer constant.
  - getBorderOleColor/setBorderOleColor : int
```
int getBorderOleColor() / setBorderOleColor(value)
```
    Gets and sets the ole color of the background.
  - getSpecialEffect/setSpecialEffect : int
```
int getSpecialEffect() / setSpecialEffect(value)
```
    Gets and sets the special effect of the control. The value of the property is ControlSpecialEffectType integer constant.
  - getMaxLength/setMaxLength : int
```
int getMaxLength() / setMaxLength(value)
```
    Gets and sets the maximum number of characters
  - getScrollBars/setScrollBars : int
```
int getScrollBars() / setScrollBars(value)
```
    Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. The value of the property is ControlScrollBarType integer constant.
  - getPasswordChar/setPasswordChar : char
```
char getPasswordChar() / setPasswordChar(value)
```
    Gets and sets a character to be displayed in place of the characters entered.
  - isEditable/setEditable : boolean
```
boolean isEditable() / setEditable(value)
```
    Indicates whether the user can type into the control.
  - getIntegralHeight/setIntegralHeight : boolean
```
boolean getIntegralHeight() / setIntegralHeight(value)
```
    Indicates whether the control will only show complete lines of text without showing any partial lines.
  - isDragBehaviorEnabled/setDragBehaviorEnabled : boolean
```
boolean isDragBehaviorEnabled() / setDragBehaviorEnabled(value)
```
    Indicates whether dragging and dropping is enabled for the control.
  - getEnterKeyBehavior/setEnterKeyBehavior : boolean
```
boolean getEnterKeyBehavior() / setEnterKeyBehavior(value)
```
    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/setEnterFieldBehavior : boolean
```
boolean getEnterFieldBehavior() / setEnterFieldBehavior(value)
```
    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/setTabKeyBehavior : boolean
```
boolean getTabKeyBehavior() / setTabKeyBehavior(value)
```
    Indicates whether tab characters are allowed in the text of the control.
  - getHideSelection/setHideSelection : boolean
```
boolean getHideSelection() / setHideSelection(value)
```
    Indicates whether selected text in the control appears highlighted when the control does not have focus.
  - isAutoTab/setAutoTab : boolean
```
boolean isAutoTab() / setAutoTab(value)
```
    Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
  - isMultiLine/setMultiLine : boolean
```
boolean isMultiLine() / setMultiLine(value)
```
    Indicates whether the control can display more than one line of text.
  - isAutoWordSelected/setAutoWordSelected : boolean
```
boolean isAutoWordSelected() / setAutoWordSelected(value)
```
    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.
  - isWordWrapped/setWordWrapped : boolean
```
boolean isWordWrapped() / setWordWrapped(value)
```
    Indicates whether the contents of the control automatically wrap at the end of a line.
  - getText/setText : String
```
String getText() / setText(value)
```
    Gets and set text of the control.
  - getDropButtonStyle/setDropButtonStyle : int
```
int getDropButtonStyle() / setDropButtonStyle(value)
```
    Specifies the symbol displayed on the drop button The value of the property is DropButtonStyle integer constant.
  - getShowDropButtonTypeWhen/setShowDropButtonTypeWhen : int
```
int getShowDropButtonTypeWhen() / setShowDropButtonTypeWhen(value)
```
    Specifies the symbol displayed on the drop button The value of the property is ShowDropButtonType integer constant.
  - isEnabled/setEnabled : boolean
```
boolean isEnabled() / setEnabled(value)
```
    Indicates whether the control can receive the focus and respond to user-generated events.
  - isLocked/setLocked : boolean
```
boolean isLocked() / setLocked(value)
```
    Indicates whether data in the control is locked for editing.
  - isTransparent/setTransparent : boolean
```
boolean isTransparent() / setTransparent(value)
```
    Indicates whether the control is transparent.
  - isAutoSize/setAutoSize : boolean
```
boolean isAutoSize() / setAutoSize(value)
```
    Indicates whether the control will automatically resize to display its entire contents.
  - getIMEMode/setIMEMode : int
```
int getIMEMode() / setIMEMode(value)
```
    Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus. The value of the property is InputMethodEditorMode integer constant.
  - getFont : Font
```
Font getFont()
```
    Represents the font of the control.
  - getTextAlign/setTextAlign : int
```
int getTextAlign() / setTextAlign(value)
```
    Represents how to align the text used by the control. The value of the property is TextAlignmentType integer constant.
  - getData : byte[]
```
byte[] getData()
```
    Gets and sets the binary data of the control.
  - getWorkbook : Workbook
```
Workbook getWorkbook()
```
    Gets the Workbook object.
  - getWidth/setWidth : float
```
float getWidth() / setWidth(value)
```
    Gets and sets the width of the control in unit of points.
  - getHeight/setHeight : float
```
float getHeight() / setHeight(value)
```
    Gets and sets the height of the control in unit of points.
  - getMouseIcon/setMouseIcon : byte[]
```
byte[] getMouseIcon() / setMouseIcon(value)
```
    Gets and sets a custom icon to display as the mouse pointer for the control.
  - getMousePointer/setMousePointer : int
```
int getMousePointer() / setMousePointer(value)
```
    Gets and sets the type of icon displayed as the mouse pointer for the control. The value of the property is ControlMousePointerType integer constant.
  - getForeOleColor/setForeOleColor : int
```
int getForeOleColor() / setForeOleColor(value)
```
    Gets and sets the ole color of the foreground.
    Not applies to Image control.
  - getBackOleColor/setBackOleColor : int
```
int getBackOleColor() / setBackOleColor(value)
```
    Gets and sets the ole color of the background.
  - isVisible/setVisible : boolean
```
boolean isVisible() / setVisible(value)
```
    Indicates whether this control is visible.
  - getShadow/setShadow : boolean
```
boolean getShadow() / setShadow(value)
```
    Indicates whether to show a shadow.
  - getLinkedCell/setLinkedCell : String
```
String getLinkedCell() / setLinkedCell(value)
```
    Gets and sets the linked cell.
  - getListFillRange/setListFillRange : String
```
String getListFillRange() / setListFillRange(value)
```
    Gets and sets the list fill range.

asposecells.api

Classes

Constants

Class TextBoxActiveXControl

Property Getters/Setters Detail

getType : int

getBorderStyle/setBorderStyle : int

getBorderOleColor/setBorderOleColor : int

getSpecialEffect/setSpecialEffect : int

getMaxLength/setMaxLength : int

getScrollBars/setScrollBars : int

getPasswordChar/setPasswordChar : char

isEditable/setEditable : boolean

getIntegralHeight/setIntegralHeight : boolean

isDragBehaviorEnabled/setDragBehaviorEnabled : boolean

getEnterKeyBehavior/setEnterKeyBehavior : boolean

getEnterFieldBehavior/setEnterFieldBehavior : boolean

getTabKeyBehavior/setTabKeyBehavior : boolean

getHideSelection/setHideSelection : boolean

isAutoTab/setAutoTab : boolean

isMultiLine/setMultiLine : boolean

isAutoWordSelected/setAutoWordSelected : boolean

isWordWrapped/setWordWrapped : boolean

getText/setText : String

getDropButtonStyle/setDropButtonStyle : int

getShowDropButtonTypeWhen/setShowDropButtonTypeWhen : int

isEnabled/setEnabled : boolean

isLocked/setLocked : boolean

isTransparent/setTransparent : boolean

isAutoSize/setAutoSize : boolean

getIMEMode/setIMEMode : int

getFont : Font

getTextAlign/setTextAlign : int

getData : byte[]

getWorkbook : Workbook

getWidth/setWidth : float

getHeight/setHeight : float

getMouseIcon/setMouseIcon : byte[]

getMousePointer/setMousePointer : int

getForeOleColor/setForeOleColor : int

getBackOleColor/setBackOleColor : int

isVisible/setVisible : boolean

getShadow/setShadow : boolean

getLinkedCell/setLinkedCell : String

getListFillRange/setListFillRange : String