TextBoxActiveXControl (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.ActiveXControlBase
- - com.aspose.cells.ActiveXControl
  - - com.aspose.cells.TextBoxActiveXControl

public class TextBoxActiveXControl
extends ActiveXControl

Represents a text box ActiveX control.

Example

 
         //Initialize a new workbook.
         Workbook book = new Workbook();
 
         //Add a TextBoxActiveXControl.
         Shape shape = book.getWorksheets().get(0).getShapes().addActiveXControl(ControlType.TEXT_BOX, 1, 0, 1, 0, 100, 50);
         TextBoxActiveXControl activeXControl = (TextBoxActiveXControl)shape.getActiveXControl();
 
         //do your business
 
         //Save the excel file.
         book.save("exmaple.xlsx");

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getBorderOleColor()` Gets the ole color of the background.
`int`	`getBorderStyle()` Gets the type of border used by the control.
`int`	`getDropButtonStyle()` Specifies the symbol displayed on the drop button
`boolean`	`getEnterFieldBehavior()` Specifies selection behavior when entering the control.
`boolean`	`getEnterKeyBehavior()` Specifies the behavior of the ENTER key.
`boolean`	`getHideSelection()` Indicates whether selected text in the control appears highlighted when the control does not have focus.
`boolean`	`getIntegralHeight()` Indicates whether the control will only show complete lines of text without showing any partial lines.
`int`	`getMaxLength()` Gets the maximum number of characters
`char`	`getPasswordChar()` Gets a character to be displayed in place of the characters entered.
`int`	`getScrollBars()` Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
`int`	`getShowDropButtonTypeWhen()` Specifies the symbol displayed on the drop button
`int`	`getSpecialEffect()` Gets the special effect of the control.
`boolean`	`getTabKeyBehavior()` Indicates whether tab characters are allowed in the text of the control.
`java.lang.String`	`getText()` Gets text of the control.
`int`	`getType()` Gets the type of the ActiveX control.
`boolean`	`isAutoTab()` Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
`boolean`	`isAutoWordSelected()` Specifies the basic unit used to extend a selection.
`boolean`	`isDragBehaviorEnabled()` Indicates whether dragging and dropping is enabled for the control.
`boolean`	`isEditable()` Indicates whether the user can type into the control.
`boolean`	`isMultiLine()` Indicates whether the control can display more than one line of text.
`boolean`	`isWordWrapped()` Indicates whether the contents of the control automatically wrap at the end of a line.
`void`	`setAutoTab(boolean value)` Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
`void`	`setAutoWordSelected(boolean value)` Specifies the basic unit used to extend a selection.
`void`	`setBorderOleColor(int value)` Sets the ole color of the background.
`void`	`setBorderStyle(int value)` Sets the type of border used by the control.
`void`	`setDragBehaviorEnabled(boolean value)` Indicates whether dragging and dropping is enabled for the control.
`void`	`setDropButtonStyle(int value)` Specifies the symbol displayed on the drop button
`void`	`setEditable(boolean value)` Indicates whether the user can type into the control.
`void`	`setEnterFieldBehavior(boolean value)` Specifies selection behavior when entering the control.
`void`	`setEnterKeyBehavior(boolean value)` Specifies the behavior of the ENTER key.
`void`	`setHideSelection(boolean value)` Indicates whether selected text in the control appears highlighted when the control does not have focus.
`void`	`setIntegralHeight(boolean value)` Indicates whether the control will only show complete lines of text without showing any partial lines.
`void`	`setMaxLength(int value)` Sets the maximum number of characters
`void`	`setMultiLine(boolean value)` Indicates whether the control can display more than one line of text.
`void`	`setPasswordChar(char value)` Sets a character to be displayed in place of the characters entered.
`void`	`setScrollBars(int value)` Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
`void`	`setShowDropButtonTypeWhen(int value)` Specifies the symbol displayed on the drop button
`void`	`setSpecialEffect(int value)` Sets the special effect of the control.
`void`	`setTabKeyBehavior(boolean value)` Indicates whether tab characters are allowed in the text of the control.
`void`	`setText(java.lang.String value)` Sets text of the control.
`void`	`setWordWrapped(boolean value)` Indicates whether the contents of the control automatically wrap at the end of a line.

Methods inherited from class com.aspose.cells.ActiveXControl
getData, getFont, getIMEMode, getTextAlign, isAutoSize, isEnabled, isLocked, isTransparent, setAutoSize, setEnabled, setIMEMode, setLocked, setTextAlign, setTransparent

Methods inherited from class com.aspose.cells.ActiveXControlBase
getBackOleColor, getForeOleColor, getHeight, getLinkedCell, getListFillRange, getMouseIcon, getMousePointer, getShadow, getWidth, getWorkbook, isVisible, setBackOleColor, setForeOleColor, setHeight, setLinkedCell, setListFillRange, setMouseIcon, setMousePointer, setShadow, setVisible, setWidth

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getType
```
public int getType()
```
    Gets the type of the ActiveX control.
    See ControlType.
    
    Example
```
 
         /*Aspose.Cells.Drawing.ActiveXControls.ControlType*/int type = activeXControl.getType();
 
```
    Specified by:
    
    getType in class ActiveXControlBase
  - getBorderStyle
```
public int getBorderStyle()
```
    Gets the type of border used by the control.
    See ControlBorderType.
    
    Example
```
 
         activeXControl.setBorderStyle(com.aspose.cells.ControlBorderType.SINGLE);
 
```
  - setBorderStyle
```
public void setBorderStyle(int value)
```
    Sets the type of border used by the control.
    See ControlBorderType.
  - getBorderOleColor
```
public int getBorderOleColor()
```
    Gets the ole color of the background.
    Example
```
 
         //excel default color system 12 or green(0x0000FF00)
         activeXControl.setBorderOleColor(/*unchecked*/((int)0x80000012L));
 
```
  - setBorderOleColor
```
public void setBorderOleColor(int value)
```
    Sets the ole color of the background.
  - getSpecialEffect
```
public int getSpecialEffect()
```
    Gets the special effect of the control.
    See ControlSpecialEffectType.
    
    Example
```
 
         activeXControl.setSpecialEffect(com.aspose.cells.ControlSpecialEffectType.BUMP);
 
```
  - setSpecialEffect
```
public void setSpecialEffect(int value)
```
    Sets the special effect of the control.
    See ControlSpecialEffectType.
  - getMaxLength
```
public int getMaxLength()
```
    Gets the maximum number of characters
    Example
```
 
         if(activeXControl.getMaxLength() == 0)
         {
             activeXControl.setMaxLength(30);
         }
 
```
  - setMaxLength
```
public void setMaxLength(int value)
```
    Sets the maximum number of characters
  - getScrollBars
```
public int getScrollBars()
```
    Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
    See ControlScrollBarType.
    
    Example
```
 
         activeXControl.setScrollBars(com.aspose.cells.ControlScrollBarType.BARS_VERTICAL);
 
```
  - setScrollBars
```
public void setScrollBars(int value)
```
    Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
    See ControlScrollBarType.
  - getPasswordChar
```
public char getPasswordChar()
```
    Gets a character to be displayed in place of the characters entered.
    Example
```
 
         activeXControl.setPasswordChar('a');
 
```
  - setPasswordChar
```
public void setPasswordChar(char value)
```
    Sets a character to be displayed in place of the characters entered.
  - isEditable
```
public boolean isEditable()
```
    Indicates whether the user can type into the control.
    Example
```
 
         if(!activeXControl.isEditable())
         {
             activeXControl.setEditable(true);
         }
 
```
  - setEditable
```
public void setEditable(boolean value)
```
    Indicates whether the user can type into the control.
  - getIntegralHeight
```
public boolean getIntegralHeight()
```
    Indicates whether the control will only show complete lines of text without showing any partial lines.
    Example
```
 
         if(!activeXControl.getIntegralHeight())
         {
             activeXControl.setIntegralHeight(true);
         }
 
```
  - setIntegralHeight
```
public void setIntegralHeight(boolean value)
```
    Indicates whether the control will only show complete lines of text without showing any partial lines.
  - isDragBehaviorEnabled
```
public boolean isDragBehaviorEnabled()
```
    Indicates whether dragging and dropping is enabled for the control.
    Example
```
 
         if(!activeXControl.isDragBehaviorEnabled())
         {
             activeXControl.setDragBehaviorEnabled(true);
         }
 
```
  - setDragBehaviorEnabled
```
public void setDragBehaviorEnabled(boolean value)
```
    Indicates whether dragging and dropping is enabled for the control.
  - getEnterKeyBehavior
```
public boolean 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.
    Example
```
 
         if(!activeXControl.getEnterKeyBehavior())
         {
             activeXControl.setEnterKeyBehavior(true);
         }
 
```
  - setEnterKeyBehavior
```
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
```
public boolean 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.
    Example
```
 
         if(!activeXControl.getEnterFieldBehavior())
         {
             activeXControl.setEnterFieldBehavior(true);
         }
 
```
  - setEnterFieldBehavior
```
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
```
public boolean getTabKeyBehavior()
```
    Indicates whether tab characters are allowed in the text of the control.
    Example
```
 
         if(!activeXControl.getTabKeyBehavior())
         {
             activeXControl.setTabKeyBehavior(true);
         }
 
```
  - setTabKeyBehavior
```
public void setTabKeyBehavior(boolean value)
```
    Indicates whether tab characters are allowed in the text of the control.
  - getHideSelection
```
public boolean getHideSelection()
```
    Indicates whether selected text in the control appears highlighted when the control does not have focus.
    Example
```
 
         if(!activeXControl.getHideSelection())
         {
             activeXControl.setHideSelection(true);
         }
 
```
  - setHideSelection
```
public void setHideSelection(boolean value)
```
    Indicates whether selected text in the control appears highlighted when the control does not have focus.
  - isAutoTab
```
public boolean isAutoTab()
```
    Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
    Example
```
 
         if(!activeXControl.isAutoTab())
         {
             activeXControl.setAutoTab(true);
         }
 
```
  - setAutoTab
```
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
```
public boolean isMultiLine()
```
    Indicates whether the control can display more than one line of text.
    Example
```
 
         if(!activeXControl.isMultiLine())
         {
             activeXControl.setMultiLine(true);
         }
 
```
  - setMultiLine
```
public void setMultiLine(boolean value)
```
    Indicates whether the control can display more than one line of text.
  - isAutoWordSelected
```
public boolean 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.
    Example
```
 
         if(!activeXControl.isAutoWordSelected())
         {
             activeXControl.setAutoWordSelected(true);
         }
 
```
  - setAutoWordSelected
```
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
```
public boolean isWordWrapped()
```
    Indicates whether the contents of the control automatically wrap at the end of a line.
    Example
```
 
         if(!activeXControl.isWordWrapped())
         {
             activeXControl.setWordWrapped(true);
         }
 
```
  - setWordWrapped
```
public void setWordWrapped(boolean value)
```
    Indicates whether the contents of the control automatically wrap at the end of a line.
  - getText
```
public java.lang.String getText()
```
    Gets text of the control.
    Example
```
 
         activeXControl.setText("This is a test.");
 
```
  - setText
```
public void setText(java.lang.String value)
```
    Sets text of the control.
  - getDropButtonStyle
```
public int getDropButtonStyle()
```
    Specifies the symbol displayed on the drop button
    See DropButtonStyle.
    
    Example
```
 
         activeXControl.setDropButtonStyle(com.aspose.cells.DropButtonStyle.ARROW);
 
```
  - setDropButtonStyle
```
public void setDropButtonStyle(int value)
```
    Specifies the symbol displayed on the drop button
    See DropButtonStyle.
  - getShowDropButtonTypeWhen
```
public int getShowDropButtonTypeWhen()
```
    Specifies the symbol displayed on the drop button
    See ShowDropButtonType.
    
    Example
```
 
         activeXControl.setShowDropButtonTypeWhen(com.aspose.cells.ShowDropButtonType.FOCUS);
 
```
  - setShowDropButtonTypeWhen
```
public void setShowDropButtonTypeWhen(int value)
```
    Specifies the symbol displayed on the drop button
    See ShowDropButtonType.

Class TextBoxActiveXControl

Method Summary

Methods inherited from class com.aspose.cells.ActiveXControl

Methods inherited from class com.aspose.cells.ActiveXControlBase

Methods inherited from class java.lang.Object

Method Detail

getType

getBorderStyle

setBorderStyle

getBorderOleColor

setBorderOleColor

getSpecialEffect

setSpecialEffect

getMaxLength

setMaxLength

getScrollBars

setScrollBars

getPasswordChar

setPasswordChar

isEditable

setEditable

getIntegralHeight

setIntegralHeight

isDragBehaviorEnabled

setDragBehaviorEnabled

getEnterKeyBehavior

setEnterKeyBehavior

getEnterFieldBehavior

setEnterFieldBehavior

getTabKeyBehavior

setTabKeyBehavior

getHideSelection

setHideSelection

isAutoTab

setAutoTab

isMultiLine

setMultiLine

isAutoWordSelected

setAutoWordSelected

isWordWrapped

setWordWrapped

getText

setText

getDropButtonStyle

setDropButtonStyle

getShowDropButtonTypeWhen

setShowDropButtonTypeWhen