SaveZones(string,OcrWriteXmlOptions) Method

Summary

Saves zones to a multipage zones disk file with XML options.

Syntax

Objective-C

C++

Java

public void SaveZones( 
   string fileName, 
   OcrWriteXmlOptions xmlOptions 
)

Overloads Sub SaveZones( _ 
   ByVal fileName As String, _ 
   ByVal xmlOptions As OcrWriteXmlOptions _ 
)

- (void)saveZonesToFile:(NSString *)fileName 
        xmlWriteOptions:(nullable LTOcrWriteXmlOptions *)xmlWriteOptions 
                  error:(NSError **)error

public void saveZones(String fileName, 
                      OcrWriteXmlOptions xmlOptions)

void SaveZones(  
   String^ fileName, 
   OcrWriteXmlOptions^ xmlOptions 
)

Parameters

fileName
The name of the file that will contain the zones data.

xmlOptions
Options to use when writing the XML data.

Remarks

To save and load the zones of OCR pages, you can use one of these methods:

IOcrPage.SaveZones(fileName) or IOcrPage.SaveZones(stream): These methods save the zones of a particular OCR page to a single-page disk file or stream. These methods will not use the page number, and hence, the file or stream will contain zones that are not tied to any particular page and can be loaded back into any OCR page regardless of its number. To load these zones back into any OCR page, use IOcrPage.LoadZones(fileName) or IOcrPage.LoadZones(stream).
IOcrPage.SaveZones(fileName, pageNumber) or IOcrPage.SaveZones(stream, pageNumber): These methods save the zones of a particular OCR page to a multipage disk file or stream. If the file or stream exist previously, these methods will replace the zones specified in 'pageNumber' with the zones of the IOcrPage. If the file or stream does not contain zones for the specified page number, the zones will be appended to the file or stream at the end and can be loaded later using IOcrPage.LoadZones(fileName, pageNumber) or IOcrPage.LoadZones(stream, pageNumber).
IOcrDocument.SaveZones(fileName) or IOcrDocument.SaveZones(stream): These methods save the zones of all the OCR pages in a document to a multipage disk file or stream. The saved data will contain the page number of the zones. To load these zones, you can either use IOcrDocument.LoadZones(fileName) or IOcrDocument.LoadZones(stream) to load the zones from a multipage file or stream back into a multipage OCR document. Or IOcrPage.LoadZones(fileName, pageNumber) and IOcrPage.LoadZones(stream, pageNumber) to load any single page from a multipage OCR document into a particular OCR page.

Note on loading zones from a multipage zone file: If the file does not contain zones data with the correct page number, the engine will not load any zones for this page. After the method returns, any OCR page that did not have zones data will contain zero zones. (the IOcrPage.Zones property contains 0 items). You can then use IOcrPage.AutoZone if required to re-zone this page.

Use IOcrDocument.LoadZones(fileName) or IOcrPage.LoadZones(fileName, pageNumber) to load all or one page zones saved by this method.

To load and save the zones to a .NET stream, use IOcrDocument.SaveZones(stream), IOcrDocument.LoadZones(stream) and IOcrPage.LoadZones(stream, pageNumber).

Example

For an example, refer to IOcrDocument.SaveZones(fileName).

Requirements

Target Platforms