Share

ApprenticeServerDocument Object


Description

The ApprenticeServerDocument object represents an in-memory Inventor document.

Methods

Name Description
Close Closes this document.
CreateHighlightSet Method that creates a new highlight set.
FindWhereUsed Method that obtains the set of documents that reference the given file within this document.
GetLocationFoundIn Obtains the name of the location this file was found in.
RevertReservedForWriteByMe Method that reverts the file checked out by the caller.

Properties

Name Description
AllReferencedDocuments Property that returns all the document references of this document along with all of the recursively nested references.
AttributeManager Returns the AttributeManager object.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
ClientViews Property that returns the document's .
Compacted Gets the Boolean that states whether this file has been processed for compaction since the last save.
ComponentDefinition Gets the primary that resides in this file.
DatabaseRevisionId Gets the GUID that represents the last saved revision of database contained in this document. This revision id tracks modifications to the database (such as reference changes, geometry changes, etc.) but does not track file property changes.
Dirty Gets/Sets a Boolean flag indicating if the Document has been written into, since opened.
DisplayName Gets/Sets the user-displayable name of this Document. Defaults to file-name.
DocumentInterests Property that returns the DocumentInterests collection object.
DocumentType Gets the constant that indicates the type of this document.
File Property that returns the file (storage) on disk that contains this document.
FilePropertySets Read-only property that returns the file PropertySets. This is equivalent to the iProperties that got from Shell Extension.
FileSaveCounter Gets the number that indicates the number of times the file has been saved.
FullDocumentName Property that returns the fully qualified name of the document. The string is the full file name concatenated with the document name and is a unique identifier for the document. The document name is returned by the Name property on the Document object.
FullFileName Gets the fully qualified file-name of this document.
HealthStatus Property that returns an enum indicating the current state of the object.
InternalName Gets the Internal Name (a GUID) for this document.
IsModifiable Property that returns whether this document can be currently modified. One of the reasons a document may be non-modifiable is if any other document belonging to the file containing this document is currently being edited.
IsSubstitutePart Read-only property that returns whether this part is intended to be used as a substitute part. (applies only to part documents).
NeedsMigrating Gets the Boolean indicating whether this file needs to be migrated first, using Autodesk Inventor (opened and saved using Autodesk Inventor), before any edits can be performed to the Autodesk Inventor-specific data within this file.
Open Property that returns whether this document is currently open. If False, the document has only been initialized and calling methods or properties on the document could cause it to open.
PrintManager Property that returns the object for this document.
PropertySets Gets the object that manages the File Properties.
ReferencedDocumentDescriptors Property that returns an enumeration of descriptors that represent the native document references held by this document.
ReferencedDocuments Property that returns all the documents referenced by this document.
ReferencedOLEFileDescriptors Property that returns the collection of linked files in the document. Embeddings are not accessible in Apprentice.
ReferencedOpaqueFileDescriptors Gets the collection of descriptor objects, presenting (editable) information about opaque references held.
ReferenceKeyManager Gets this Document's ReferenceKeyManager object.
ReferencingDocuments Property that returns all the documents in memory that reference this document.
RequiresUpdate Property that returns whether the document requires an update. Note that the document cannot be updated in Apprentice.
ReservedForWrite Gets the Boolean flag indicating whether this file has been reserved for write by someone.
ReservedForWriteByMe Gets/Sets the Boolean flag indicating whether this file has been reserved for write by the caller.
ReservedForWriteLogin Gets the login of the person who currently holds the reservation to write.
ReservedForWriteName Gets the name of the person who currently holds the reservation to write.
ReservedForWriteTime Gets the time at which the reservation was made.
ReservedForWriteVersion Gets the version within this file that has been reserved for write.
SoftwareVersionCreated Gets the object that encapsulates the version of the software with which this document was first created.
SoftwareVersionSaved Gets the object that encapsulates the version of the software with which this document was last saved.
Thumbnail Property that returns a bitmap picture of the document.
Type Returns an ObjectTypeEnum indicating this object's type.
UnitsOfMeasure Property that returns the UnitsOfMeasure object.

Accessed From

ApprenticeServer.Document, ApprenticeServer.Open, ApprenticeServer.OpenWithOptions, ApprenticeServerComponent.Document, ApprenticeServerComponent.Open, ApprenticeServerComponent.OpenWithOptions, ApprenticeServerDocuments.Item

Derived Classes

ApprenticeServerDrawingDocument

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

Was this information helpful?