Overloads Overridable Function SaveXml( _
   ByVal options As OcrXmlOutputOptions _
) As String

Visual Basic (Usage)	Copy Code
Dim instance As IOcrDocument Dim options As OcrXmlOutputOptions Dim value As String   value = instance.SaveXml(options)

virtual string SaveXml( 
   OcrXmlOutputOptions options
)

virtual String^ SaveXml( 
   OcrXmlOutputOptions options
) 

Parameters

options

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

Return Value

This example recognize a page then process the result XML data.

Visual Basic

Copy Code

Private Sub SaveAndProcessXmlExample()    ' Unlock the support needed for LEADTOOLS Professional OCR engine    RasterSupport.Unlock(RasterSupportType.Document, "Replace with your own key here")    RasterSupport.Unlock(RasterSupportType.OcrProfessional, "Replace with your own key here")    Dim tifFileName As String = "C:\Users\Public\Documents\LEADTOOLS Images\Ocr1.tif"    ' Create an instance of the engine    Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Professional, False)       ' Start the engine using default parameters       ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing)       ' Create an OCR document       Using ocrDocument As IOcrDocument = ocrEngine.DocumentManager.CreateDocument()          ' Add this image to the document          Dim ocrPage As IOcrPage = ocrDocument.Pages.AddPage(tifFileName, Nothing)          ' Recognize it          ocrPage.Recognize(Nothing)          ' Get the recognition data as XML          Dim xml As String = ocrDocument.SaveXml(OcrXmlOutputOptions.None)          ' Process the data by showing all the words          Using reader As New System.IO.StringReader(xml)             Dim doc As New System.Xml.XPath.XPathDocument(reader)             Dim nav As System.Xml.XPath.XPathNavigator = doc.CreateNavigator()             ' Select all the <word> elements             Dim iter As System.Xml.XPath.XPathNodeIterator = nav.Select("//word")             Console.WriteLine("Word found:")             While iter.MoveNext()                Console.WriteLine(iter.Current.Value)             End While          End Using       End Using       ' Shutdown the engine       ' Note: calling Dispose will also automatically shutdown the engine if it has been started       ocrEngine.Shutdown()    End Using End Sub

C#

Copy Code

private void SaveAndProcessXmlExample()  {     // Unlock the support needed for LEADTOOLS Professional OCR engine     RasterSupport.Unlock(RasterSupportType.Document, "Replace with your own key here");     RasterSupport.Unlock(RasterSupportType.OcrProfessional, "Replace with your own key here");     string tifFileName = @"C:\Users\Public\Documents\LEADTOOLS Images\Ocr1.tif";       // Create an instance of the engine     using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Professional, false))     {        // Start the engine using default parameters        ocrEngine.Startup(null, null, null, null);          // Create an OCR document        using(IOcrDocument ocrDocument = ocrEngine.DocumentManager.CreateDocument())        {           // Add this image to the document           IOcrPage ocrPage = ocrDocument.Pages.AddPage(tifFileName, null);             // Recognize it           ocrPage.Recognize(null);             // Get the recognition data as XML           string xml = ocrDocument.SaveXml(OcrXmlOutputOptions.None);             // Process the data by showing all the words           using(System.IO.StringReader reader = new System.IO.StringReader(xml))           {              System.Xml.XPath.XPathDocument doc = new System.Xml.XPath.XPathDocument(reader);              System.Xml.XPath.XPathNavigator nav = doc.CreateNavigator();                // Select all the <word> elements              System.Xml.XPath.XPathNodeIterator iter = nav.Select(@"//word");                Console.WriteLine("Word found:");              while(iter.MoveNext())              {                 Console.WriteLine(iter.Current.Value);              }           }        }          // Shutdown the engine        // Note: calling Dispose will also automatically shutdown the engine if it has been started        ocrEngine.Shutdown();     }  }

To save the output document as XML to a disk file or a .NET stream, use IOcrDocument.SaveXml(string fileName, OcrXmlOutputOptions options) and IOcrDocument.SaveXml(Stream stream, 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 IOcrDocumentManager.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.RecognizeText method to recognize and 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 IOcrPage.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.

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

Reference