Class OcrResultPagesCollection
Class for managing the collection of OcrResult.Page elements.
Inheritance
Implements
Namespace: IronOcr.OcrResults
Assembly: IronOcr.dll
Syntax
public class OcrResultPagesCollection : List<OcrResult.Page>, IOcrPageCollectionOcrResultPagesCollection is the concrete list of pages an OCR read returns, the value you iterate to work through a document page by page. It holds every OcrResult.Page the engine produced, in order, ready to enumerate or index.
You obtain it from a finished read: OcrResult.Pages returns an OcrResultPagesCollection. Because the collection is a List<OcrResult.Page>, everything you expect from a generic list is available, including indexing with result.Pages[0], a Count, and foreach. It also implements IOcrPageCollection, so a method typed to that read-only contract accepts it directly.
The type adds little of its own on purpose: a Length property reports the page count (a synonym for the list's Count), and the rest is the inherited list behavior. The practical guidance is to enumerate the collection and read each OcrResult.Page through its own members; index into it when you need a specific page, such as the first page of a single-image read. Treat the contents as the result of the read rather than a list to mutate.
The OCR results objects example iterates the pages collection, and the read PDFs how-to produces one page per PDF page to walk.
Constructors
OcrResultPagesCollection(List<OcrResult.Page>)
Create new page collection using the specified client and document identifier
Declaration
public OcrResultPagesCollection(List<OcrResult.Page> input)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<OcrResult.Page> | input |
Properties
Length
Count
Declaration
public int Length { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |