Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IImageScannerSourceConfiguration interface

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

The scan settings are:

  • Scan region coordinates
  • Scan resolution
  • Color mode

Syntax


public interface IImageScannerSourceConfiguration : IImageScannerFormatConfiguration

Members

The IImageScannerSourceConfiguration interface has these types of members:

Methods

The IImageScannerSourceConfiguration interface has these methods. It also inherits methods from the Object class.

MethodDescription
IsAutoCroppingModeSupported Determines if the scan source supports the specified ImageScannerAutoCroppingMode.
IsColorModeSupported Determines if the scan source can scan and transfer images in the specified color mode.

 

Properties

The IImageScannerSourceConfiguration interface has these properties.

PropertyAccess typeDescription

ActualResolution

Read-only

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

AutoCroppingMode

Read/write

Gets or sets the automatic crop mode.

Brightness

Read/write

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.

BrightnessStep

Read-only

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

ColorMode

Read/write

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.

Contrast

Read/write

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.

ContrastStep

Read-only

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

DefaultBrightness

Read-only

Gets the default brightness level for the scan source.

DefaultColorMode

Read-only

Gets the default color mode for this scan source.

DefaultContrast

Read-only

Gets the default contrast level for the scan source.

DesiredResolution

Read/write

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

MaxBrightness

Read-only

Gets the maximum brightness level supported by the scan source.

MaxContrast

Read-only

Gets the maximum contrast level supported by the scan source.

MaxResolution

Read-only

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

MaxScanArea

Read-only

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.

MinBrightness

Read-only

Gets the minimum brightness level supported by the scan source.

MinContrast

Read-only

Gets the minimum contrast level supported by the scan source.

MinResolution

Read-only

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

MinScanArea

Read-only

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.

OpticalResolution

Read-only

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

SelectedScanRegion

Read/write

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.

 

Remarks

For Feeder scan sources, there are restrictions for the maximum scan area:

  • The currently selected page size, if page size auto-detection is not enabled.
  • The dimensions of the selected page size, which becomes the new maximum dimensions of the permissible scan area.

These limits are dictated by hardware for Feeder, Flatbed and other types of scan sources.

Requirements (Windows 10 device family)

Device family

Desktop, introduced version 10.0.10240.0

API contract

Windows.Devices.Scanners.ScannerDeviceContract, introduced version 1.0

Namespace

Windows.Devices.Scanners
Windows::Devices::Scanners [C++]

Metadata

Windows.Devices.Scanners.ScannerDeviceContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Minimum supported phone

None supported

Namespace

Windows.Devices.Scanners
Windows::Devices::Scanners [C++]

Metadata

Windows.winmd

Attributes

[Version(0x06030000)]

See also

IImageScannerFormatConfiguration

 

 

Show: