ReferenceKeyManager Object


Description

Reference key manager object. This object provides methods to create and save reference key contexts as well as bind reference keys to their targets.

Methods

Name Description
BindKeyToObject Method to bind a reference key to the persistent object within the document. Returns a specific object, if there is a unique solution.
CanBindKeyToObject Method that returns whether the key can be bound to an entity or not.
CreateKeyContext Method to create a key context to use in the creation of reference keys.
KeyToString Converts a ReferenceKey byte array to a Base64 encoded string.
LoadContextFromArray Method to load a previously saved key context from an array of data.
ReleaseKeyContext Specifies a key context to release.
SaveContextToArray Method to save a key context out as an array of data.
StringToKey Converts a string to a reference key byte array.

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.
Parent Property that returns the parent object from whom this object can logically be reached.
Type Returns an ObjectTypeEnum indicating this object's type.

Accessed From

ApprenticeServerDocument.ReferenceKeyManager, ApprenticeServerDrawingDocument.ReferenceKeyManager, AssemblyDocument.ReferenceKeyManager, Document.ReferenceKeyManager, DrawingDocument.ReferenceKeyManager, PartDocument.ReferenceKeyManager, PresentationDocument.ReferenceKeyManager

Version

Introduced in version 5