CreateDocumentDescriptor Method

Summary

Creates a descritpor object that can be used to re-create this document.

Syntax

C++/CLI

Java

Python

public DocumentDescriptor CreateDocumentDescriptor()

public:  
   DocumentDescriptor^ CreateDocumentDescriptor()

public DocumentDescriptor createDocumentDescriptor()

def CreateDocumentDescriptor(self):

Return Value

Object containing the values required to re-create this document.

Remarks

DocumentDescriptor is a simple JSON serializable object that can be used to re-create a LEADDocument.

Use CreateDocumentDescriptor to generate the object from an existing document.

Use UpdateFromDocumentDescriptor to update an existing LEADDocument from a descritpor.

Use CreateDocumentOptions.Descriptor along with Create(CreateDocumentOptions)
from a descritpor.

These methods are used by the LEADTOOLS Document Web Service to allow creating or manipulating existing documents from JavaScript. When the JavaScript has finished with the LEADDocument object, it will call CreateDocumentDescriptor to obtain a simple JSON object that describes the document and send it to the server. The server will then call UpdateFromDocumentDescriptor or DocumentFactory.Create to update an existing or creata a new LEADDocument object.

Refer to CreateDocumentOptions.Descriptor for more information.

Requirements

Target Platforms