Aspose::Cells::Drawing::ActiveXControls::TextBoxActiveXControl class
Contents
[
Hide
]TextBoxActiveXControl class
Represents a text box ActiveX control.
class TextBoxActiveXControl : public Aspose::Cells::Drawing::ActiveXControls::ActiveXControl
Methods
| Method | Description |
|---|---|
| ActiveXControl(ActiveXControl_Impl* impl) | Constructs from an implementation object. |
| ActiveXControl(const ActiveXControl& src) | Copy constructor. |
| ActiveXControl(const ActiveXControlBase& src) | Constructs from a parent object. |
| ActiveXControlBase(ActiveXControlBase_Impl* impl) | Constructs from an implementation object. |
| ActiveXControlBase(const ActiveXControlBase& src) | Copy constructor. |
| GetBackOleColor() | Gets and sets the ole color of the background. |
| GetBorderOleColor() | Gets and sets the ole color of the background. |
| GetBorderStyle() | Gets and set the type of border used by the control. |
| GetData() | Gets and sets the binary data of the control. |
| GetDropButtonStyle() | Specifies the symbol displayed on the drop button. |
| 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. |
| 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. |
| GetFont() | Represents the font of the control. |
| GetForeOleColor() | Gets and sets the ole color of the foreground. |
| GetHeight() | Gets and sets the height of the control in unit of points. |
| GetHideSelection() | Indicates whether selected text in the control appears highlighted when the control does not have focus. |
| GetIMEMode() | Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus. |
| GetIntegralHeight() | Indicates whether the control will only show complete lines of text without showing any partial lines. |
| GetLinkedCell() | Gets and sets the linked cell. |
| GetListFillRange() | Gets and sets the list fill range. |
| GetMaxLength() | Gets and sets the maximum number of characters. |
| GetMouseIcon() | Gets and sets a custom icon to display as the mouse pointer for the control. |
| GetMousePointer() | Gets and sets the type of icon displayed as the mouse pointer for the control. |
| GetPasswordChar() | Gets and sets a character to be displayed in place of the characters entered. |
| GetScrollBars() | Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. |
| GetShadow() | Indicates whether to show a shadow. |
| GetShowDropButtonTypeWhen() | Specifies the symbol displayed on the drop button. |
| GetSpecialEffect() | Gets and sets the special effect of the control. |
| GetTabKeyBehavior() | Indicates whether tab characters are allowed in the text of the control. |
| GetText() | Gets and set text of the control. |
| GetTextAlign() | Represents how to align the text used by the control. |
| virtual GetType() | Gets the type of the ActiveX control. |
| GetWidth() | Gets and sets the width of the control in unit of points. |
| GetWorkbook() | Gets the Workbook object. |
| IsAutoSize() | Indicates whether the control will automatically resize to display its entire contents. |
| IsAutoTab() | Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters. |
| 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. |
| IsDragBehaviorEnabled() | Indicates whether dragging and dropping is enabled for the control. |
| IsEditable() | Indicates whether the user can type into the control. |
| IsEnabled() | Indicates whether the control can receive the focus and respond to user-generated events. |
| IsLocked() | Indicates whether data in the control is locked for editing. |
| IsMultiLine() | Indicates whether the control can display more than one line of text. |
| IsNull() const | Checks whether the implementation object is nullptr. |
| IsTransparent() | Indicates whether the control is transparent. |
| IsVisible() | Indicates whether this control is visible. |
| IsWordWrapped() | Indicates whether the contents of the control automatically wrap at the end of a line. |
| explicit operator bool() const | operator bool() |
| operator=(const TextBoxActiveXControl& src) | operator= |
| operator=(const ActiveXControl& src) | operator= |
| operator=(const ActiveXControlBase& src) | operator= |
| SetBackOleColor(int32_t value) | Gets and sets the ole color of the background. |
| SetBorderOleColor(int32_t value) | Gets and sets the ole color of the background. |
| SetBorderStyle(ControlBorderType value) | Gets and set the type of border used by the control. |
| SetDropButtonStyle(DropButtonStyle value) | Specifies the symbol displayed on the drop button. |
| SetEnterFieldBehavior(bool 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. |
| SetEnterKeyBehavior(bool 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. |
| SetForeOleColor(int32_t value) | Gets and sets the ole color of the foreground. |
| SetHeight(double value) | Gets and sets the height of the control in unit of points. |
| SetHideSelection(bool value) | Indicates whether selected text in the control appears highlighted when the control does not have focus. |
| SetIMEMode(InputMethodEditorMode value) | Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus. |
| SetIntegralHeight(bool value) | Indicates whether the control will only show complete lines of text without showing any partial lines. |
| SetIsAutoSize(bool value) | Indicates whether the control will automatically resize to display its entire contents. |
| SetIsAutoTab(bool value) | Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters. |
| SetIsAutoWordSelected(bool 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. |
| SetIsDragBehaviorEnabled(bool value) | Indicates whether dragging and dropping is enabled for the control. |
| SetIsEditable(bool value) | Indicates whether the user can type into the control. |
| SetIsEnabled(bool value) | Indicates whether the control can receive the focus and respond to user-generated events. |
| SetIsLocked(bool value) | Indicates whether data in the control is locked for editing. |
| SetIsMultiLine(bool value) | Indicates whether the control can display more than one line of text. |
| SetIsTransparent(bool value) | Indicates whether the control is transparent. |
| SetIsVisible(bool value) | Indicates whether this control is visible. |
| SetIsWordWrapped(bool value) | Indicates whether the contents of the control automatically wrap at the end of a line. |
| SetLinkedCell(const U16String& value) | Gets and sets the linked cell. |
| SetLinkedCell(const char16_t* value) | Gets and sets the linked cell. |
| SetListFillRange(const U16String& value) | Gets and sets the list fill range. |
| SetListFillRange(const char16_t* value) | Gets and sets the list fill range. |
| SetMaxLength(int32_t value) | Gets and sets the maximum number of characters. |
| SetMouseIcon(const Vector <uint8_t>& value) | Gets and sets a custom icon to display as the mouse pointer for the control. |
| SetMousePointer(ControlMousePointerType value) | Gets and sets the type of icon displayed as the mouse pointer for the control. |
| SetPasswordChar(char16_t value) | Gets and sets a character to be displayed in place of the characters entered. |
| SetScrollBars(ControlScrollBarType value) | Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. |
| SetShadow(bool value) | Indicates whether to show a shadow. |
| SetShowDropButtonTypeWhen(ShowDropButtonType value) | Specifies the symbol displayed on the drop button. |
| SetSpecialEffect(ControlSpecialEffectType value) | Gets and sets the special effect of the control. |
| SetTabKeyBehavior(bool value) | Indicates whether tab characters are allowed in the text of the control. |
| SetText(const U16String& value) | Gets and set text of the control. |
| SetText(const char16_t* value) | Gets and set text of the control. |
| SetTextAlign(TextAlignmentType value) | Represents how to align the text used by the control. |
| SetWidth(double value) | Gets and sets the width of the control in unit of points. |
| TextBoxActiveXControl(TextBoxActiveXControl_Impl* impl) | Constructs from an implementation object. |
| TextBoxActiveXControl(const TextBoxActiveXControl& src) | Copy constructor. |
| TextBoxActiveXControl(const ActiveXControl& src) | Constructs from a parent object. |
| ~ActiveXControl() | Destructor. |
| ~ActiveXControlBase() | Destructor. |
| ~TextBoxActiveXControl() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
Examples
Aspose::Cells::Startup();
//Initialize a new workbook.
Workbook book;
//Add a TextBoxActiveXControl.
Shape shape = book.GetWorksheets().Get(0).GetShapes().AddActiveXControl(ControlType::TextBox, 1, 0, 1, 0, 100, 50);
TextBoxActiveXControl activeXControl = (TextBoxActiveXControl)shape.GetActiveXControl();
//Save the excel file.
book.Save(u"exmaple.xlsx");
Aspose::Cells::Cleanup();
See Also
- Class ActiveXControl
- Namespace Aspose::Cells::Drawing::ActiveXControls
- Library Aspose.Cells for C++