Windows.Devices.Scanners.ScannerDeviceContract

Configures the file format when a scanner input source transfers acquired image data to the app.

Gets the default file format for the scan source at the beginning of a new scan session.

The file type.

Gets or sets the current file transfer format for image data acquisition from the device to the client app.

The file type.

Determines whether the input scanner supports the specified file format or not.

The file type. True if the specified file type is supported; otherwise False.

Queries and configures scan settings that are common to both Flatbed and Feeder sources.

Gets the actual horizontal and vertical scan resolution for the scan source, in DPI.

The horizontal and vertical resolution, in pixels.

Gets or sets the automatic crop mode.

The automatic crop mode for the scan.

Configures the current brightness level for capturing image data from the scan source. On a new scan session, the value of this property is the DefaultBrightness property.

The brightness level.

Gets the step size at which the brightness levels of the data source can be increased or decreased between the minimum and maximum values.

The step size to increment or decrement. A typical value is 1.

Gets or sets the color mode for the scan source. When a new scan session starts, this property is the same as the DefaultColorMode property.

The color mode.

Sets or gets the current contrast level for capturing image data from the scan source. At the beginning of a new scan session this property is set to the DefaultContrast property.

The contrast level.

Gets the step size at which the contrast levels of the data source can increase or decrease between the minimum and maximum values.

The step size to increment or decrement. The typical value is 1.

Gets the default brightness level for the scan source.

The default brightness level for the scanner.

Gets the default color mode for this scan source.

The color mode.

Gets the default contrast level for the scan source.

The default contrast level.

Gets or sets the horizontal and vertical scan resolution for the scan source that the app requests, in DPI.

The horizontal and vertical resolution, in pixels.

Gets the maximum brightness level supported by the scan source.

The maximum brightness level, typically 1000.

Gets the maximum contrast level supported by the scan source.

The maximum contrast level, typically 1000.

Gets the maximum horizontal and vertical scan resolution of the scan source in DPI.

The horizontal and vertical resolution, in pixels.

Gets the maximum scan area dimensions in inches. The maximum scan width is the longest width a document can have in order for the Feeder and Flatbed to scan it.

The width and height of the area.

Gets the minimum brightness level supported by the scan source.

The minimum brightness level, typically -1000.

Gets the minimum contrast level supported by the scan source.

The minimum contrast level, typically -1000.

Gets the minimum horizontal and vertical scan resolution of the scan source in DPI.

The horizontal and vertical resolution, in pixels.

Gets the minimum scan area in inches. The minimum scan area is the smallest size a document can have in order for a Flatbed or Feeder to scan it.

The width and height of the area.

Gets the optical horizontal and vertical scan resolution of the scan source in DPI.

The horizontal and vertical scan resolution in pixels.

Gets or sets the origin coordinates (horizontal and vertical) and dimensions (width and height) of the selected scan area, in inches. This property is ignored when the AutoCroppingMode property is not set to **Disabled**.

The location and size of a rectangle.

Determines if the scan source supports the specified ImageScannerAutoCroppingMode.

The auto crop mode of the image to scan. True if the device supports the *value* mode; otherwise False.

Determines if the scan source can scan and transfer images in the specified color mode.

The color mode. True if the scanner can scan images in *value* mode; otherwise False.

Represents the properties of images to scan.

Gets and sets the scan settings of the auto-configured scan unit, like the file format, including compression to deliver the scanned data in. This property is ignored if the scanner is not capable of auto-configuration.

The scan configuration. Null if the scanner is not capable of auto-configuration.

Gets the default scan source chosen for this scanner device.

The type of scan source.

Gets the PnP device identifier of this scanner device.

The PnP device identifier.

Gets or sets the scan settings of the Feeder scan unit, like page size, orientation, and scan resolution.

The scanner's Feeder configuration. Null if there is no Feeder.

Gets and sets the scan settings of the Flatbed scan unit, like scan resolution and color mode.

