ComboBoxDefinition Object


Description

The ComboBoxDefinition object represents any command whose user interface is a combo box.

Methods

Name Description
AddItem Adds Item to ComboBox.
AutoAddToGUI Adds it to AddIn Toolbar.
Clear Clear the ComboBox Definition.
Delete Method that deletes the UIDefinition Object.
Execute Executes this ControlDefinition object.
Execute2 Executes the ControlDefinition synchronously or asynchronously.
RemoveItem Removes specified item from the combo box list. The index is 1 based.

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.
BuiltIn Gets the BuiltIn status for a UIDefinition.
Classification Gets the classification.
ClientId Gets ClientID.
DefaultShortcut Gets/Sets the default (internal) shortcut assigned to the command. Setting this property fails for built-in ControlDefinitions.
DefaultShortcutType Gets the type of default shortcut assigned to this command. Possible return values are kNoShortcut (no shortcut has been assigned), kAcceleratorShortcut (a shortcut that directly launches the command), or kAliasShortcut (a command alias).
DefinitionType Gets the ControlDefinitionType.
DescriptionText Gets/Sets Description Text.
DisplayName Gets the Display Name.
DropDownWidth Gets/Sets DropDown Width.
Enabled Enables/Disables the UIDefinition object.
InternalName Gets the Internal Name.
IntroducedInVersion Read-write property that gets and sets the introduced in version of the control definition. The values from AvailableComparisonVersions can be used to set this property. This is read only if the control definition is built-in.
IsShortcutOverridden Gets whether the default (internal) shortcut has been overridden by the user or through the API.
LargeIcon Gets/Sets LargeIcon.
LastUpdatedVersion Read-write property that gets and sets the last updated version of the control definition. The values from AvailableComparisonVersions can be used to set this property. This is read only if the control definition is built-in.
ListCount Gets number of Items in the combo box list.
ListIndex Gets or sets 1 based index of selected item. Returns 0 if nothing is selected.
ListItem Gets the item specified in the combo box. The index is 1 based.
OverrideShortcut Gets/Sets the override shortcut assigned to the command. Setting this property to a null string clears the override.
OverrideShortcutType Gets the type of override shortcut assigned to this command. Possible return values are kNoShortcut (no shortcut has been assigned), kAcceleratorShortcut (a shortcut that directly launches the command), or kAliasShortcut (a command alias).
Parent Gets the parent object from whom this object can logically be reached.
ProgressiveToolTip Returns a ProgressiveToolTip object providing access to enhanced tooltip display for controls in the ribbon interface.
StandardIcon Gets/Sets StandardIcon.
Text Gets the Text from the display or edit portion of the combo box.
ToolTipText Gets/Sets Tooltip.
Type Returns an ObjectTypeEnum indicating this object's type.

Events

Name Description
OnHelp Fires signaling the client to present help for the associated command.
OnSelect Event that is fired when an end user changes the selection in the combo box or when the selection is changed using the ListIndex property. This event is not fired for built-in definitions.

Accessed From

ControlDefinitions.AddComboBoxDefinition

Version

Introduced in version 9