Share

Application Object

Derived from: InventorServerObject Object

Description

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.

Methods

Name Description
ConstructInternalNameAndRevisionId Constructs and returns the Internal Name and Revision Identifier
CreateFactoryTableDialog Creates a Factory Table dialog.
CreateFileDialog Method that creates a new FileDialog object. The FileDialog object is similar to the Microsoft common dialog control and allows you to reuse the Inventor open and save dialogs.
CreateProgressBar Method that creates a new ProgressBar object. The progress bar is not immediately displayed. Calling the UpdateProgress method for the first time causes the bar to display.
ExportApplicationOptions Method that exports the Application Options to an XML file.
GetAppFrameExtents Obtains the position and size of the application's main frame window.
GetInterfaceObject Constructs and returns the IUnknown object for the specified ProgID or CLSID.
GetInterfaceObject32 In 32-bit Autodesk Inventor, this method always returns the same object as GetInterfaceObject.
GetMaterialXFromAsset Method that gets the MaterialX string from an Asset.
GetMDIClientAreaExtents Obtains the position and size of the Application's MDI client area.
ImportApplicationOptions Method that imports the Application Options from an XML file.
Move Method that moves the frame window.
Quit Shuts down the application.
RefreshRibbonForComparison Method that refreshes the ribbon controls display when the comparison is set.
ReserveLicense Informs Inventor/Apprentice that a license should be retained for this instance of the application. Used to prevent idle detection from returning the seat license to the license pool. Requires a call to UnreserveLicense with the same ClientID to allow license reclamation to resume.
UnreserveLicense Informs Inventor/Apprentice that normal seat license reclamation can resume. Use this method when extended processing for which a license was reserved completes. Do not use without a previous call to ReserveLicense using the same ClientID.
UseAutoCADRelatedSettings Method that sets the Application Options using AutoCAD related settings.
UseInventorSettings Method that sets the Application Options using Inventor Settings.

Properties

Name Description
ActiveAppearanceLibrary Read-write property that gets and sets the library whose contents is listed in the appearances drop-down list in the QAT (Quick Access Toolbar)_at the top of the Inventor window. The initial active appearance is defined by the active project. Using this property you can override the project appearance. When a new project is activated the active appearance will be determined by the activated project.
ActiveColorScheme Property that returns the ColorScheme that is currently active.
ActiveDocument Gets the active Document.
ActiveDocumentType Gets the type of the active document.
ActiveEditDocument Property that returns the current in-place editing document.
ActiveEditObject Gets the object that is currently open for edit within the Autodesk Inventor user interface.
ActiveMaterialLibrary Gets and sets the library whose contents is listed in the materials drop-down list in the QAT(Quick Access Toolbar) at the top of the Inventor window.
ActiveView Gets the active view.
ActiveViewFrame Read-only property that returns the active ViewFrame object.
ApplicationAddIns Property that returns the ApplicationAddIns object. This object provides access to the Add-Ins currently installed.
ApplicationEvents Property that returns the ApplicationEvents object. This object supports a set of events that are application-centric.
AssemblyEvents Property that returns the AssemblyEvents object. This object supports a set of events that are assembly centric.
AssemblyOptions Property that returns the AssemblyOptions object. The AssemblyOptions object provides access to various assembly related application level options. This is somewhat equivalent to the Assembly tab of the Application Options dialog.
AssetLibraries Gets AssetLibraries collection object. This collection provides access to the all of the appearance and material libraries.
AvailableComparisonVersions Read-only property that returns an array of strings indicating the versions can be used to compare the commands with selected version.
CameraEvents Gets the object that fires the Camera related events.
Caption Gets/Sets the caption on the Application's frame window.
ChangeManager Gets the ChangeManager object. The ChangeManager object manages the processes involved in making changes to data and recording the change process.
ClientOperationEvents Read-only property that returns the ClientOperationEvents object.
ClientResourceMaps Read-only property that returns ClientResourceMaps object.
ColorSchemes Property that returns the ColorSchemes object. The ColorSchemes object provides access to the color schemes. This is somewhat equivalent to the Colors tab of the Application Options dialog.
CommandManager Property that returns the CommandManager object.
ComparisonVersion Read-write property that gets and sets the comparison version for commands. When set a comparison version, the commands will show additional info against the version (like whether a command is introduced/updated later than the version). The AvailableComparison.
ContentCenter Property that returns the ContentCenter object.
ContentCenterOptions Returns the ContentCenterOptions object.
DesignProjectManager Gets the design project manager object.
DisplayOptions Gets the Display Options.
Documents Gets all the in-memory documents in a collection.
DrawingOptions Property that returns the DrawingOptions object. The DrawingOptions object provides access to various drawing related application level options. This is somewhat equivalent to the Drawing tab of the Application Options dialog.
ErrorManager Property that returns the ErrorManager object. This object can be used to get errors that occurred during an API call, add to Inventor's errors or to display them.
FavoriteAssets Gets the set of favorite assets. This includes both appearance and material assets.
FileAccessEvents Property that returns the FileAccessEvents object. This object supports a set of events that are fired as a result of a file being accessed.
FileManager Property that returns the FileManager object.
FileOptions Property that returns the FileOptions object. The FileOptions object provides access to various file related application level options. This is somewhat equivalent to the File tab of the Application Options dialog.
FileUIEvents Property that returns the FileUIEvents object. This object supports a set of events that are fired in reaction to certain user interface actions.
GeneralOptions Property that returns the GeneralOptions object. The GeneralOptions object provides access to various application level options. This is somewhat equivalent to the General tab of the Application Options dialog.
HardwareOptions Gets the Hardware Options.
Height Gets/Sets Height edge of the frame window.
HelpManager Gets the HelpManager object that provides access to the help-related activity taking place in the system.
iFeatureOptions Property that returns the iFeatureOptions object. The iFeatureOptions object provides access to various iFeature related application level options. This is somewhat equivalent to the iFeature tab of the Application Options dialog.
InstallPath Property that returns the full path where Inventor/Apprentice is installed.
IsIn3dPrintMode Read-only property that indicates whether Application is in 3D print preview mode.
LanguageCode Read-only property that returns the language code used to describe the current language being used by Inventor. The code is returned in the form of an EITF language code. The following codes can be returned by Inventor:
  • Brazilian Portuguese: pt-BR
  • Czech: cs-CZ
  • English: en-US
  • French: fr-FR
  • German: de-DE
  • Italian: it-IT
  • Japanese: ja-JP
  • Korean: ko-KR
  • Polish: pl-PL
  • Russian: ru-RU
  • Simplified Chinese: zh-CN
  • Spanish: es-ES
  • Traditional Chinese: zh-TW
LanguageName Gets the language currently in use in Autodesk Inventor.
LanguageTools Property that returns the LanguageTools object.
Left Gets/Sets the distance between the left edge of the screen and left edge of the frame window.
Locale Property that returns the Locale Id currently in use in Autodesk Inventor, along with a string name of the language. Calling GetLocaleInfo with the LocaleId should give you further information.
LoggedIn Read-only property that returns whether a user has logged in the online services or not.
LoginUserId Read-only property that returns the login user Id(this is the same as the A360 oxygen Id). This returns empty string if has not logged in.
LoginUserName Read-only property that returns the online services login user name. This returns empty string if has not logged in.
MainFrameHWND Gets the Application main window's HWND.
MaterialDisplayUnits Gets and sets the units that are used in the user interface when working with materials.
MeasureTools Returns the MeasureTools object.
ModelingEvents Property that returns the ModelingEvents object. This object supports a set of events that are common to parts and assemblies.
ModelStateEvents Read-only property that returns the ModelStateEvents object.
MRUDisplay Gets/Sets the property that turns display of the application's MRU list on and off.
MRUEnabled Gets/Sets the property that deals with the application's ability to add files to the MRU list.
NotebookOptions Property that returns the NotebookOptions object. The NotebookOptions object provides access to various notebook related application level options. This is somewhat equivalent to the Notebook tab of the Application Options dialog.
OpenDocumentsDisplay Gets/Sets the property that turns display of the application's Open Documents list on and off.
PartOptions Property that returns the PartOptions object. The PartOptions object provides access to various part related application level options. This is somewhat equivalent to the Part tab of the Application Options dialog.
PresentationOptions Gets the Presentation Options.
PromptsOptions Gets the Prompts Options object.
Ready Boolean property indicating whether Inventor has completed its initialization. This includes initialization of all the Add-ins loaded at startup.This property should be used in conjunction with the ApplicationEvents.OnReady event.
RepresentationEvents Property that returns the RepresentationEvents object. This object supports a set of events related to design view and positional representations that are assembly centric.
SaveOptions Property that returns the SaveOptions object. The SaveOptions object provides access to various save related application level options. This is somewhat equivalent to the Save tab of the Application Options dialog.
ScreenUpdating Gets and sets whether the screen is updated (redrawn) during a series of actions. Turn off screen updating while a series of actions are performed so that the screen is not redrawn after each action. Remember to turn screen updating on to update the screen.
SilentOperation Gets/Sets the Boolean flag that controls whether an operation will proceed without prompting (if that gets required...e.g.: error message dismissal). If Inventor is running visible, this property is FALSE by default.
Sketch3DOptions Property that returns the Sketch3DOptions object. The Sketch3DOptions object provides access to various 3D sketch related application level options. This is somewhat equivalent to the 3D Sketch portion on the Sketch tab of the Application Options dialog.
SketchEvents Property that returns the SketchEvents object. This object supports a set of 2d and 3d sketch-related events that are common to parts, assemblies and drawings.
SketchOptions Property that returns the SketchOptions object. The SketchOptions object provides access to various 2D sketch related application level options. This is somewhat equivalent to the 2D Sketch portion on the Sketch tab of the Application Options dialog.
SoftwareVersion Gets the object that encapsulates the version of the current software.
StatusBarText Gets/Sets the Status Bar text in first pane of the Application's Main frame.
StyleEvents Property that returns the StyleEvents object. This object supports a set of events that relate to styles.
StylesManager Gets the StylesManager object.
SupportsFileManagement Gets/Sets whether a file management AddIn is present.
ThemeManager Gets the ThemeManager object.
Top Gets/Sets the distance between the top of the screen and top of the frame window.
TransactionManager Gets the TransactionManager object that controls all the database transactions taking place in the system.
TransientBRep Property that returns the TransientBRep object.
TransientGeometry Gets the object through which all transient geometry objects can be constructed.
TransientObjects Gets the object through which all general transient objects are created.
Type Returns an ObjectTypeEnum indicating this object's type.
UnitsOfMeasure Property that returns the UnitsOfMeasure object.
UserInterfaceManager Gets the UserInterfaceManager object. The UserInterfaceManager object is the starting point for UI and environment control, providing access to available environments, command bars, browsers, panel bars, toolbars etc.
UserName Gets/sets the string that identifies the current user. Autodesk Inventor saves its own copy of this name per user and can thus be manipulated without affecting the rest of the OS.
VBAProjects Property that returns Autodesk Inventor's VBA projects collection.
VBE Gets the top-level automation pointer to VBA's IDE.
ViewFrames Read-only property that returns the ViewFramesEnumerator collection object.
Views Gets all the open Views in a collection.
Visible Gets/Sets the visibility of this application.
WebBrowserDialogs Read-only property that returns the WebBrowserDialogs collection object.
Width Gets/Sets the Width the frame window.
WindowState Gets/Sets the frame windows state.