The scan configuration of the scanner's Flatbed. Null if there is no Flatbed.

Creates an instance of a ImageScanner object based on a scanners device information ID. This method is required for broker device enumeration.

The device information ID. See DeviceInformation.Id property. The ImageScanner object.

Returns the class selection string that apps can use to enumerate scanner devices. This method is required for the brokered device enumeration.

The class selection.

Determines if the specified scan source supports scan preview.

The scan source. Returns True if the specified scan source supports preview; otherwise False.

Determines if the specified scan source is available on the scanner.

The scan source. True if the scan source, Flatbed or Feeder, is available; otherwise False.

Starts a scan job with the specified scan source and writes one or multiple images to one multi-page file like TIFF, XPS, and PDF; or one or multiple single-page files like DIB, PNG, JPG, and TIFF to the specified folder location. Returns the progress of the scan.

The image scan source. The target folder location of the scanned file. The list of scanned image files from ImageScannerScanResult and the progress of the WIA scan job from UInt32, which indicates how many files were transferred to the target folder.

Scans one image from the specified scan source and applies the lowest scan resolution with the selected image file format.

The image scan source. The scanned image file. The progress of the scan and the scanned file format.

Represents the auto-configured scan source of the scanner.

The default file format for the scan source at the beginning of a new scan session.

The file type.

Gets or sets the current file transfer format for image data acquisition from the device to the client app.

The file type.

Determines if the input scanner supports the specified file format.

The file type. True if the specified file type is supported; otherwise False.

Specifies the automatic crop mode of the scanning device.

Automatic detection is disabled. At the beginning of a new scan session, the AutoCroppingMode property is set to this value by default.

Scan multiple scan regions into individual, separate images.

Scan a single scan region into individual, separate images.

Specifies the color modes for the scan source.

The device automatically detects the right color mode based on the scan content. In this case the decision between color, grayscale and black and white for example relies on the device, and not the app.

24-bit RGB color (3 channels at 8 bits per channel).

8 bit or 4 bit grayscale (1 channel at 8 or 4 bits per channel). If the device supports both 4 and 8 bit grayscale the DefaultColorMode property will use 8 bit.

1 bit bi-tonal, also called monochrome or ‘black and white’ (1 channel at 1 bit per channel).

Represents the Feeder scan source of the scanner.

Gets the actual horizontal and vertical scan resolution for the scanner's Feeder, in DPI.

The horizontal and vertical resolution, in pixels.

Gets or sets the automatic crop mode.

The automatic crop mode for the scan.

Gets or sets the page size automatic detection feature for the scanner's Feeder.

True if the page size automatic detection feature is enabled; otherwise False.

Gets or sets the current brightness level for capturing image data from the scanner's Feeder. At the beginning of a new scan session, this property is set to the DefaultBrightness property.

The current brightness level.

Gets the step size at which the brightness levels of the data source can be increased or decreased between the minimum and maximum values.

The step size to increment or decrement. A typical value is 1.

Returns True if the device can automatically detect at scan time the size of the document pages scanned through the Feeder; otherwise returns False.

True if the device can automatically detect at scan time the size of the document pages scanned through the Feeder; otherwise False.

Gets whether the scanner device is capable of scanning ahead from its Feeder.

Indicates whether or not the scanner's Feeder can scan ahead.

Gets whether the scanner's Feeder is capable of duplex scanning (scanning both document page sides, front and back). When scanning in duplex mode the same scan settings (such as color mode and scan resolution) are applied to scan both page sides.

Indicates whether duplex scanning is available.

Gets or sets the color mode for the scanner's Feeder.

The color mode.

Sets or gets the current contrast level for capturing image data from the scanner's Feeder. At the beginning of a new scan session this property is set to the DefaultContrast property.

The contrast level.

Gets the step size at which the contrast levels of the data source can increase or decrease between the minimum and maximum values.

The step size to increment or decrement. The typical value is 1.

Gets the default brightness level for the scanner's Feeder.

