Share via


IImageScannerSourceConfiguration Interface

Definition

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
public interface class IImageScannerSourceConfiguration : IImageScannerFormatConfiguration
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Devices.Scanners.ScannerDeviceContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(3216310357, 2884, 19586, 158, 137, 32, 95, 156, 35, 78, 89)]
struct IImageScannerSourceConfiguration : IImageScannerFormatConfiguration
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Devices.Scanners.ScannerDeviceContract), 65536)]
[Windows.Foundation.Metadata.Guid(3216310357, 2884, 19586, 158, 137, 32, 95, 156, 35, 78, 89)]
public interface IImageScannerSourceConfiguration : IImageScannerFormatConfiguration
Public Interface IImageScannerSourceConfiguration
Implements IImageScannerFormatConfiguration
Derived
Attributes
Implements

Windows requirements

Device family
Windows Desktop Extension SDK (introduced in 10.0.10240.0)
API contract
Windows.Devices.Scanners.ScannerDeviceContract (introduced in v1.0)

Properties

ActualResolution

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

AutoCroppingMode

Gets or sets the automatic crop mode.

When automatic detection is enabled on the scan source, the automatic crop mode indicates whether to scan one region or multiple regions. When a new scan session starts, the default value is Disabled.

Brightness

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

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

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

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

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

DefaultBrightness

Gets the default brightness level for the scan source.

DefaultColorMode

Gets the default color mode for this scan source.

DefaultContrast

Gets the default contrast level for the scan source.

DefaultFormat

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

(Inherited from IImageScannerFormatConfiguration)
DesiredResolution

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

Format

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

(Inherited from IImageScannerFormatConfiguration)
MaxBrightness

Gets the maximum brightness level supported by the scan source.

MaxContrast

Gets the maximum contrast level supported by the scan source.

MaxResolution

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

MaxScanArea

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

Gets the minimum brightness level supported by the scan source.

MinContrast

Gets the minimum contrast level supported by the scan source.

MinResolution

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

MinScanArea

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

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

SelectedScanRegion

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.

Methods

IsAutoCroppingModeSupported(ImageScannerAutoCroppingMode)

Determines if the scan source supports the specified ImageScannerAutoCroppingMode.

IsColorModeSupported(ImageScannerColorMode)

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

IsFormatSupported(ImageScannerFormat)

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

(Inherited from IImageScannerFormatConfiguration)

Applies to

See also