TransferOptions Property

C#
Visual Basic
Java
Objective-C
C++

public TwainTransferOptions TransferOptions {get; set;}

'Declaration

Public Property TransferOptions As TwainTransferOptions

'Usage

Dim instance As TwainSession
Dim value As TwainTransferOptions
 
instance.TransferOptions = value
 
value = instance.TransferOptions

public:
property TwainTransferOptions TransferOptions {
   TwainTransferOptions get();
   void set (    TwainTransferOptions value);
}

Property Value

Options to be used for transferring data from the current TWAIN source

Gets and sets transfer options to the selected TWAIN source.
Set the following properties before calling this method:
TransferMode Property
FileName Property
FileFormat Property
CompressionMode Property

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Twain

Public Sub TransferOptionsPropertyExample(ByVal parent As IntPtr)
   Dim session As TwainSession = New TwainSession()
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None)

   Dim opts As TwainTransferOptions = session.TransferOptions

   opts.TransferMode = TwainTransferMode.File
   opts.FileName = Path.Combine(LEAD_VARS.ImagesDir, "test.bmp")
   opts.FileFormat = RasterImageFormat.Bmp
   opts.CompressionMode = TwainCompressionMode.None

   session.TransferOptions = opts

   If session.IsTransferModeAvailable(TwainTransferMode.File) Then
      MessageBox.Show("File transfer is supported")
   End If

   If session.IsTransferModeAvailable(TwainTransferMode.Buffer) Then
      MessageBox.Show("Memory transfer is supported")
   End If

   If session.IsTransferModeAvailable(TwainTransferMode.Native) Then
      MessageBox.Show("Native transfer is supported")
   End If

   session.Shutdown()
End Sub

Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

using Leadtools;
using Leadtools.Twain;

public void TransferOptionsPropertyExample(IntPtr parent)
{
   TwainSession session = new TwainSession();
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None);
   TwainTransferOptions opts = session.TransferOptions;

   opts.TransferMode = TwainTransferMode.File;
   opts.FileName = Path.Combine(LEAD_VARS.ImagesDir, "test.bmp");
   opts.FileFormat = RasterImageFormat.Bmp;
   opts.CompressionMode = TwainCompressionMode.None;

   session.TransferOptions = opts;

   if (session.IsTransferModeAvailable(TwainTransferMode.File))
      MessageBox.Show("File transfer is supported");

   if (session.IsTransferModeAvailable(TwainTransferMode.Buffer))
      MessageBox.Show("Memory transfer is supported");

   if (session.IsTransferModeAvailable(TwainTransferMode.Native))
      MessageBox.Show("Native transfer is supported");

   session.Shutdown();
}

static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Target Platforms

Reference

TwainSession Class
TwainSession Members
Startup Method
Shutdown Method
Acquire Method
MaximumTransferCount Property
DuplexScanningMode Property
EnableDuplexScanning Property
AcquirePageOptions Property
ImageEffects Property
ImageBitsPerPixel Property
ImageUnit Property
ImageFrame Property
IsTransferModeAvailable Method
ShowProgressIndicator Method