com.aspose.cells

Class TextBoxActiveXControl

public class TextBoxActiveXControl 
extends ActiveXControl

Represents a text box ActiveX control.

Property Getters/Setters Summary
intgetBackOleColor()
void
setBackOleColor(intvalue)
           Gets and sets the ole color of the background.
intgetBorderOleColor()
void
           Gets and sets the ole color of the background.
intgetBorderStyle()
void
setBorderStyle(intvalue)
           Gets and set the type of border used by the control. The value of the property is ControlBorderType integer constant.
byte[]getData()
Gets and sets the binary data of the control.
intgetDropButtonStyle()
void
           Specifies the symbol displayed on the drop button The value of the property is DropButtonStyle integer constant.
booleangetEnterFieldBehavior()
void
setEnterFieldBehavior(booleanvalue)
           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.
booleangetEnterKeyBehavior()
void
setEnterKeyBehavior(booleanvalue)
           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.
FontgetFont()
Represents the font of the control.
intgetForeOleColor()
void
setForeOleColor(intvalue)
           Gets and sets the ole color of the foreground.
doublegetHeight()
void
setHeight(doublevalue)
           Gets and sets the height of the control in unit of points.
booleangetHideSelection()
void
setHideSelection(booleanvalue)
           Indicates whether selected text in the control appears highlighted when the control does not have focus.
intgetIMEMode()
void
setIMEMode(intvalue)
           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.
booleangetIntegralHeight()
void
setIntegralHeight(booleanvalue)
           Indicates whether the control will only show complete lines of text without showing any partial lines.
booleanisAutoSize()
void
setAutoSize(booleanvalue)
           Indicates whether the control will automatically resize to display its entire contents.
booleanisAutoTab()
void
setAutoTab(booleanvalue)
           Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
booleanisAutoWordSelected()
void
setAutoWordSelected(booleanvalue)
           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.
booleanisDragBehaviorEnabled()
void
           Indicates whether dragging and dropping is enabled for the control.
booleanisEditable()
void
setEditable(booleanvalue)
           Indicates whether the user can type into the control.
booleanisEnabled()
void
setEnabled(booleanvalue)
           Indicates whether the control can receive the focus and respond to user-generated events.
booleanisLocked()
void
setLocked(booleanvalue)
           Indicates whether data in the control is locked for editing.
booleanisMultiLine()
void
setMultiLine(booleanvalue)
           Indicates whether the control can display more than one line of text.
booleanisTransparent()
void
setTransparent(booleanvalue)
           Indicates whether the control is transparent.
booleanisVisible()
void
setVisible(booleanvalue)
           Indicates whether this control is visible.
booleanisWordWrapped()
void
setWordWrapped(booleanvalue)
           Indicates whether the contents of the control automatically wrap at the end of a line.
java.lang.StringgetLinkedCell()
void
setLinkedCell(java.lang.Stringvalue)
           Gets and sets the linked cell.
java.lang.StringgetListFillRange()
void
setListFillRange(java.lang.Stringvalue)
           Gets and sets the list fill range.
intgetMaxLength()
void
setMaxLength(intvalue)
           Gets and sets the maximum number of characters
byte[]getMouseIcon()
void
setMouseIcon(byte[]value)
           Gets and sets a custom icon to display as the mouse pointer for the control.
intgetMousePointer()
void
setMousePointer(intvalue)
           Gets and sets the type of icon displayed as the mouse pointer for the control. The value of the property is ControlMousePointerType integer constant.
chargetPasswordChar()
void
setPasswordChar(charvalue)
           Gets and sets a character to be displayed in place of the characters entered.
intgetScrollBars()
void
setScrollBars(intvalue)
           Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. The value of the property is ControlScrollBarType integer constant.
booleangetShadow()
void
setShadow(booleanvalue)
           Indicates whether to show a shadow.
