FileFormat Property

Summary

Gets or sets the transfer file format to use when transferring data from the current TWAIN source. This property is valid only if the TransferMode property is set to TwainTransferFile.

Syntax

C++/CLI

Python

public RasterImageFormat FileFormat { get; set; }

public: 
property RasterImageFormat FileFormat { 
   RasterImageFormat get(); 
   void set (    RasterImageFormat ); 
}

FileFormat # get and set (TwainTransferOptions)

Property Value

The transfer file format to be used when the transfer mode is file.

Remarks

To update this property with the current value, call the TransferOptions property. To set the file format, assign a new value to this property and call the TransferOptions property.

Example

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:\LEADTOOLS23\Resources\Images"; 
}

Requirements

Target Platforms

Reference

TwainTransferOptions Structure

TwainTransferOptions Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Twain Assembly

Introduction

Getting Started

Namespaces

Leadtools.Twain Namespace

Assemblies