MiniToolbarValueEditor Object


Description

The MiniToolbarValueEditor object represents a value edit control within a MiniToolbar.

Methods

Name Description
Delete Method that deletes the control.
SetFocus Method that sets the focus on this control and highlights the current content of the value editor.

Properties

Name Description
AllowMeasure Read-write property that gets and sets whether to provide the ‘Measure’ command in the fly-out and right click context menus of the value editor.
AllowShowDimensions Read-write property that gets and sets whether to provide the ‘Show Dimensions’ command in the fly-out and right click context menus of the value editor.
AllowToleranceEdit Read-write property that gets and sets whether to provide the ‘Tolerance...’ command in the fly-out and right click context menus of the value editor.
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.
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.
CanValueBeEqualToMaximumValue Read-write property that gets and sets whether the maximum value is valid value or not.
CanValueBeEqualToMinimumValue Read-write property that gets and sets whether the minimum value is valid value or not.
ControlType Read-only property that returns the control type.
DefaultUnits Read-write property that gets and sets the default units for the value editor. If the Expression includes string that has no units specified, the units of this property will be used to calculate the value.
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.
Expression Read-write property that gets and sets the current, unevaluated content of the value editor.
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.
IsExpressionValid Read-only property that returns whether the current content of the value editor evaluates to a valid value based on the specified units, and that the evaluated value is within the range of values, if specified. The range of values can be specified using MaximumValue and MinimumValue properties. If the current content is invalid, the text in the control is displayed in red.
LargeIcon Read-write property that gets and sets the large icon for the control.
MaximumValue Read-write property that gets and sets the maximum valid value for this control in database units.
MinimumValue Read-write property that gets and sets the minimum valid value for this control in database units.
ModelValueType Read-write property that gets and sets the model value type.
MostRecentValues Read-write property that gets and sets an array of strings representing the most recent values associated with this control.
Parent Gets the parent object from whom this object can logically be reached.
Precision Read-write property that gets and sets number of decimal places to be used when displaying the parameter associated with this control.
StandardIcon Read-write property that gets and sets the standard (small) icon for the control.
Tolerance Read-only property that returns a Tolerance object containing tolerance values for the parameter associated with this control. This property is applicable only if the AllowToleranceEdit property is set to True. Use this property to set the default values for the tolerance dialog and to query the values set by the user.
ToolTipText Read-write property that gets and sets the tooltip text for the control.
Type Returns an ObjectTypeEnum indicating this object's type.
UnitsType Read-only property that returns the units type assigned to the control during creation.
Value Read-write property that gets and sets the evaluated value of the current expression in database units.
Visible Read-write property that gets and sets whether the control is visible.
Width Read-write property that gets and sets the width of the control (in pixels).

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.

Accessed From

MiniToolbarControls.AddValueEditor

Version

Introduced in version 2012