←Select platform

SaveXmlAsync Method

Summary

Converts the accumulated recognition results stored in the pages of this OCR document to XML data and stores it into a Windows Runtime StorageFile object.

Syntax

WinRT C#

C++

IAsyncAction SaveXmlAsync(  
   IStorageFile file, 
   Leadtools.Forms.Ocr.OcrXmlOutputOptions options 
)

Function SaveXmlAsync( _ 
   ByVal file As IStorageFile, _ 
   ByVal options As Leadtools.Forms.Ocr.OcrXmlOutputOptions _ 
) As IAsyncAction

IAsyncAction SaveXmlAsync(  
   IStorageFile file, 
   Leadtools.Forms.Ocr.OcrXmlOutputOptions options 
)

function Leadtools.Forms.Ocr.IOcrDocument.SaveXmlAsync(  
   file , 
   options  
)

IAsyncAction^ SaveXmlAsync(  
   IStorageFile^ file, 
   Leadtools.Forms.Ocr.OcrXmlOutputOptions options 
)

Parameters

file
The Windows Runtime storage file object to save the XML data to.

options
A combination of one or more OcrXmlOutputOptions enumeration members that specify the XML generation options.

Return Value

Returns the IAsyncActoin object for the operation.

Remarks

To obtain an XML directly use IOcrDocument.SaveXml(OcrXmlOutputOptions options).

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. 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 SaveAsync to save the document to its final format as well as SaveXmlAsync 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 SaveXmlAsync 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.

Requirements

Target Platforms

Reference

IOcrDocument Interface

IOcrDocument Members

Leadtools.Forms.DocumentWriters.DocumentFormat

IOcrDocumentManager Interface

OcrEngineManager Class

OcrEngineType Enumeration

Programming with the LEADTOOLS .NET OCR

Files to be Included with Your Application

Help Version 19.0.2017.10.27