documentId Property (CreateDocumentOptions)

Summary

The ID to be used with the loaded document.

Syntax

JavaScript Syntax

Object.defineProperty(CreateDocumentOptions.prototype, 'documentId', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

documentId: string;

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. 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 Document.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

See Also