ScanFileFormat Property

Summary

Gets or sets the file format to use when saving the files from the TWAIN source.

Syntax

C++/CLI

Python

public TwainFileFormat ScanFileFormat { get; set; }

public: 
property TwainFileFormat ScanFileFormat { 
   TwainFileFormat get(); 
   void set (    TwainFileFormat ); 
}

ScanFileFormat # get and set (TwainDataTransferProperties)

Property Value

The file format to use when saving the files from the TWAIN source. Possible values are (according to the TWAIN specification):

TwainCapabilityValue.FileFormatTiff Tagged image file
TwainCapabilityValue.FileFormatPict Macintosh PICT
TwainCapabilityValue.FileFormatBmp Windows regular bitmap
TwainCapabilityValue.FileFormatXbm X-Windows bitmap
TwainCapabilityValue.FileFormatJfif JPEG file interchange format
TwainCapabilityValue.FileFormatFpx Flash pix file
TwainCapabilityValue.FileFormatTiffMulti Multipage tiff file format
TwainCapabilityValue.FileFormatPng PNG file
TwainCapabilityValue.FileFormatSpiff SPIFF file
TwainCapabilityValue.FileFormatExif EXIF file

Example

using Leadtools; 
using Leadtools.Twain; 
 
 
public void DataTransferPropertyExample(IntPtr parent) 
{ 
   try 
   { 
      TwainSession session = new TwainSession(); 
      session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None); 
 
      TwainProperties props = session.Properties; 
      TwainDataTransferProperties dataTransfer = props.DataTransfer; 
 
      dataTransfer.FillOrder = TwainDataTransferFillOrder.LsbFirst; 
      dataTransfer.BufferedMemoryCompression = TwainCompressionMode.None; 
      dataTransfer.TransferMechanism = TwainTransferMechanism.Memory; 
      dataTransfer.ScanFileFormat = TwainFileFormat.Bmp; 
      dataTransfer.MemoryBufferSize = 1024; 
      dataTransfer.SaveToOneFile = true; 
      dataTransfer.AppendToFile = false; 
      dataTransfer.DumpMemoryBuffersToFile = true; 
      dataTransfer.FileName = Path.Combine(LEAD_VARS.ImagesDir, "test.bmp"); 
 
      props.DataTransfer = dataTransfer; 
      session.Properties = props; 
      session.Shutdown(); 
   } 
   catch (Exception ex) 
   { 
      MessageBox.Show(ex.Message); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

Requirements

Target Platforms

Reference

TwainDataTransferProperties Structure

TwainDataTransferProperties Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Twain Assembly

Introduction

Getting Started

Namespaces

Leadtools.Twain Namespace

Assemblies