Save(string,DocumentFormat,OcrProgressCallback) Method

Summary

Converts the accumulated recognition results stored in the pages of this OCR document to the final output document and stores it to a disk file.

Syntax

Objective-C

C++

Java

public void Save( 
   string fileName, 
   DocumentFormat format, 
   OcrProgressCallback callback 
)

Overloads Sub Save( _ 
   ByVal fileName As String, _ 
   ByVal format As DocumentFormat, _ 
   ByVal callback As OcrProgressCallback _ 
)

- (BOOL)saveToFile:(NSString *)fileName  
            format:(LTDocumentFormat)format  
          progress:(nullable LTOcrProgressHandler)progressHandler  
             error:(NSError **)error

public void save(String fileName, 
                 OcrProgressListener callback)

void Save(  
   String^ fileName, 
   DocumentFormat format, 
   OcrProgressCallback^ callback 
)

Parameters

fileName
The name of the file to save the final output document to.

format
The document format to use. If this parameter is DocumentFormat.User, then the document saved using the native engine format set in IOcrDocumentManager.EngineFormat if the engine used supports native formats, otherwise an exception will be thrown. Note that saving the OCR results using the native engine formats may produce more accurate results in table and cell positions since the engine has access to extra data that is saved internally.

callback
Optional callback to show operation progress.

Remarks

To save the output document to a .NET stream, use IOcrDocument.Save(Stream stream, DocumentFormat format, OcrProgressCallback callback).

To get the extension used commonly with the document format specified in format, use DocumentWriter.GetFormatFileExtension.

Each IOcrPage object in the Pages collection of this IOcrDocument object holds its recognition data internally. This data is used by this method to generate the final output document.

Typical OCR operation using the IOcrEngine involves starting up the engine then creating a new IOcrDocument object using the CreateDocument method before adding the pages into it and perform either automatic or manual zoning. Once this is done, you can use the IOcrPage.Recognize method of each page to collect the recognition data and store it internally in the page. After the recognition data is collected, you use the various IOcrDocument.Save methods to save the document to its final format as well as IOcrDocument.SaveXml to save as XML.

You can also use the IOcrPage.GetText method to return the recognition data as a simple String object.

You can use IOcrDocument.Save as many times as required to save the document to multiple formats. You can also continue to add and recognize pages (through the IOcrPage.Recognize method after you save the document.

For each IOcrPage that is not recognized (the user did not call Recognize and the value of the page IOcrPage.IsRecognized is still false) the IOcrDocument will insert an empty page into the final document.

To get the low level recognition data including the recognized characters and their confidence, use IOcrPage.GetRecognizedCharacters instead.

The IOcrDocument interface implements IDisposable, hence you must dispose the IOcrDocument object as soon as you are finished using it. Disposing an IOcrDocument object will free all the pages stored inside its IOcrDocument.Pages collection.

You can use the OcrProgressCallback to show the operation progress or to abort it. For more information and an example, refer to OcrProgressCallback.

Example

For an example, refer to IOcrDocumentManager and IOcrEngine.

Requirements

Target Platforms