Click or drag to resize
Pdftools logo

BarcodeOptions Class

Options for barcode and QR code recognition

Detected barcodes are written either to the document's XMP metadata (Embed) or to a caller-supplied XML stream (Extract), depending on Mode.

Barcode detection is performed by the OCR engine and depends on the type and settings of the engine as well as the parameters ImageOptions and PageOptions. To enable recognition, all three of the following must be configured: (1) pass an engine created with Engine.Create("barcodes") to Process(Document, Engine, Stream, OcrOptions, OutputOptions); (2) set Mode to Embed or Extract; (3) configure PageOptions or ImageOptions so that pages are submitted to the engine (typically Mode = All).

Setting Mode alone has no effect.

Note: Available only on Windows x86 and x64.

Inheritance Hierarchy
SystemObject
  PdfTools.InternalNativeBase
    PdfTools.InternalNativeObject
      PdfTools.OcrBarcodeOptions

Namespace: PdfTools.Ocr
Assembly: PdfTools (in PdfTools.dll) Version: 1.19.0+2160c7724ea9111cae8ed0e8ced3b10611191789
Syntax
C#
public class BarcodeOptions : NativeObject

The BarcodeOptions type exposes the following members.

Constructors
 NameDescription
Public methodBarcodeOptions 
Top
Properties
 NameDescription
Public propertyMode

How recognized barcodes are returned

Default value: None
Public propertyXmlOutputStream

Stream that receives recognized barcodes as XML

Required if and only if Mode is Extract.

Default value:

Top
Methods
 NameDescription
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Top
See Also