Leadtools TWAIN (Leadtools.Twain assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.30
TransferOptions Property
See Also 
Leadtools.Twain Namespace > TwainSession Class : TransferOptions Property



Gets and sets the options used for transferring data from the current TWAIN source.

Syntax

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

Property Value

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

Example

Visual BasicCopy Code
Public Sub TransferOptionsPropertyExample(ByVal parent As IWin32Window)
      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
C#Copy Code
public void TransferOptionsPropertyExample(IWin32Window 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";
}

Remarks

Gets and sets transfer options to the selected Twain source.

Set the following properties before calling this method:

TransferMode Property

TwainTransferOptions.FileName Property

TwainTransferOptions.FileFormat Property

TwainTransferOptions.CompressionMode Property

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also