CloneDocument(ObjectCache,ObjectCache,string,CloneDocumentOptions) Method

Summary

Clones (creates a copy) of a document in the cache.

Syntax

C++

public static string CloneDocument( 
   ObjectCache sourceCache, 
   ObjectCache targetCache, 
   string sourceDocumentId, 
   CloneDocumentOptions options 
)

Public Shared Function CloneDocument( 
   ByVal sourceCache As ObjectCache, 
   ByVal targetCache As ObjectCache, 
   ByVal sourceDocumentId As String, 
   ByVal options As CloneDocumentOptions 
) As String

public:  
   static String^ CloneDocument( 
      ObjectCache^ sourceCache, 
      ObjectCache^ targetCache, 
      String^ sourceDocumentId, 
      CloneDocumentOptions^ options 
   )

Parameters

sourceCache

The cache object containing the data for the source document. This value must not be null.

targetCache

The cache object that will contain the data for the destination document. This value must not be null and can be the same value as sourceCache to clone in the document in the same cache.

sourceDocumentId

ID to the source document in the cache. This value cannot be null.

options

Options to use during cloning.

Return Value

The ID of the new newly created document if successful.

Remarks

This method can be used to clone the data of an uploaded document in the same or a separate cache.

This method performs the following:

If the document is has been loaded from the cache at least once, then it will load the source document and call LEADDocument.Clone, save the new document into the cache, and dispose it. Finally, it returns the ID of the newly created document.
Otherwise, this method calls CloneDocument(ObjectCache,ObjectCache,Uri,CloneDocumentOptions).

Requirements

Target Platforms

Reference

DocumentFactory Class

DocumentFactory Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3