Share

UserInterfaceManager Object


Description

The UserInterfaceManager object, through which all UI customization objects can be accessed. See Ribbon Customization for an overview.

Methods

Name Description
AllReferencedControls Method that returns all command controls in Inventor's ribbon interface that reference the input ControlDefinition. Controls from ribbons panels, Quick Access Toolbar and the File Browser (application menu) are returned.
DoEvents Allows Inventor to process all Windows messages currently in the message queue.
GetCommandPaths Method that returns all the paths that the given command is found in, optionally filtered to an environment.
ResetRibbonInterface Method that removes all customizations from the ribbon user interface.

Properties

Name Description
ActiveEnvironment Property that returns the Environment that is currently 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.
BalloonTips Read-only property that returns the BalloonTips collection object.
CapacityMeterEnabled Gets and sets whether to enable the capacity meter display in Inventor's status bar.
DockableWindows Property that returns the DockableWindows collection object.
Environments Property that returns the Environments collection object.
ExpertMode Gets/Sets the Boolean flag indicating whether the UI is in Expert mode.
FileBrowserControls Property that returns a CommandControls collection containing the controls in the File Browser (a.k.a Application Menu).
HelpControls Property that returns a CommandControls collection containing the controls in the Help Menu.
OverflowMenuBehavior Read-write property that gets and sets the behavior of the overflow menu.
ParallelEnvironments Property that returns the list of Environments valid for the edit target or the environment being switched to. Environments can be added to or removed from the list as seen appropriate by the client when an OnNewEditObject or an OnEnvironmentChange event is received. This list of environments will show in the Applications menu item. This list may only contain non-built-in environments.
Parent Property that returns the parent object from whom this object can logically be reached.
PinMiniToolbarPosition Read-only property that gets whether the MiniToolbar position is pinned or not.
RibbonAppearance Gets and sets the appearance of the ribbon.
RibbonDockingState Gets and sets the docking state of the ribbon.
Ribbons Property that returns the Ribbons collection object.
RibbonState Gets and sets the display state of the ribbon. Valid values are kFullRibbon, kMinimizeToTabs, kMinimizeToPanelTitles and kMinimizeToPanelButtons.
ShowBrowser Show/Hide Browser.
ShowCleanScreen Gets sets whether the viewed screen area is maximized.
ShowDocumentTabs Gets and sets whether document tabs are displayed.
ShowMarkingMenu Property that gets and sets whether to use the marking menu.
ShowNavigationBar Read-write property that gets and sets whether the navigation bar is displayed.
ShowQuickAccessControlsBelowRibbon Gets and sets whether the Quick Access Toolbar (QAT) is shown below or above the ribbon.
ShowStatusBar Show/Hide StatusBar.
ShowSteeringWheel Read-write property that gets and sets whether the steering wheel control is displayed.
ShowViewCube Read-write property that gets and sets whether the view cube is displayed.
Type Returns an ObjectTypeEnum indicating this object's type.
UserInteractionDisabled Enable/Disable user interaction.
UserInterfaceEvents Property returning the UserInterfaceEvents object.

Accessed From

Application.UserInterfaceManager, BalloonTip.Parent, DockableWindow.Parent, Ribbon.Parent, UserInterfaceEvents.Parent, WebBrowserDockableWindow.Parent

Samples

Name Description
Add commands to the application menu Demonstrates adding command to the application menu.
Add parallel environment with contextual tabs The following sample demonstrates the use of parallel environments and contextual ribbon tabs.
Dockable window This sample demonstrates creating a dockable window and adding a dialog into it.
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.

Version

Introduced in version 9

Was this information helpful?