Table of Contents

Namespace NAPS2.Scan

Classes

BarcodeDetectionOptions

Options for detecting barcodes using ZXing.

BitDepthCaps

Represents valid values for ScanOptions.BitDepth as part of PerSourceCaps.

DpiCaps

Represents valid values for ScanOptions.Dpi as part of PerSourceCaps.

EsclOptions

Scanning options specific to the ESCL driver.

KeyValueScanOptions

A set of key-value options used for scanning.

This is only relevant for SANE. Currently NAPS2 does not actually support viewing/setting custom options. If someone was so inclined they could manually set them in the profiles.xml file.

MetadataCaps

Represents scanner metadata as part of ScanCaps.

PageEndEventArgs
PageProgressEventArgs
PageSizeCaps

Represents valid values for ScanOptions.PageSize as part of PerSourceCaps.

PageStartEventArgs
PaperSourceCaps

Represents valid values for ScanOptions.PaperSource as part of ScanCaps.

PerSourceCaps

Represents capabilities specific to a single PaperSource as part of ScanCaps.

SaneOptions

Scanning options specific to the SANE driver.

ScanCaps

Represents scanner capabilities. This includes valid values for scanning options and extra metadata beyond just the device name and id.

ScanController

The main entry point for scanning with NAPS2.

ScanDevice

The representation of a scanning device and its corresponding driver.

ScanEndEventArgs
ScanOptions

Represents the options used for scanning.

ScanningContext

A ScanningContext object is needed for most NAPS2 operations. Set it up with the corresponding ImageContext type for image type you expect (e.g. GdiImageContext for System.Drawing.Bitmap, if you're using Windows Forms). You can also set various other properties that affect scanning and image processing.

When the ScanningContext is disposed, all ProcessedImage objects that were generating from scanning or importing with that ScanningContext object will be automatically disposed.
ScanningContextExtensions
TwainOptions

Scanning options specific to the TWAIN driver.

WiaOptions

Scanning options specific to the WIA driver.

Enums

Driver

Specifies the driver type to be used for performing the actual scan. Available options depend on the platform.
See https://github.com/cyanfish/naps2/tree/master/NAPS2.Sdk#drivers for more details.

HorizontalAlign

Specifies the alignment of the physical page on a flatbed scanner.

PaperSource

Specifies the physical paper source for devices that have multiple options (Flatbed, Feeder, Duplex).

TwainDsm

The data source manager (DSM) to use for TWAIN.

TwainTransferMode

The transfer mode to use for TWAIN.

WiaApiVersion

WIA version used for scanning (1.0 or 2.0). Generally 2.0 is preferred as it has better support for feeders.