Leadtools.Twain Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
ImageUnit Property
See Also  Example
Leadtools.Twain Namespace > TwainSession Class : ImageUnit Property



Gets or sets the image unit value used to transfer images from the current TWAIN source.

Syntax

Visual Basic (Declaration) 
Public Property ImageUnit As TwainImageUnit
Visual Basic (Usage)Copy Code
Dim instance As TwainSession
Dim value As TwainImageUnit
 
instance.ImageUnit = value
 
value = instance.ImageUnit
C# 
public TwainImageUnit ImageUnit {get; set;}
C++/CLI 
public:
property TwainImageUnit ImageUnit {
   TwainImageUnit get();
   void set (TwainImageUnit value);
}

Return Value

The image unit value used to transfer images from the current TWAIN source.

Example

Visual BasicCopy Code
Public Sub ImageUnitPropertyExample(ByVal parent As IWin32Window)
   Dim session As TwainSession = New TwainSession()
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None)

   Dim unit As Integer = CInt(session.ImageUnit)
   Dim bpp As Integer = session.ImageBitsPerPixel

   If unit <> CInt(TwainCapabilityValue.UnitInches) Then
      session.ImageUnit = CType(TwainCapabilityValue.UnitInches, TwainImageUnit)
   End If

   If bpp <> 24 Then
      session.ImageBitsPerPixel = 24
   End If

   session.Shutdown()
End Sub
C#Copy Code
public void ImageUnitPropertyExample(IWin32Window parent) 
{ 
   TwainSession session = new TwainSession(); 
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None); 
 
   int unit = (int)session.ImageUnit; 
   int bpp = session.ImageBitsPerPixel; 
 
   if (unit != (int)TwainCapabilityValue.UnitInches) 
      session.ImageUnit = (TwainImageUnit)TwainCapabilityValue.UnitInches; 
 
   if (bpp != 24) 
      session.ImageBitsPerPixel = 24; 
 
   session.Shutdown(); 
}

Remarks

This property internally gets or sets the image unit capability ICAP_UNITS. For more information on this capability, refer to http://www.twain.org and click on TWAIN Specification (Version 2.0).

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also