OcrWriteXmlOptions Class

Summary

Options to use when saving XML data.

Syntax

Objective-C

C++

Java

[SerializableAttribute()] 
public class OcrWriteXmlOptions

<SerializableAttribute()> 
Public Class OcrWriteXmlOptions

@interface LTOcrWriteXmlOptions : NSObject

public class OcrWriteXmlOptions

[SerializableAttribute()] 
public ref class OcrWriteXmlOptions

Remarks

OcrWriteXmlOptions allows to control how XML data is written. It has the following members:

Member	Description
Encoding	Set the encoding of the XML data. UTF8 or UTF16
Formatted	Format the document for human reading
Indent	The string to use for indentation when saving the XML data.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Ocr; 
using Leadtools.Forms.Common; 
using Leadtools.Document.Writer; 
using Leadtools.WinForms; 
using Leadtools.Drawing; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
 
private static void OcrWriteXmlOptionsExample() 
{ 
   var imageFileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif"); 
   var formattedFileName = Path.Combine(LEAD_VARS.ImagesDir, "formatted.xml"); 
   var nonFormattedFileName = Path.Combine(LEAD_VARS.ImagesDir, "non_formatted.xml"); 
 
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD)) 
   { 
      ocrEngine.Startup(null, null, null, LEAD_VARS.OcrLEADRuntimeDir); 
 
      // Load an image 
      var rasterImage = ocrEngine.RasterCodecsInstance.Load(imageFileName, 1); 
 
      // Create an OCR page from it 
      using (IOcrPage ocrPage = ocrEngine.CreatePage(rasterImage, OcrImageSharingMode.AutoDispose)) 
      { 
         // Recognize 
         ocrPage.Recognize(null); 
 
         // Save the result as XML 
 
         // First, non-formatted 
         var writeXmlOptions = new OcrWriteXmlOptions(); 
         writeXmlOptions.Formatted = false; 
         ocrPage.SaveXml(formattedFileName, 1, writeXmlOptions, OcrXmlOutputOptions.None); 
 
         // Next, formatted with 4 spaces indentation 
         writeXmlOptions.Formatted = true; 
         writeXmlOptions.Indent = "  "; 
         ocrPage.SaveXml(nonFormattedFileName, 1, writeXmlOptions, OcrXmlOutputOptions.None); 
      } 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS21\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS21\Bin\Common\OcrLEADRuntime"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Ocr 
Imports Leadtools.Forms 
Imports Leadtools.Document.Writer 
Imports Leadtools.WinForms 
Imports Leadtools.Drawing 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
 
Private Shared Sub OcrWriteXmlOptionsExample() 
   Dim imageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif") 
   Dim formattedFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "formatted.xml") 
   Dim nonFormattedFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "non_formatted.xml") 
 
   Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD) 
      ocrEngine.Startup(Nothing, Nothing, Nothing, LEAD_VARS.OcrLEADRuntimeDir) 
 
      ' Load an image 
      Dim rasterImage As RasterImage = ocrEngine.RasterCodecsInstance.Load(imageFileName, 1) 
 
      ' Create an OCR page from it 
      Using ocrPage As IOcrPage = ocrEngine.CreatePage(rasterImage, OcrImageSharingMode.AutoDispose) 
         ' Recognize 
         ocrPage.Recognize(Nothing) 
 
         ' Save the result as XML 
 
         ' First, non-formatted 
         Dim writeXmlOptions As New OcrWriteXmlOptions() 
         writeXmlOptions.Formatted = False 
         ocrPage.SaveXml(formattedFileName, 1, writeXmlOptions, OcrXmlOutputOptions.None) 
 
         ' Next, formatted with 4 spaces indentation 
         writeXmlOptions.Formatted = True 
         writeXmlOptions.Indent = "  " 
         ocrPage.SaveXml(nonFormattedFileName, 1, writeXmlOptions, OcrXmlOutputOptions.None) 
      End Using 
   End Using 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\LEADTOOLS21\Resources\Images" 
   Public Const OcrLEADRuntimeDir As String = "C:\LEADTOOLS21\Bin\Common\OcrLEADRuntime" 
End Class

Requirements

Target Platforms

Reference

OcrWriteXmlOptions Members

Leadtools.Ocr Namespace

Download our FREE evaluation

Help Version 21.0.2021.7.2

Leadtools.Ocr Assembly

Introduction

Getting Started

Namespaces

Leadtools.Ocr Namespace

Assemblies