ApprenticeServerComponent Object


Description

Inventor::ApprenticeServer

Methods

Name Description
Close Closes the current file. After this call there is no top-level Document. Attempt is also made to close the children Documents.
Close2 Closes the current file. After this call there is no top-level Document. Optionally forces any child Documents to close.
Open Opens a file. It can now be accessed as the top-level Document.
OpenWithOptions Opens a document of the specified file-name with the specified set of options.

Properties

Name Description
ApplicationAddIns Gets all the Application AddIns found on this machine in a collection.
DesignProjectManager Gets the design project manager object.
DisplayAffinity Gets/Sets the Boolean flag that fine tunes the performance of Apprentice when it is being used to display Inventor files. Defaults to false.
DisplayOptions Gets the Display Options object.
Document Gets the top-level Apprentice Server Document.
FileManager Gets the file manager object.
FileOptions Gets the File Options object.
FileSaveAs Gets the object that provides access to the helper object that provides the Save As facility.
HardwareOptions Gets the Hardware Options.
HelpManager Gets the Help Manager object that provides access to the help-related activity taking place in the system.
InstallPath Read-only property that returns the full path where Inventor/Apprentice is installed.
Locale Gets the Locale Id currently in use in Inventor.
MultiUserExternallyManaged Gets/Sets the Boolean flag indicating whether Multi-User facility is managed by Inventor or not.
MultiUserMode Gets/Sets the enum indicating the Multi-User mode.
SoftwareVersion Gets the object that encapsulates the version of the current software.
TransientGeometry Gets the object through which all transient geometry objects can be constructed.
TransientObjects Gets the TransientObjects object.
Type Returns an ObjectTypeEnum indicating this object's type.
UserName Gets/Sets the string that identifies the current user. Inventor saves its own copy of this name per user and can thus be manipulated without effecting the rest of the OS.

Samples

Name Description
Update iProperty values using Apprentice Updates some iProperty values using Apprentice. The document specified in the code for the Open method must exist.

Version

Introduced in version 4