Share via


ImageScanner Class

Definition

Represents the properties of images to scan.

public ref class ImageScanner sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Devices.Scanners.ScannerDeviceContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ImageScanner final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Devices.Scanners.ScannerDeviceContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ImageScanner
Public NotInheritable Class ImageScanner
Inheritance
Object Platform::Object IInspectable ImageScanner
Attributes

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

AutoConfiguration

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.

DefaultScanSource

Gets the default scan source chosen for this scanner device.

DeviceId

Gets the PnP device identifier of this scanner device.

FeederConfiguration

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

FlatbedConfiguration

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

Methods

FromIdAsync(String)

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

GetDeviceSelector()

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

IsPreviewSupported(ImageScannerScanSource)

Determines if the specified scan source supports scan preview.

IsScanSourceSupported(ImageScannerScanSource)

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

ScanFilesToFolderAsync(ImageScannerScanSource, StorageFolder)

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.

ScanPreviewToStreamAsync(ImageScannerScanSource, IRandomAccessStream)

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

Applies to

See also