Share

DesignProject Object


Description

The DesignProject object represents an Inventor project file (.ipj).

Methods

Name Description
Activate Method that activates the DesignProject. This requires all the documents to be closed in Inventor.
GetCustomSection Method that returns a custom section (in the form of an XML string) from the project file.
GetIncludedCustomSection Method that returns a custom section (in the form of an XML string) from the included project file.
Remove Method that removes the DesignProject from the list of available project files. This does not delete the .ipj file on disk. This method fails if the project is currently active.
SetCustomSection Method that adds or modifies a custom section (in the form of an XML string) in the project file. If a section with the given name is found, the section is replaced, else the section is added.

Properties

Name Description
ActiveAppearanceLibrary Read-only property that returns the currently active appearance library.
ActiveMaterialLibrary Read-only property that returns the currently active material library.
AppearanceLibraries Read-only property that returns the collection of appearance libraries associated with this project.
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.
ContentCenterPath Read-write property that gets and sets the directory in which to look for the Content Center components. If set, this value overrides the corresponding application option. The ContentCenterPathOverridden property returns whether the path is overridden and provides the ability to clear the override.
ContentCenterPathOverridden Gets and sets whether the content center path is overridden by this project. Setting the property to False clears the override and path in the application option is used.
CreationTime Gets and sets the creation time of the project file.
DesignDataPath Read-write property that gets and sets the directory in which to look for the Design Data such as styles. If set, this value overrides the corresponding application option. The DesignDataPathOverridden property returns whether the path is overridden and provides the ability to clear the override.
DesignDataPathOverridden Gets and sets whether the design data path is overridden by this project. Setting the property to False clears the override and path in the application option is used.
FrequentlyUsedPaths Property that returns a ProjectPaths object that contains the list of frequently used paths and provides ability to add/remove paths.
FullFileName Property that returns the fully qualified file name for this design project.
IncludedProject Read-write property that gets and sets the full file name of another project to include in this project. The search paths in the included file are included in the project. The project type of the included file overrides the setting in the project. The property can be set to a null string to indicate that there are no included projects.
LibraryPaths Property that returns a ProjectPaths object that contains the list of library paths and provides ability to add/remove paths.
MaterialLibraries Read-only property that returns the collection of material libraries associated with this project.
Name Gets and sets the name for this design project.
OldVersionsToKeep Gets and sets the number of versions to store in the OldVersions folder for each file saved. The first time a file is saved.
Owner Gets and sets the string identifying the owner of the project.
Parent Property that returns the parent DesignProjectManager object.
PresetsPath Gets and sets the directory in which to look for the Presets path. If set, this value overrides the corresponding directory.
PresetsPathOverridden Gets and sets whether the presets path is overridden by this project. Setting the property to False clears the override and path in the application option is used.
ProjectType Read-write property that gets and sets the project type. Setting the type to shared or semi-isolated requires workgroup(s) to be specified. Setting the type to a Vault project requires a workspace to be specified but no workgroups or included project should be specified.
ReleaseId Gets and sets version of the project.
Shortcuts Gets and sets an array of strings specifying the shortcuts for the project.
StylesLibraryAccess Gets/Sets the status of the styles library access for the Design Project.
TemplatesPath Read-write property that gets and sets the directory in which to look for the template files. If set, this value overrides the corresponding application option. The TemplatesPathOverridden property returns whether the path is overridden and provides the ability to clear the override.
TemplatesPathOverridden Gets and sets whether the templates path is overridden by this project. Setting the property to False clears the override and path in the application option is used.
Type Returns an ObjectTypeEnum indicating this object's type.
UsingUniqueFileNames Gets and sets whether duplicate file names are used in the project.
VaultName Gets and sets the vault name. Applicable only if the ProjectType is set to kVaultMode.
VaultPublishPath Gets and sets the publish folder for Vault. Applicable only if the ProjectType is set to kVaultMode.
VaultServer Gets and sets the vault server. Applicable only if the ProjectType is set to kVaultMode.
VaultVirtualPath Gets and sets the virtual folder for Vault. Applicable only if the ProjectType is set to kVaultMode.
WorkgroupPaths Property that returns a ProjectPaths object that contains the list of workgroup paths and provides ability to add/remove paths.
WorkspacePath Gets and sets the workspace folder for the project.

Accessed From

ContentCenterConfiguration.Parent, DesignProjectManager.ActiveDesignProject, DesignProjects.Add, DesignProjects.AddExisting, DesignProjects.Item, DesignProjects.ItemByName, IntentConfiguration.Parent, ProjectAssetLibrary.Parent, ProjectPath.Parent

Samples

Name Description
Set active project The following sample demonstrates the activation of an Inventor project.

Version

Introduced in version 7

Was this information helpful?