DocumentInterest Object


Description

Provides a means for an application to register an interest in a document. In order words, to flag the document as containing application-specific data, and to set the data version (for example, so Inventor can determine whether data migration is required and so fire the appropriate event).

Methods

Name Description
Delete Method that deletes the DocumentInterest object.

Properties

Name Description
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.
ClientData Gets/Sets additional data that the client would like to store with the interest. This string is not interpreted by Inventor.
ClientId Property that returns the ClientId associated with the DocumentInterest indicating the owner of this object.
DataVersion Gets/Sets the current data version of the document. If the property returns -1 or is set to -1, this is assumed to be a 'non-migrating' type of interest.
InterestType Gets/Sets the type of interest that the client has in this document.
Name Property that returns the non-localized name associated with this interest.
Parent Property that returns the parent document object.
Type Returns an ObjectTypeEnum indicating this object's type.

Accessed From

DocumentInterests.Add, DocumentInterests.Item

Version

Introduced in version 2008