SaveXml(Stream,OcrWriteXmlOptions,OcrXmlOutputOptions) Method

Summary

Converts the accumulated recognition results stored in the pages of this OCR document to XML data and stores it in a .NET stream with XML options.

Syntax

Objective-C

C++

Java

public void SaveXml( 
   Stream stream, 
   OcrWriteXmlOptions xmlOptions, 
   OcrXmlOutputOptions outputOptions 
)

Overloads Sub SaveXml( _ 
   ByVal stream As Stream, _ 
   ByVal xmlOptions As OcrWriteXmlOptions, _ 
   ByVal outputOptions As OcrXmlOutputOptions _ 
)

- (void)saveXmlToStream:(LTLeadStream *)stream  
        xmlWriteOptions:(nullable LTOcrWriteXmlOptions *)xmlWriteOptions  
          outputOptions:(LTOcrXmlOutputOptions)outputOptions  
                  error:(NSError **)error

public void saveXml(OutputStream stream, 
                    OcrWriteXmlOptions xmlOptions, 
                    int outputOptions)

void SaveXml(  
   Stream^ stream, 
   OcrWriteXmlOptions^ xmlOptions, 
   OcrXmlOutputOptions outputOptions 
)

Parameters

stream
The .NET stream to save the XML data to.

xmlOptions
Options to use when creating the XML data.

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

Remarks

To save the output document as XML to a disk file, use IOcrDocument.SaveXml(string fileName, OcrXmlOutputOptions options) and 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 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.SaveXml 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.

Example

For an example, refer to SaveXml(string, OcrXmlOutputOptions).

Requirements

Target Platforms