intgetShowDropButtonTypeWhen()
void
           Specifies the symbol displayed on the drop button The value of the property is ShowDropButtonType integer constant.
intgetSpecialEffect()
void
           Gets and sets the special effect of the control. The value of the property is ControlSpecialEffectType integer constant.
booleangetTabKeyBehavior()
void
setTabKeyBehavior(booleanvalue)
           Indicates whether tab characters are allowed in the text of the control.
java.lang.StringgetText()
void
setText(java.lang.Stringvalue)
           Gets and set text of the control.
intgetTextAlign()
void
setTextAlign(intvalue)
           Represents how to align the text used by the control. The value of the property is TextAlignmentType integer constant.
intgetType()
Gets the type of the ActiveX control. The value of the property is ControlType integer constant.
doublegetWidth()
void
setWidth(doublevalue)
           Gets and sets the width of the control in unit of points.
WorkbookgetWorkbook()
Gets the Workbook object.
 

    • Property Getters/Setters Detail

      • getType

        public int getType()
        
        Gets the type of the ActiveX control. The value of the property is ControlType integer constant.
      • getBorderStyle/setBorderStyle

        public int getBorderStyle() / public void setBorderStyle(int value)
        
        Gets and set the type of border used by the control. The value of the property is ControlBorderType integer constant.
      • getBorderOleColor/setBorderOleColor

        public int getBorderOleColor() / public void setBorderOleColor(int value)
        
        Gets and sets the ole color of the background.
      • getSpecialEffect/setSpecialEffect

        public int getSpecialEffect() / public void setSpecialEffect(int value)
        
        Gets and sets the special effect of the control. The value of the property is ControlSpecialEffectType integer constant.
      • getMaxLength/setMaxLength

        public int getMaxLength() / public void setMaxLength(int value)
        
        Gets and sets the maximum number of characters
      • getScrollBars/setScrollBars

        public int getScrollBars() / public void setScrollBars(int 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

        public char getPasswordChar() / public void setPasswordChar(char value)
        
        Gets and sets a character to be displayed in place of the characters entered.
      • isEditable/setEditable

        public boolean isEditable() / public void setEditable(boolean value)
        
        Indicates whether the user can type into the control.
      • getIntegralHeight/setIntegralHeight

        public boolean getIntegralHeight() / public void setIntegralHeight(boolean value)
        
        Indicates whether the control will only show complete lines of text without showing any partial lines.
      • isDragBehaviorEnabled/setDragBehaviorEnabled

        public boolean isDragBehaviorEnabled() / public void setDragBehaviorEnabled(boolean value)
        
        Indicates whether dragging and dropping is enabled for the control.
      • getEnterKeyBehavior/setEnterKeyBehavior

        public boolean getEnterKeyBehavior() / public void setEnterKeyBehavior(boolean 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

        public boolean getEnterFieldBehavior() / public void setEnterFieldBehavior(boolean 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

        public boolean getTabKeyBehavior() / public void setTabKeyBehavior(boolean value)
        
        Indicates whether tab characters are allowed in the text of the control.
      • getHideSelection/setHideSelection

        public boolean getHideSelection() / public void setHideSelection(boolean value)
        
        Indicates whether selected text in the control appears highlighted when the control does not have focus.
      • isAutoTab/setAutoTab

        public boolean isAutoTab() / public void setAutoTab(boolean value)
        
        Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
      • isMultiLine/setMultiLine

        public boolean isMultiLine() / public void setMultiLine(boolean value)
        
        Indicates whether the control can display more than one line of text.
      • isAutoWordSelected/setAutoWordSelected

        public boolean isAutoWordSelected() / public void setAutoWordSelected(boolean 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

        public boolean isWordWrapped() / public void setWordWrapped(boolean value)
        
        Indicates whether the contents of the control automatically wrap at the end of a line.
      • getText/setText

        public java.lang.String getText() / public void setText(java.lang.String value)
        
        Gets and set text of the control.
      • getDropButtonStyle/setDropButtonStyle

        public int getDropButtonStyle() / public void setDropButtonStyle(int value)
        
        Specifies the symbol displayed on the drop button The value of the property is DropButtonStyle integer constant.
      • getShowDropButtonTypeWhen/setShowDropButtonTypeWhen

        public int getShowDropButtonTypeWhen() / public void setShowDropButtonTypeWhen(int value)
        
        Specifies the symbol displayed on the drop button The value of the property is ShowDropButtonType integer constant.
      • isEnabled/setEnabled

        public boolean isEnabled() / public void setEnabled(boolean value)
        
        Indicates whether the control can receive the focus and respond to user-generated events.
      • isLocked/setLocked

        public boolean isLocked() / public void setLocked(boolean value)
        
        Indicates whether data in the control is locked for editing.
      • isTransparent/setTransparent

        public boolean isTransparent() / public void setTransparent(boolean value)
        
        Indicates whether the control is transparent.
      • isAutoSize/setAutoSize

        public boolean isAutoSize() / public void setAutoSize(boolean value)
        
        Indicates whether the control will automatically resize to display its entire contents.
      • getIMEMode/setIMEMode

        public int getIMEMode() / public void setIMEMode(int 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

        public Font getFont()
        
        Represents the font of the control.
      • getTextAlign/setTextAlign

        public int getTextAlign() / public void setTextAlign(int value)
        
        Represents how to align the text used by the control. The value of the property is TextAlignmentType integer constant.
      • getData

        public byte[] getData()
        
        Gets and sets the binary data of the control.
      • getWidth/setWidth

        public double getWidth() / public void setWidth(double value)
        
        Gets and sets the width of the control in unit of points.
      • getHeight/setHeight

        public double getHeight() / public void setHeight(double value)
        
        Gets and sets the height of the control in unit of points.
      • getMouseIcon/setMouseIcon

        public byte[] getMouseIcon() / public void setMouseIcon(byte[] value)
        
        Gets and sets a custom icon to display as the mouse pointer for the control.
      • getMousePointer/setMousePointer

        public int getMousePointer() / public void setMousePointer(int 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

        public int getForeOleColor() / public void setForeOleColor(int value)
        
        Gets and sets the ole color of the foreground. Not applies to Image control.
      • getBackOleColor/setBackOleColor

        public int getBackOleColor() / public void setBackOleColor(int value)
        
        Gets and sets the ole color of the background.
      • isVisible/setVisible

        public boolean isVisible() / public void setVisible(boolean value)
        
        Indicates whether this control is visible.
      • getShadow/setShadow

        public boolean getShadow() / public void setShadow(boolean value)
        
        Indicates whether to show a shadow.
      • getLinkedCell/setLinkedCell

        public java.lang.String getLinkedCell() / public void setLinkedCell(java.lang.String value)
        
        Gets and sets the linked cell.
      • getListFillRange/setListFillRange

        public java.lang.String getListFillRange() / public void setListFillRange(java.lang.String value)
        
        Gets and sets the list fill range.

    setBorderStyle

    public voidsetBorderStyle(intvalue)
    
    Gets and set the type of border used by the control. The value of the property is ControlBorderType integer constant.

    setBorderOleColor

    public voidsetBorderOleColor(intvalue)
    
    Gets and sets the ole color of the background.

    setSpecialEffect

    public voidsetSpecialEffect(intvalue)
    
    Gets and sets the special effect of the control. The value of the property is ControlSpecialEffectType integer constant.

    setMaxLength

    public voidsetMaxLength(intvalue)
    
    Gets and sets the maximum number of characters

    setScrollBars

    public voidsetScrollBars(intvalue)
    
    Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. The value of the property is ControlScrollBarType integer constant.

    setPasswordChar

    public voidsetPasswordChar(charvalue)
    
    Gets and sets a character to be displayed in place of the characters entered.

    setEditable

    public voidsetEditable(booleanvalue)
    
    Indicates whether the user can type into the control.

    setIntegralHeight

    public voidsetIntegralHeight(booleanvalue)
    
    Indicates whether the control will only show complete lines of text without showing any partial lines.

    setDragBehaviorEnabled

    public voidsetDragBehaviorEnabled(booleanvalue)
    
    Indicates whether dragging and dropping is enabled for the control.

    setEnterKeyBehavior

    public voidsetEnterKeyBehavior(booleanvalue)
    
    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.

    setEnterFieldBehavior

    public voidsetEnterFieldBehavior(booleanvalue)
    
    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.

    setTabKeyBehavior

    public voidsetTabKeyBehavior(booleanvalue)
    
    Indicates whether tab characters are allowed in the text of the control.

    setHideSelection

    public voidsetHideSelection(booleanvalue)
    
    Indicates whether selected text in the control appears highlighted when the control does not have focus.

    setAutoTab

    public voidsetAutoTab(booleanvalue)
    
    Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.

    setMultiLine

    public voidsetMultiLine(booleanvalue)
    
    Indicates whether the control can display more than one line of text.

    setAutoWordSelected

    public voidsetAutoWordSelected(booleanvalue)
    
    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.

    setWordWrapped

    public voidsetWordWrapped(booleanvalue)
    
    Indicates whether the contents of the control automatically wrap at the end of a line.

    setText

    public voidsetText(java.lang.Stringvalue)
    
    Gets and set text of the control.

    setDropButtonStyle

    public voidsetDropButtonStyle(intvalue)
    
    Specifies the symbol displayed on the drop button The value of the property is DropButtonStyle integer constant.

    setShowDropButtonTypeWhen

    public voidsetShowDropButtonTypeWhen(intvalue)
    
    Specifies the symbol displayed on the drop button The value of the property is ShowDropButtonType integer constant.

    setEnabled

    public voidsetEnabled(booleanvalue)
    
    Indicates whether the control can receive the focus and respond to user-generated events.

    setLocked

    public voidsetLocked(booleanvalue)
    
    Indicates whether data in the control is locked for editing.

    setTransparent

    public voidsetTransparent(booleanvalue)
    
    Indicates whether the control is transparent.

    setAutoSize

    public voidsetAutoSize(booleanvalue)
    
    Indicates whether the control will automatically resize to display its entire contents.

    setIMEMode

    public voidsetIMEMode(intvalue)
    
    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.

    setTextAlign

    public voidsetTextAlign(intvalue)
    
    Represents how to align the text used by the control. The value of the property is TextAlignmentType integer constant.

    setWidth

    public voidsetWidth(doublevalue)
    
    Gets and sets the width of the control in unit of points.

    setHeight

    public voidsetHeight(doublevalue)
    
    Gets and sets the height of the control in unit of points.

    setMouseIcon

    public voidsetMouseIcon(byte[]value)
    
    Gets and sets a custom icon to display as the mouse pointer for the control.

    setMousePointer

    public voidsetMousePointer(intvalue)
    
    Gets and sets the type of icon displayed as the mouse pointer for the control. The value of the property is ControlMousePointerType integer constant.

    setForeOleColor

    public voidsetForeOleColor(intvalue)
    
    Gets and sets the ole color of the foreground. Not applies to Image control.

    setBackOleColor

    public voidsetBackOleColor(intvalue)
    
    Gets and sets the ole color of the background.

    setVisible

    public voidsetVisible(booleanvalue)
    
    Indicates whether this control is visible.

    setShadow

    public voidsetShadow(booleanvalue)
    
    Indicates whether to show a shadow.

    setLinkedCell

    public voidsetLinkedCell(java.lang.Stringvalue)
    
    Gets and sets the linked cell.

    setListFillRange

    public voidsetListFillRange(java.lang.Stringvalue)
    
    Gets and sets the list fill range.