DocumentId Property

Summary

The ID to be used with the loaded document.

Syntax

C++/CLI

Java

Python

public string DocumentId { get; set; }

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

public String getDocumentId() 
public void setDocumentId()

DocumentId # get and set (LoadDocumentOptions)

Property Value

String that specifies the ID to be used with the loaded document. The default value is null.

Remarks

When the value of DocumentId is null (the default), then the document factory will create a new unique ID using a DocumentFactory.NewCacheId. If the value is not null, then it is assumed to be a user-defined ID and used as is. In either case, the value is set in the LEADDocument.DocumentId property of the newly created document.

User-defined IDs can be used when the system already have unique ID's associated with the documents to be viewer. The document factory will not check nor guarantee the uniqueness of these IDs.

Requirements

Target Platforms