Accessed From

ApplicationAddInSite.Application, AuxiliaryFeatureIndicator.Application, AuxiliaryFeatureIndicators.Application, BalloonTip.Application, BalloonTips.Application, BrowserFoldersEnumerator.Application, BrowserNodesEnumerator.Application, ButtonDefinition.Application, ClientResourceMap.Parent, ComboBoxDefinition.Application, CommandBar.Application, CommandBar.Parent, CommandBarBaseCollection.Application, CommandBarButton.Application, CommandBarControl.Application, CommandBarControls.Application, CommandBarList.Application, CommandBarPopUp.Application, CommandBars.Application, CommandCategories.Application, CommandCategory.Application, CommandControl.Application, CommandControls.Application, CommandControlsEnumerator.Application, CommandManager.Parent, ControlDefinition.Application, ControlDefinitionEvents.Application, ControlDefinitions.Application, DisabledCommandList.Application, Environment.Application, Environment.Parent, EnvironmentBase.Application, EnvironmentBase.Parent, EnvironmentBaseCollection.Application, EnvironmentList.Application, EnvironmentManager.Application, Environments.Application, FileUIEvents.Application, FileUIEvents.Parent, InteractionEvents.Application, InventorVBAProject.Parent, InventorVBAProjects.Parent, KeyboardEvents.Application, LicenseManager.Application, LicenseManager.Parent, MacroControlDefinition.Application, ManipulatorEvents.Application, MeasureEvents.Application, MiniToolbar.Application, MiniToolbarButton.Application, MiniToolbarCheckBox.Application, MiniToolbarComboBox.Application, MiniToolbarControl.Application, MiniToolbarControls.Application, MiniToolbarDropdown.Application, MiniToolbarSlider.Application, MiniToolbarTextBox.Application, MiniToolbarTextEditor.Application, MiniToolbarValueEditor.Application, ModelDatumReferenceFrame.Application, ModelDatumReferenceFrameDefinition.Application, ModelDatumReferenceFrameProxy.Application, ModelDatumReferenceFrames.Application, ModelToleranceFeatureDefinition.Application, MouseEvents.Application, PanelBar.Application, ProgressiveToolTip.Application, ProjectOptionsButton.Application, PublicationMeshEdge.Application, PublicationMeshFace.Application, RadialMarkingMenu.Application, RadialMarkingMenus.Application, Ribbon.Application, RibbonPanel.Application, RibbonPanels.Application, Ribbons.Application, RibbonTab.Application, RibbonTabs.Application, SelectEvents.Application, Theme.Application, ThemeManager.Application, ThemeManager.Parent, ThemesEnumerator.Application, TriadEvents.Application, TutorialsManager.Parent, UserInputEvents.Application, UserInterfaceEvents.Application, UserInterfaceManager.Application, UserInterfaceManager.Parent, VbaApplication.ThisApplication, ViewFrame.Application, ViewFrame.Parent, ViewFramesEnumerator.Application, WebBrowserDialog.Application, WebView.Application

Version

Introduced in version 4

Was this information helpful?