documentId Property


The ID to be used with the loaded document.

Object.defineProperty(LoadDocumentOptions.prototype, 'documentId', 
   get: function(), 
   set: function(value) 
documentId: string; 

Property Value

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


When the value of DocumentId is null (the default), then the document factory will create a new unique ID using a GUID generator. 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.


For an example, refer to DocumentFactory.LoadFromUri.

Target Platforms
Help Version 21.0.2021.3.4
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document Assembly