Class BarcodePage

Namespace: LMKit.Extraction.Barcodes

Assembly: LM-Kit.NET.dll

One scanned page: the barcodes read on it and, after a split, the role it played. Returned by ReadPages(Attachment, string, int, CancellationToken) and in Pages.

public sealed class BarcodePage

Inheritance: object

BarcodePage

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

Barcodes: Gets the barcodes that count, in reading order (top to bottom, then left to right). For ReadPages(Attachment, string, int, CancellationToken), every barcode read.

Error: Gets the error that kept the page from being read (it could not be rendered or decoded), or null. A page in error is never a separator or a marker: it stays content, and the failure is reported here instead of being hidden.

FirstBarcode: Gets the first barcode that counts, or null.

IgnoredBarcodes: Gets the barcodes read on the page that a BarcodeMatchRule rejected.

IsBlank: Gets whether the page was found blank. Blankness is only checked when a blank page can be removed (RemoveBlankPages or RemoveBlankPageAfterSeparator); otherwise false.

PageIndex: Gets the zero-based page index.

PageNumber: Gets the 1-based page number.

Role: Gets the role the page played in a split; Content for a plain read.

SegmentIndex: Gets the index of the document the page belongs to in Segments, or -1 when it belongs to none.

Methods

ToString()