MiniToolbarTextBox Object


Description

The MiniToolbarTextBox object represents a text box control within a MiniToolbar.

Methods

Name Description
AddItem Adds an item to the control.
AddSeparator Adds a separator to this control.
Clear Removes all the items from the control.
Delete Method that deletes the control.
RemoveItem Removes the specified item from the control.
SetFocus Sets the focus on this control and highlights the current content of the value editor.

Properties

Name Description
Application Gets the root Application object. Where the property is weakly-typed, it can be set to (QueryInterfaced for) 'Application' when running with Inventor whereas, 'ApprenticeServer' when running with the Apprentice Server.
AutoHide Read-write property that gets and sets whether the control should be automatically hidden when the user moves the cursor away from the MiniToolbar.
BackgroundColor Gets and sets the color of the background of the text box.
ControlType Read-only property that returns the control type.
Count Returns the number of items in the text box list.
DisplayName Read-write property that gets and sets the display name for the control.
Enabled Read-write property that gets and sets whether the control is enabled.
Index Read-only property that returns the index this control is currently positioned at within the mini toolbar.
InternalName Read-only property that returns a string uniquely identifying this control within the toolbar.
IsTextAcceptable Gets and sets whether the text in the text box is acceptable.
Item Returns the MiniToolbarListItem of the specified item from the text box list.
LargeIcon Read-write property that gets and sets the large icon for the control.
Parent Gets the parent object from whom this object can logically be reached.
SelectedIndex Gets and sets the index of the item currently selected.
SelectedItem Returns the item currently selected.
SelectionEndPosition Returns the position of the selected characters end position in the text box.
SelectionStartPosition Returns the position of the selected characters start position in the text box.
ShowIcon Gets and sets whether the icon associated with the currently selected item should be displayed on the face of the control.
StandardIcon Read-write property that gets and sets the standard (small) icon for the control.
Text Gets and sets the text displayed in the text box.
TextColor Gets and sets the color of the text in the text box.
ToolTipText Read-write property that gets and sets the tooltip text for the control.
Type Gets the constant that indicates the type of this object.
Visible Read-write property that gets and sets whether the control is visible.

Events

Name Description
OnChange Event that is fired when the content of the value editor is changed by the user.
OnEnter Event that is fired just before the control gets focus.
OnExit Event that is fired just before the control loses focus.
OnItemHoverEnd Event that is fired when the user stops hovering over an item in the drop down in the expanded state.
OnItemHoverStart Event that is fired when the user starts to hover over an item in the drop down in the expanded state.
OnItemRemove Event that is fired when the user removes an item from the drop down.
OnSelect Event that is fired soon after the user changes the currently selected item using the drop down.

Version

Introduced in version 2018