DocumentId Property

Summary

The ID to be used with the loaded document.

Syntax

C++/CLI

Java

Python

public string DocumentId { get; set; }

public String getDocumentId() 
public void setDocumentId()

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

DocumentId # get and set (CreateDocumentOptions)

Property Value

String that specifies the ID to be used with the loaded document. 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 GUID generator (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.

DocumentId is not used if Descriptor is not null. Instead, the document creation data along with its ID is stored in the DocumentDescriptor object set in the method.

Requirements

Target Platforms