aspose.cells

Class TextBoxActiveXControl

Represents a text box ActiveX control.

Property Getters/Setters Summary
functiongetBackOleColor()
function
           Gets and sets the ole color of the background.
functiongetBorderOleColor()
function
           Gets and sets the ole color of the background.
functiongetBorderStyle()
function
           Gets and set the type of border used by the control. The value of the property is ControlBorderType integer constant.
functiongetData()
Gets and sets the binary data of the control.
functiongetDropButtonStyle()
function
           Specifies the symbol displayed on the drop button The value of the property is DropButtonStyle integer constant.
functiongetEnterFieldBehavior()
function
           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.
functiongetEnterKeyBehavior()
function
           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.
functiongetFont()
Represents the font of the control.
functiongetForeOleColor()
function
           Gets and sets the ole color of the foreground.
functiongetHeight()
function
setHeight(value)
           Gets and sets the height of the control in unit of points.
functiongetHideSelection()
function
           Indicates whether selected text in the control appears highlighted when the control does not have focus.
functiongetIMEMode()
function
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.
functiongetIntegralHeight()
function
           Indicates whether the control will only show complete lines of text without showing any partial lines.
functionisAutoSize()
function
           Indicates whether the control will automatically resize to display its entire contents.
functionisAutoTab()
function
setAutoTab(value)
           Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
functionisAutoWordSelected()
function
           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.
functionisDragBehaviorEnabled()
function
           Indicates whether dragging and dropping is enabled for the control.
functionisEditable()
function
           Indicates whether the user can type into the control.
functionisEnabled()
function
setEnabled(value)
           Indicates whether the control can receive the focus and respond to user-generated events.
functionisLocked()
function
setLocked(value)
           Indicates whether data in the control is locked for editing.
functionisMultiLine()
function
           Indicates whether the control can display more than one line of text.
functionisTransparent()
function
           Indicates whether the control is transparent.
functionisVisible()
function
setVisible(value)
           Indicates whether this control is visible.
functionisWordWrapped()
function
           Indicates whether the contents of the control automatically wrap at the end of a line.
functiongetLinkedCell()
function
           Gets and sets the linked cell.
functiongetListFillRange()
function
           Gets and sets the list fill range.
functiongetMaxLength()
function
           Gets and sets the maximum number of characters
functiongetMouseIcon()
function
           Gets and sets a custom icon to display as the mouse pointer for the control.
functiongetMousePointer()
function
           Gets and sets the type of icon displayed as the mouse pointer for the control. The value of the property is ControlMousePointerType integer constant.
functiongetPasswordChar()
function
           Gets and sets a character to be displayed in place of the characters entered.
functiongetScrollBars()
function
           Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. The value of the property is ControlScrollBarType integer constant.
functiongetShadow()
function
setShadow(value)
           Indicates whether to show a shadow.
functiongetShowDropButtonTypeWhen()
function
           Specifies the symbol displayed on the drop button The value of the property is ShowDropButtonType integer constant.
functiongetSpecialEffect()
function
           Gets and sets the special effect of the control. The value of the property is ControlSpecialEffectType integer constant.
functiongetTabKeyBehavior()
function
           Indicates whether tab characters are allowed in the text of the control.
functiongetText()
function
setText(value)
           Gets and set text of the control.
functiongetTextAlign()
function
           Represents how to align the text used by the control. The value of the property is TextAlignmentType integer constant.
functiongetType()
Gets the type of the ActiveX control. The value of the property is ControlType integer constant.
functiongetWidth()
function
setWidth(value)
           Gets and sets the width of the control in unit of points.
functiongetWorkbook()
Gets the Workbook object.
 

    • Property Getters/Setters Detail

      • getType : Number 

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

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

        function getBorderOleColor() / function setBorderOleColor(value)
        
        Gets and sets the ole color of the background.
      • getSpecialEffect/setSpecialEffect : Number 

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

        function getMaxLength() / function setMaxLength(value)
        
        Gets and sets the maximum number of characters
      • getScrollBars/setScrollBars : Number 

        function getScrollBars() / function 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 

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

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

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

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

        function getEnterKeyBehavior() / function 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 

        function getEnterFieldBehavior() / function 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 

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

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

        function isAutoTab() / function 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 

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

        function isAutoWordSelected() / function 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 

        function isWordWrapped() / function setWordWrapped(value)
        
        Indicates whether the contents of the control automatically wrap at the end of a line.
      • getText/setText : String 

        function getText() / function setText(value)
        
        Gets and set text of the control.
      • getDropButtonStyle/setDropButtonStyle : Number 

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

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

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

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

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

        function isAutoSize() / function setAutoSize(value)
        
        Indicates whether the control will automatically resize to display its entire contents.
      • getIMEMode/setIMEMode : Number 

        function getIMEMode() / function 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 

        function getFont()
        
        Represents the font of the control.
      • getTextAlign/setTextAlign : Number 

        function getTextAlign() / function setTextAlign(value)
        
        Represents how to align the text used by the control. The value of the property is TextAlignmentType integer constant.
      • getData : byte[] 

        function getData()
        
        Gets and sets the binary data of the control.
      • getWidth/setWidth : Number 

        function getWidth() / function setWidth(value)
        
        Gets and sets the width of the control in unit of points.
      • getHeight/setHeight : Number 

        function getHeight() / function setHeight(value)
        
        Gets and sets the height of the control in unit of points.
      • getMouseIcon/setMouseIcon : byte[] 

        function getMouseIcon() / function setMouseIcon(value)
        
        Gets and sets a custom icon to display as the mouse pointer for the control.
      • getMousePointer/setMousePointer : Number 

        function getMousePointer() / function 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 : Number 

        function getForeOleColor() / function setForeOleColor(value)
        
        Gets and sets the ole color of the foreground. Not applies to Image control.
      • getBackOleColor/setBackOleColor : Number 

        function getBackOleColor() / function setBackOleColor(value)
        
        Gets and sets the ole color of the background.
      • isVisible/setVisible : boolean 

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

        function getShadow() / function setShadow(value)
        
        Indicates whether to show a shadow.
      • getLinkedCell/setLinkedCell : String 

        function getLinkedCell() / function setLinkedCell(value)
        
        Gets and sets the linked cell.
      • getListFillRange/setListFillRange : String 

        function getListFillRange() / function setListFillRange(value)
        
        Gets and sets the list fill range.