The default brightness level for the scanner.

Gets the default color mode for the scanner's Feeder.

The color mode.

Gets the default contrast level for the scanner's Feeder.

The default contrast level.

Gets the default file format for the scanner's Feeder at the beginning of a new scan session.

The file type.

Gets or sets the horizontal and vertical scan resolution for the scanner's Feeder that the app requests, in DPI.

The horizontal and vertical resolution, in pixels.

Indicates whether the scanner's Feeder can scan both document page sides.

Returns True if the Feeder can scan both page sides.

Gets or sets the current file transfer format for image data acquisition from the scanner's Feeder to the client app.

The file type.

Gets the maximum brightness level supported by the scanner's Feeder.

The maximum brightness level, typically 1000.

Gets the maximum contrast level supported by the scanner's Feeder.

The maximum contrast level, typically 1000.

Gets or sets the maximum number of pages-not images, the app can scan in one scan job, before the scanner stops.

The number of pages.

Gets the maximum horizontal and vertical scan resolution of the scanner's Feeder in DPI.

The horizontal and vertical resolution, in pixels.

Gets the maximum scan area dimensions in inches. The maximum scan width is the widest a document can be in order for the scanner's Feeder to scan it.

The width and height of the area.

Gets the minimum brightness level supported by the scanner's Feeder.

The minimum brightness level, typically -1000.

Gets the minimum contrast level supported by the scanner's Feeder.

The minimum contrast level, typically -1000.

Gets the minimum horizontal and vertical scan resolution of the scanner's Feeder in DPI.

The horizontal and vertical resolution, in pixels.

Gets the minimum scan area in inches. The minimum scan area is the smallest size a document can have in order for a Feeder to scan it.

The width and height of the area.

Gets the optical horizontal and vertical scan resolution of the scanner's Feeder in DPI.

The horizontal and vertical scan resolution in pixels.

Gets or sets the currently selected page orientation that tells how to place the documents in the scanner's Feeder input tray.

The orientation of the page.

Gets or sets the currently selected page size to scan from the Feeder.

The page size.

