Share

RibbonTab Object


Description

A RibbonTab object represents a tab within a ribbon.

Methods

Name Description
Delete Method that deletes the RibbonTab.

Properties

Name Description
Active Gets and sets whether this tab is currently active. Setting this property returns an error if the parent ribbon is not active.
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.
ClientId Property that returns the string that uniquely identifies the client. This is the CLSID of the AddIn in a string form, e.g. "{C9A6C580-3817-11D0-BE4E-080036E87B02}".
Contextual Gets and sets whether this tab is contextual.
DisplayName Property that returns the display name of the ribbon tab.
InternalName Property that returns the unique internal name of the ribbon tab.
KeyTip Gets and sets the keyboard access key for the tab.
Parent Property that returns the parent Ribbon object.
RibbonPanels Property that returns the RibbonPanels collection object.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible Gets and sets whether the ribbon tab is currently visible in the ribbon. Note that this property applies only when the parent ribbon is active.

Accessed From

RibbonPanel.Parent, RibbonTabs.Add, RibbonTabs.Item

Samples

Name Description
Add parallel environment with contextual tabs The following sample demonstrates the use of parallel environments and contextual ribbon tabs.
Creation of an override environment for a document A new ribbon tab is created and associated with the override environment.
Create a ribbon panel in an existing tab Demonstrates creating a new ribbon panel within an existing ribbon tab.

Version

Introduced in version 2010

Was this information helpful?