←Select platform

DocumentId Property

Summary

The ID of the LEADDocument object to be used as the input of the conversion.

Syntax
C#
VB
C++
public string DocumentId { get; set; } 
Public Property DocumentId() As String 
   Get 
   Set 
public:  
   property String^ DocumentId 
   { 
      String^ get() 
      void set(String^ value) 
   } 

Property Value

The ID of LEADDocument object to be used as the input of the conversion. If this value is not null, then it will be used as the input document for the conversion. The default value is null.

Remarks

One input must be specified for the conversion to be successful: One of InputDocumentFileName, Document or DocumentId must not be null.

If DocumentId is set by the user, then the document converter will use Cache to load the LEADDocument object as is and will dispose it when the conversion is completed.

The converter will use DocumentFactory.LoadFromCache passing Cache and DocumentId as the parameters. Therefore, the ID must point to a valid document in the cache.

Example

For an example, refer to RunJob and RunJobAsync.

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Converter Assembly