RibbonPanel Object


Description

A RibbonPanel object represents a panel within a ribbon tab.

Methods

Name Description
Delete Method that deletes the RibbonPanel.
Move Method that moves the ribbon panel. If the panel is docked, calling this method automatically undocks the panel and honors the input values.
Reposition Method that moves the RibbonPanel to a new location within the ribbon tab.

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.
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}".
CommandControls Property that returns the CommandControls collection object that provides access to all the visible controls within the panel.
DisplayName Property that returns the display name of the ribbon panel.
Docked
InternalName Property that returns the unique internal name of the ribbon panel.
Parent Property that returns the parent RibbonTab object.
SlideoutControls Property that returns the CommandControls collection object that provides access to all controls in the slideout section of the panel.

SlideOutKeyTip
Type Returns an ObjectTypeEnum indicating this object's type.
Visible

Accessed From

RibbonPanels.Add, RibbonPanels.Item

Samples

Name Description
Add parallel environment with contextual tabs The following sample demonstrates the use of parallel environments and contextual ribbon tabs.
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.
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