Gets the dimensions (width and height) and orientation of the selected page size, in mil units (1/1000").

The page size.

Indicates whether or not to scan ahead.

True to scan ahead.

The scan region, in inches.

Returns whether the scanner's Feeder supports the specified ImageScannerAutoCroppingMode.

The auto crop mode of the image to scan. Indicates whether the device supports *value* mode.

Returns whether the scanner's Feeder can scan and transfer images in the specified color mode.

The color mode. Indicates whether the scanner can scan images in *value* mode.

Determines whether the scanner's Feeder supports the specified file format or not.

The file type. Indicates whether the specified file type is supported.

Returns whether the Feeder can scan documents in the specified page size and orientation.

The page size. The page orientation. Indicates the scanner can scan with *pageSize* and *pageOrientation* values.

Represents the Flatbed scan source of the scanner.

Gets the actual horizontal and vertical scan resolution for the Flatbed scanner, in DPI.

The horizontal and vertical resolution, in pixels.

Gets or sets the automatic crop mode.

The automatic crop mode for the scan.

Gets or sets the current brightness level for capturing image data from the scanner's Flatbed. At the beginning of a new scan session, this property is set to the DefaultBrightness property.

The current brightness level.

Gets the step size at which the brightness levels of the data source can be increased or decreased between the minimum and maximum values.

The step size to increment or decrement. A typical value is 1.

Gets or sets the color mode for the Flatbed scanner.

The color mode.

Sets or gets the current contrast level for capturing image data from the scan source. At the beginning of a new scan session this property is set to the DefaultContrast property.

The contrast level.

Gets the step size at which the contrast levels of the data source can increase or decrease between the minimum and maximum values.

The step size to increment or decrement. The typical value is 1.

Gets the default brightness level for the scanner's Flatbed.

The default brightness level for the scanner.

Gets the default color mode for the scanner's Flatbed.

The color mode.

Gets the default contrast level for the scanner's Flatbed.

The default contrast level.

Gets the default file format for the scanner's Flatbed at the beginning of a new scan session.

The file type.

Gets or sets the horizontal and vertical scan resolution for the scanner's Flatbed that the app requests, in DPI.

The horizontal and vertical resolution, in pixels.

Gets or sets the current file transfer format for image data acquisition from the scanner's Flatbed to the client app.

The file type.

Gets the maximum brightness level supported by the scanner's Flatbed.

The maximum brightness level, typically 1000.

Gets the maximum contrast level supported by the scanner's Flatbed.

The maximum contrast level, typically 1000.

Gets the maximum horizontal and vertical scan resolution of the scanner's Flatbed in DPI.

The horizontal and vertical resolution, in pixels.

Gets the maximum scan area dimensions in inches. The maximum scan width is the widest a document can be in order for the scanner's Flatbed to scan it.

The width and height of the area.

Gets the minimum brightness level supported by the scanner's Flatbed.

The minimum brightness level, typically -1000.

Gets the minimum contrast level supported by the scanner's Flatbed.

The minimum contrast level, typically -1000.

Gets the minimum horizontal and vertical scan resolution of the scanner's Flatbed in DPI.

The horizontal and vertical resolution, in pixels.

Gets the minimum scan area in inches. The minimum scan area is the smallest size a document can have in order for a Flatbed to scan it.

The width and height of the area.

Gets the optical scan resolution of the Flatbed scanner in DPI.

The horizontal and vertical scan resolution in pixels.

The location and size of a rectangle.

Returns whether the scanner's Flatbed supports the specified ImageScannerAutoCroppingMode.

The auto crop mode of the image to scan. Indicates whether the device supports *value* mode.

Returns whether the scanner's Flatbed can scan and transfer images in the specified color mode.

The color mode. Indicates whether the scanner can scan images in *value* mode.

Determines whether the scanner's Flatbed supports the specified file format or not.

The file type. Indicates whether the specified file type is supported.

The type of files to scan to.

Windows Device Independent Bitmap (DIB) This value supports any color mode, with single page and uncompressed. This is the only format that is supported by all compatible WIA 2.0 scanner devices.

Exchangeable image file format/EXIF or JPEG file interchange format/JFIF Use these files only in color or grayscale modes (8 bits per channel/sample), with single page and compressed (lossy JPEG compression).

Open XML Paper Specification (OpenXPS) document file format These files can contain image data in any color mode supported by this API, compressed at the choice of the device, either single or multi-page.

Portable Document Format PDF/A (PDF/A is an ISO-standardized version of the Portable Document Format/PDF specialized for the digital preservation of electronic documents) document file format These files can contain image data in any color mode supported by this API, compressed at the choice of the device, either single or multi-page.

Portable Network Graphics (PNG) image file format This value supports any color mode, with single page and compressed (loseless PNG compression).

Uncompressed Tagged Image File Format (TIFF) compatible with the TIFF 6.0 specification, either single and/or multi-page These files can be in any color mode supported by this API, always uncompressed and either single page (if only one image has to be transferred) or multi-page (if multiple images have to be transferred and the device supports this multi-page file format).

Microsoft XML Paper Specification (XPS) document file format These files can contain image data in any color mode supported by this API, compressed at the choice of the device, either single or multi-page.

Represents the result of a preview scan job.

Gets the format of the data for the scan preview. After preview this property is restored to the value before preview.

The scan format.

Gets whether the scan preview was successful.

True if scan preview was successful; otherwise False.

Specifies the scan resolution.

The horizontal size.

The vertical size.

Represents the result of a scan job.

Gets the list of scanned image files that was produced by the completed scan job.

A list of scanned image files from the completed scan job. If there is no scanned file, the IVectorView<T>.Size property will be 0.

The types of scan source for the scanning device.

The scan source is automatically configured.

The default source.

A Feeder scan source.

A Flatbed scan source.