TextBoxActiveXControl class

TextBoxActiveXControl class

Represents a text box ActiveX control.

Inheritance: TextBoxActiveXControl

The TextBoxActiveXControl type exposes the following members:

Properties

PropertyDescription
workbook
typeGets the type of the ActiveX control.
width
height
mouse_icon
mouse_pointer
fore_ole_color
back_ole_color
is_visible
shadow
linked_cell
list_fill_range
data
is_enabled
is_locked
is_transparent
is_auto_size
ime_mode
font
text_align
border_styleGets and set the type of border used by the control.
border_ole_colorGets and sets the ole color of the background.
special_effectGets and sets the special effect of the control.
max_lengthGets and sets the maximum number of characters
scroll_barsIndicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
password_charGets and sets a character to be displayed in place of the characters entered.
is_editableIndicates whether the user can type into the control.
integral_heightIndicates whether the control will only show complete lines of text without showing any partial lines.
is_drag_behavior_enabledIndicates whether dragging and dropping is enabled for the control.
enter_key_behaviorSpecifies 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.
enter_field_behaviorSpecifies 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.
tab_key_behaviorIndicates whether tab characters are allowed in the text of the control.
hide_selectionIndicates whether selected text in the control appears highlighted when the control does not have focus.
is_auto_tabIndicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
is_multi_lineIndicates whether the control can display more than one line of text.
is_auto_word_selectedSpecifies 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.
is_word_wrappedIndicates whether the contents of the control automatically wrap at the end of a line.
textGets and set text of the control.
drop_button_styleSpecifies the symbol displayed on the drop button
show_drop_button_type_whenSpecifies the symbol displayed on the drop button

Example

from aspose import pycore
from aspose.cells import Workbook
from aspose.cells.drawing.activexcontrols import ControlType, TextBoxActiveXControl

# Initialize a new workbook.
book = Workbook()
# Add a TextBoxActiveXControl.
shape = book.worksheets[0].shapes.add_active_x_control(ControlType.TEXT_BOX, 1, 0, 1, 0, 100, 50)
activeXControl = pycore.cast(TextBoxActiveXControl, shape.active_x_control)
# do your business
# Save the excel file.
book.save("exmaple.xlsx")

See Also