ReferencedOLEFileDescriptor Object
Description
The ReferencedOLEFileDescriptor object represents an OLE reference to another file.
Methods
| Activate |
Method that causes the OLE file to be activated by the process currently registered to handle that type of document. |
| Delete |
Method that deletes the reference file attachment. |
| GetReferenceKey |
Method that generates and returns the reference key for this entity. |
Properties
| 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. |
| AttributeSets |
Property that returns the AttributeSets collection object associated with this object. |
| BrowserVisible |
Gets/Sets visible of the file reference in 3rdPartyFolder. |
| DisplayName |
Gets/Sets the display name of the file as currently found (or the last known display name, if reference is not found). |
| FileDescriptor |
Property that returns the corresponding FileDescriptor object. The ReplaceReference method on the returned object can be used to replace the referenced file. This property returns Nothing for embeddings. |
| FullFileName |
Property that returns the full path name of the file as currently found (or the last known full file name, if reference is not found). This property returns a null string for an embedding descriptor. |
| LastKnownFileTime |
Property that returns the time stamp on the file when it was last reviewed. This property returns Nothing for embeddings. |
| LogicalName |
Property that returns the logical name of the reference. This is essentially the relative path used by Autodesk Inventor to find the file using the project paths as the search paths. |
| OLEDocumentType |
Property that returns the type of OLE reference this represents. Valid values are kOLEDocumentEmbeddingObject, kOLEDocumentLinkObject, or kOLEDocumentUnknownObject. |
| Parent |
Property that returns the parent Document (in Inventor) or ApprenticeServerDocument (in Apprentice). |
| ReferenceMonitoring |
Gets/Sets whether the referenced file is monitored by Inventor for changes. |
| ReferenceStatus |
Property that returns the current status of the file reference. This property returns kUpToDateReference for embeddings. |
| Type |
Returns an ObjectTypeEnum indicating this object's type. |
| Visible |
Gets/Sets whether the linked/embedded object is visible in the graphics window. |
Accessed From
ParameterTable.ReferencedFileDescriptor,
ReferencedOLEFileDescriptors.Add,
ReferencedOLEFileDescriptors.Item,
ReferencedOLEFileDescriptors.ItemByName,
SketchImage.ReferencedFileDescriptor,
SketchImageProxy.ReferencedFileDescriptor
Version
Introduced in version 4
