←Select platform

TwainSession Class Members

Summary

The following tables list the members exposed by TwainSession.

Public Constructors

Name Description
TwainSession Constructs a new TwainSession object with default values.

Public Methods

Name Description
Acquire Acquires one or more images from a TWAIN source.
AcquireFast (Document/Medical only) Acquires one or more images from a TWAIN source and stores the images in the specified file(s).
AcquireFast2 (Document/Medical only) Acquires one or more images from a TWAIN source and stores the images in the specified file(s).
AcquireToImage Acquires one image from a TWAIN source.
FindConfiguration (Document/Medical only) Gets all available configurations for the current session.
FindFastConfiguration (Document/Medical only) Determines the best scanner configuration.
GetCapability Gets the TwainCapability value at the specified index from the array of capabilities supported by the selected TWAIN source.
GetDeviceEventCapability Gets device events capability values for current TWAIN session.
GetDeviceEventData Gets information for specific device event
GetJpegCompression Gets the current or default JPEG compression settings for the TWAIN session.
GetVersion Gets the TWAIN version currently used by this twain session.
IsAvailable Determines whether a TWAIN source is installed.
IsTransferModeAvailable Checks to see if the specific transfer mode is supported by the current TWAIN source.
LoadTemplateFile Loads the TWAIN capability values stored in the specified template file and sets the selected TWAIN source using these values.
ModifyRgbResponse Sets the RGB elements to be used when transferring data from the current TWAIN source.
QueryCapability Gets all of the supported values for the requested capability.
QueryFileSystem Queries the TWAIN file system.
QuerySourceInformation Gets information about the available TWAIN Data Sources.
QuerySupportedCapabilities Gets an array of TWAIN Capabilities supported in the current session.
ResetDeviceEventCapability Resets CAP_DEVICEEVENT capability to defaults values
SaveCustomDSData Saves the custom data source data to a file.
SaveTemplateFile Saves a list of capabilities to the specified template file on disk.
SelectedSourceName Gets the name of the selected TWAIN source. This name is provided by the manufacturer.
SelectedSourceTwainVersion Gets the TWAIN version of the selected TWAIN source.
SelectSource Displays the TWAIN dialog box to be used to select a TWAIN source for acquiring images.
SetCapability Sets the value of the specified capability.
SetDeviceEventCapability Sets CAP_DEVICEEVENT capability values
SetJpegCompression Sets the JPEG compression options for the current TWAIN session. This method lets the user set JPEG compression options for the current TWAIN session or reset the default JPEG compression options for the current TWAIN session, depending on the flag passed to the flag parameter.
SetVersion Sets the desired TWAIN version with which to work.
ShowProgressIndicator Enables or disables the display of a progress indicator during the acquisition of images from the current TWAIN source.
ShowTemplateDialog Displays the TWAIN source manufacturer's template dialog, without actually acquiring an image.
Shutdown Ends a TWAIN session.
Startup Initializes the TWAIN session.
Startup2 Initializes the TWAIN session.
StopFeeder Stop acquiring images only from the feeder of the TWAIN source.
UpdateCustomDSData Update the custom data source
UpdateExtraImageInformation Gets the extended image information.

Public Properties

Name Description
AcquirePageOptions Gets or sets the paper size and paper orientation values to use when transferring images from the current TWAIN source.
DuplexScanningMode Gets the duplex mode value.
EnableAcquireMultiPageEvent (Document/Medical only) Enables or disables the generation of the AcquireMultiPage event.
EnableDuplexScanning Enables or disables the duplex mode.
EnableFastConfigurationEvent (Document/Medical only) Enables or disables the generation of the FastConfiguration event.
EnableGetDeviceEvent Enables or disables firing GetDeviceEvent event
EnableSetPropertyEvent Enable or disable firing property event when calling set Properties property.
EnableShowUserInterfaceOnly Gets or sets the flag that indicates whether to display the TWAIN user interface with or without the Scan button, if supported.
ImageBitsPerPixel Gets or sets the bits per pixel value used to transfer images from the current TWAIN source.
ImageEffects Gets or sets the brightness, highlight and contrast values to use when transferring images from the current TWAIN source.
ImageFrame Gets or sets the image frame used when transferring images from the current TWAIN source.
ImageUnit Gets or sets the image unit value used to transfer images from the current TWAIN source.
MaximumTransferCount Gets or sets the maximum number of images that can be transferred from the current TWAIN source.
Properties Gets or Sets the current data source properties.
Resolution Gets or sets the horizontal and vertical resolution used to transfer images from the current TWAIN source.
TransferOptions Gets and sets the options used for transferring data from the current TWAIN source.

Public Fields

Name Description
AcquireMultiPage (Document/Medical only) Occurs twice for each scanned page, if the EnableAcquireMultiPageEvent property is set to true.
AcquirePage Occurs for each page acquired from the currently selected TWAIN source using the Acquire method.
FastConfiguration (Document/Medical only) This event is fired for each scan configuration tested, if the value of the EnableFastConfigurationEvent property is set to true.
GetDeviceEvent Occurs for each device event received from the TWAIN source to the application
LoadTemplate Occurs when loading TWAIN capabilities from the currently selected TWAIN source to a template file by calling the LoadTemplateFile method.
SaveTemplate Occurs when saving TWAIN capabilities from the currently selected TWAIN source to a template file by calling the SaveTemplateFile method.
SetProperty Occurs when setting TWAIN capabilities to currently selected TWAIN source by calling the Properties property.
Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Twain Assembly