UserToken Property

Summary

The user document associated with this document.

Syntax

C++

public string UserToken {get; set;}

Public Property UserToken() As String 
   Get 
   Set

public:  
   property String^ UserToken 
   { 
      String^ get() 
      void set(String^ value) 
   }

Property Value

The user token associated with this document. The default value is null.

Remarks

Note that the current behavior of the toolkit is to clear this value for security reasons when DocumentFactory.GetDocumentCacheInfo is called, and will be null regardless of the value in the cache.

HasUserToken can be used to determine if the document was created with a user token. When a document is loaded successfully, the user token value will be set in the LEADDocument.UserToken property.

Refer to Loading Using LEADTOOLS Document Library for more information.

Example

For an example, refer to LoadDocumentOptions.UserToken.

Requirements

Target Platforms