ImageType Property

Summary

Gets or sets the application's intended use of the image.

Syntax

C++/CLI

Python

public WiaImageType ImageType { get; set; }

public: 
property WiaImageType ImageType { 
   WiaImageType get(); 
   void set (    WiaImageType ); 
}

ImageType # get and set (WiaProperties)

Property Value

The application's intended use of the image. The device uses this value to change its settings. The settings change depending upon how the image will be used. Possible values are (according to Microsoft SDK documentation):

WiaImageType.None	Default value. No intent is specified.
WiaImageType.Color	The application intends to prepare the device for a color scan.
WiaImageType.Grayscale	The application intends to prepare the device for a grayscale scan.
WiaImageType.Text	The application intends to prepare the device for scanning text.
WiaImageType.Mask	Mask for all of the image-type flags.
WiaImageType.MinimizeSize	The application intends to prepare the device for scanning an image that result's in a small scan.
WiaImageType.MaximizeQuality	The application intends to prepare the device for scanning a high-quality image.
WiaImageType.SizeMask	This flag is a mask for all of the size/quality flags.
WiaImageType.BestPreview	The application intends to prepare the device for scanning a preview.

For more information about these image types, refer to the WIA_IPS_CUR_INTENT property ID in Microsoft Windows SDK Documentation.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Wia; 
 
 
WiaSession wiaSession; 
       
public void GetRootItemExample(IntPtr parent) 
{ 
   if (!WiaSession.IsAvailable(WiaVersion.Version1)) 
   { 
      Console.WriteLine("WIA version 1.0 not installed."); 
      return; 
   } 
   wiaSession = new WiaSession(); 
   wiaSession.Startup(WiaVersion.Version1); 
 
   DialogResult res = wiaSession.SelectDeviceDlg(parent, WiaDeviceType.Default, WiaSelectSourceFlags.NoDefault); 
   if (res != DialogResult.OK) 
   { 
      Console.WriteLine("Error selecting WIA device."); 
      wiaSession.Shutdown(); 
      return; 
   } 
 
   object rootItem = wiaSession.GetRootItem(null); 
   if (rootItem != null) 
   { 
      wiaSession.EnumItemsEvent += new EventHandler<WiaEnumItemsEventArgs>(wiaSession_EnumItemsEvent); 
 
      wiaSession.EnumChildItems(rootItem); 
 
      wiaSession.EnumItemsEvent -= new EventHandler<WiaEnumItemsEventArgs>(wiaSession_EnumItemsEvent); 
   } 
 
   wiaSession.Shutdown(); 
} 
 
void wiaSession_EnumItemsEvent(object sender, WiaEnumItemsEventArgs e) 
{ 
   if (e.Item != null) 
   { 
      WiaDataTransferProperties dataTransfer = WiaDataTransferProperties.Empty; 
      WiaImageEffectsProperties imageEffects = WiaImageEffectsProperties.Empty; 
 
      WiaProperties properties = wiaSession.GetProperties(e.Item); 
 
      dataTransfer.ImageDataType = WiaImageDataType.Grayscale; 
      imageEffects.Brightness = 250; 
 
      properties.DataTransfer = dataTransfer; 
      properties.ImageEffects = imageEffects; 
      properties.ScanningMode = WiaScanningModeFlags.Feeder;   // set scanning source to Feeder 
      properties.MaximumNumberOfPages = 0;                     // scan all pages in feeder 
      properties.ImageType = WiaImageType.Grayscale; 
      properties.Orientation = WiaOrientation.Portrait; 
 
      WiaImageResolutionProperties imageResolution = properties.ImageResolution; 
      imageResolution.BitsPerPixel = 8; 
      imageResolution.HorizontalResolution = 600; 
      imageResolution.VerticalResolution = 600; 
      properties.ImageResolution = imageResolution; 
 
      wiaSession.SetPropertiesEvent += new EventHandler<WiaSetPropertiesEventArgs>(wiaSession_SetPropertiesEvent); 
 
      wiaSession.SetProperties(e.Item, properties); 
 
      wiaSession.SetPropertiesEvent -= new EventHandler<WiaSetPropertiesEventArgs>(wiaSession_SetPropertiesEvent); 
 
      wiaSession.FreeItem(e.Item); 
   } 
} 
 
void wiaSession_SetPropertiesEvent(object sender, WiaSetPropertiesEventArgs e) 
{ 
   if (e.Error <= 0) 
   { 
      Console.WriteLine("Failed to set the below property:\n\tProperty Id: {0}\n\tProperty Value: {1}\n\tError: {2}\n\n", e.PropertyId.ToString(), e.Value.ToString(), e.Error.ToString()); 
   } 
}

Requirements

Target Platforms

Reference

WiaProperties Structure

WiaProperties Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Wia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Wia Namespace

Assemblies