CommandControl Object


Description

A CommandControl object represents a user interface control (button, combobox, split button, etc.).

Methods

Name Description
Delete Method that deletes the CommandControl. This simply removes the control from the panel, but does not delete the underlying ControlDefinition(s).

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.
ChildControls Property that returns a CommandControls collection object that provides access to the child controls of this control.
ControlDefinition Property that returns the ControlDefinition associated with this control.
ControlType Property that returns the control type.
DisplayedControl Gets and sets the current ControlDefinition object for kButtonPopupControl, kPopupControl, kSplitButtonMRUControl and kSplitButtonControl control types. For other control types, this property returns Nothing.
DisplayName Property that returns the display name of the control.
InternalName Property that returns the unique internal name of the control.
KeyTip Gets and sets the keyboard access key for the control.
Parent Property that returns the parent object. This can either be a RibbonPanel object if the control resides within a panel, or the UserInterfaceManager object if the control resides elsewhere (Quick Access Toolbar, etc.).
ShowText Gets and sets whether to display the text (display name) associated with the control. The 'Ribbon Appearance' user choice overrides this setting.
Type Returns an ObjectTypeEnum indicating this object's type.
UseLargeIcon Gets and sets whether to display the control in the larger size. The 'Ribbon Appearance' user choice overrides this setting.
Visible Gets and sets whether this control is currently visible in the ribbon.

Accessed From

CommandControls.AddButton, CommandControls.AddButtonPopup, CommandControls.AddComboBox, CommandControls.AddCopy, CommandControls.AddGallery, CommandControls.AddMacro, CommandControls.AddPopup, CommandControls.AddSeparator, CommandControls.AddSplitButton, CommandControls.AddSplitButtonMRU, CommandControls.AddTogglePopup, CommandControls.Item, CommandControlsEnumerator.Item

Samples

Name Description
Print information about all available ribbons. This sample prints out all of the elements of the ribbons. This output is very useful when customizing the ribbon to be able to get the names of the various existing ribbons, tabs, and panels.

Version

Introduced in version 2010