Click or drag to resize
Pdftools logo

OcrOptions Class

The options for OCR processing

This class aggregates all OCR processing options including resolution settings, image processing, text processing and page processing.
Inheritance Hierarchy
SystemObject
  PdfTools.InternalNativeBase
    PdfTools.InternalNativeObject
      PdfTools.OcrOcrOptions

Namespace: PdfTools.Ocr
Assembly: PdfTools (in PdfTools.dll) Version: 1.16.0+362ed17524d0f96db0bdf45362ca9dfd8e1a4428
Syntax
C#
public class OcrOptions : NativeObject

The OcrOptions type exposes the following members.

Constructors
 NameDescription
Public methodOcrOptions 
Top
Properties
 NameDescription
Public propertyDpi

The default resolution in DPI used for OCR

Each page's optimal OCR resolution is determined automatically, such that all images and text can be recognized. The default resolution is chosen if it is within the range of optimal resolutions.

The range should be within the resolutions supported by the OCR engine. Most OCR engines are optimized for resolutions around 300 DPI.

Default value: 300.0

Public propertyImageOptions

The options for image processing

Options controlling how images in the PDF are processed during OCR.
Public propertyMaxDpi

The maximum resolution in DPI used for OCR

Default value: 400.0
Public propertyMinDpi

The minimum resolution in DPI used for OCR

Default value: 200.0
Public propertyPageOptions

The options for page processing

Options controlling page-level OCR processing and tagging.
Public propertyProcessEmbeddedFiles

Whether to process embedded files recursively

If enabled, embedded PDF files are also processed with OCR. The default is to copy all embedded files as-is.

Default value:

Public propertyTextOptions

The options for text processing

Options controlling how existing text is processed during OCR.
Top
Methods
 NameDescription
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Top
See Also