Share

ApplicationAddIn Object


Description

Object that represents an Application AddIn inside Autodesk Inventor.

Methods

Name Description
Activate Creates and initializes the AddIn. No effect if AddIn already active.
Deactivate Invokes the shutdown sequence on the AddIn. No effect if AddIn inactive.

Properties

Name Description
Activated Gets a Boolean flag indicating whether this AddIn is currently active in the session.
AddInType Gets the constant that indicates the type of this AddIn.
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.
Automation Property that returns the Add-in's automation interface (if any). Fails if the Add-in is currently inactive.
ClassIdString Gets the CLSID of the AddIn as the string used in the class moniker.
ClientId Property that returns a GUID in string format that uniquely identifies this Add-in. This GUID is used as an identifier when creating Add-in specific objects such as user interface elements, client features, etc.
DataVersion Gets and sets the current data version of the AddIn. This value corresponds to the 'Data Version' registry entry in the AddIn's registry hive.
Description Gets the description of the AddIn.
DisplayName Gets the displayable name of the AddIn.
Hidden Gets and sets whether the AddIn is hidden or not.
LicenseStatus Gets the license status of the AddIn.
LoadAutomatically Gets/Sets whether the add-in loads automatically based on the load behavior specified for the add-in. If set to False, the add-in needs to be manually loaded by the user.
LoadBehavior Gets a constant indicating the load behavior (load time) of the add-in. This applies only if the LoadAutomatically property is set to True.
Location Property that returns the full file name of the dll associated with this Add-in.
Parent Property that returns the parent Application object.
ProgId Gets the ProgID of the AddIn.
ShortDisplayName Property that returns the short display name of the Add-in. Used in places to succinctly identify the AddIn inside Inventor's UI.
Type Returns an ObjectTypeEnum indicating this object's type.
UserInterfaceVersion Property that returns the version of the user interface of the add-in. Incrementing this version results in all of the add-in"s UI getting cleaned up during Inventor start-up.
UserUnloadable Gets and sets whether the AddIn is allowed to be unloaded by the user.

Accessed From

ApplicationAddIns.Item, ApplicationAddIns.ItemById, ApplicationAddInSite.Parent

Derived Classes

TranslatorAddIn

Version

Introduced in version 4

Was this information helpful?