MiniToolbar Object


Description

The MiniToolbar object provides the ability to create and display in-canvas controls for user interaction.

Methods

Name Description
Delete Method that deletes the MiniToolbar object.

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
Controls Read-only property that returns the MiniToolbarControls collection object.
EnableApply Read-write property that specifies whether the ‘Apply’ button is enabled.
EnableOK Read-write property that specifies whether the ‘OK’ button is enabled.
Height Read-only property that returns the height of the mini toolbar.
HWND Returns the HWND.
Parent Gets the parent object from whom this object can logically be reached.
Position Read-write property that gets and sets the view space point specifying the current position of the toolbar within the graphical window.
ShowApply Read-write property that gets and sets whether the toolbar should display the ‘Apply’ button (represented by a green plus symbol).
ShowCancel Read-write property that gets and sets whether the toolbar should display the ‘Cancel’ button (represented by a red ‘x’).
ShowHandle Read-write property that gets and sets whether the toolbar should display the handle which is used to move the minitoolbar.
ShowOK Read-write property that gets and sets whether the toolbar should display the OK button (represented by a green check mark).
ShowOptionBox Read-write property that gets and sets whether the toolbar should display the option box.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible Read-write property that gets and sets whether the toolbar is visible.
Width Read-only property that returns the width of the mini toolbar.

Events

Name Description
OnApply Event that fires when the ‘Apply’ button is clicked.
OnCancel Event that fires when the ‘Cancel’ button is clicked.
OnEndMove Event that fires when a drag or a reposition of this MiniToolbar ends.
OnHide Event that fires when this MiniToolbar is hidden.
OnMove Event that fires when this MiniToolbar moves as a result of a drag.
OnOK Event that fires when the ‘OK’ button is clicked.
OnShow Event that fires when this MiniToolbar is shown.
OnStartMove Event that fires when this MiniToolbar begins to move as a result of a drag or a reposition.

Accessed From

CommandManager.CreateMiniToolbar, InteractionEvents.CreateMiniToolbar, MiniToolbarButton.Parent, MiniToolbarCheckBox.Parent, MiniToolbarComboBox.Parent, MiniToolbarControl.Parent, MiniToolbarDropdown.Parent, MiniToolbarSlider.Parent, MiniToolbarTextBox.Parent, MiniToolbarTextEditor.Parent, MiniToolbarValueEditor.Parent

Version

Introduced in version 2012