Interface IResultRenderer
Assembly: IronOcr.dll
Syntax
public interface IResultRenderer
IResultRenderer is the contract for writing recognized Page results into an output document, such as a searchable PDF, hOCR file, or plain text export. A renderer accumulates pages and tracks how many it has written, so the same recognition pass can feed one multi-page document.
Three members define the contract. BeginDocument opens a new output document under a given title and returns an IDisposable that closes the document when disposed, so a using block frames the whole write. AddPage writes one recognized Page into the open document and returns whether the page was accepted. PageNumber reports how many pages have been rendered so far. Because the contract extends IDisposable, dispose the renderer to release its native output handle once every page is written, and dispose the document handle that BeginDocument returns to finalize the file on disk.
The searchable PDF how-to and the hOCR export how-to cover the high-level output that this rendering layer backs.
Properties
PageNumber
Declaration
Property Value
| Type |
Description |
| System.Int32 |
|
Methods
AddPage(Page)
Declaration
Parameters
| Type |
Name |
Description |
| Page |
page |
|
Returns
| Type |
Description |
| System.Boolean |
|
BeginDocument(String)
Declaration
IDisposable BeginDocument(string title)
Parameters
| Type |
Name |
Description |
| System.String |
title |
|
Returns
| Type |
Description |
| System.IDisposable |
|