Environment Object


Description

The Environment object represents any Autodesk Inventor environment. Example environments are Part, Assembly, Sketch, etc. The Environment represents the current state of an environment. See the UI customization and Environments overviews for more information.

Methods

Name Description
Delete Method that deletes the environment. This method will fail for built-in environments.
GetRadialMarkingMenu Returns the RadialMarkingMenu object that can be used to query and set the commands available in the radial menu for the input object type.

Properties

Name Description
AdditionalVisibleRibbonTabs
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 Property that specifies if the Environment a standard Autodesk Inventor Environment or if it has been added by a client. Built-in environments have restrictions in the edits that can be performed. For example, build-in environments cannot be deleted. For more information, see the Environments overview.
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}".
DefaultRibbonTab
DisabledCommandList Property that returns the DisabledCommandList object. This object allows the environment to disable commands when this environment is active. This list contains commands that are disabled in addition to those specified by the DisabledCommandTypes property.
DisabledCommandTypes
DisplayName
ExitDisplayName
InheritAllRibbonTabs
InternalName Property that indicates the name of the environment.
LargeIcon
Parent Property that returns the parent of the environment.
PreserveWhenSwitchModelState
RadialMarkingMenus Returns the RadialMarkingMenus object that can be used to query and set the selection based radial menu.
Ribbon Property that returns the Ribbon object associated with this environment. This property returns Nothing when the environment is initially created and not yet applied as an override or a parallel environment.
StandardIcon
Type Returns an ObjectTypeEnum indicating this object's type.

Accessed From

EnvironmentList.Item, EnvironmentManager.BaseEnvironment, EnvironmentManager.EditObjectEnvironment, EnvironmentManager.GetCurrentEnvironment, EnvironmentManager.OverrideEnvironment, Environments.Add, Environments.Item, PanelBar.Parent, UserInterfaceManager.ActiveEnvironment

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.

Version

Introduced in version 5