←Select platform

TwainSession Class Members

Summary

The following tables list the members exposed by TwainSession.

Public Constructors

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

Public Methods

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

Public Properties

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

Public Events

Name Description
Public Event AcquireMultiPage (Document/Medical only) Occurs twice for each scanned page, if the EnableAcquireMultiPageEvent property is set to true.
Public Event AcquirePage Occurs for each page acquired from the currently selected TWAIN source using the Acquire method.
Public Event FastConfiguration (Document/Medical only) This event is fired for each scan configuration tested, if the value of the EnableFastConfigurationEvent property is set to true.
Public Event GetDeviceEvent Occurs for each device event received from the TWAIN source to the application.
Public Event LoadTemplate Occurs when loading TWAIN capabilities from the currently selected TWAIN source to a template file by calling the LoadTemplateFile method.
Public Event SaveTemplate Occurs when saving TWAIN capabilities from the currently selected TWAIN source to a template file by calling the SaveTemplateFile method.
Public Event SetProperty Occurs when setting TWAIN capabilities to currently selected TWAIN source by calling the Properties property.

See Also

TwainSession Class

Leadtools.Twain Namespace

Help Version 22.0.2023.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Twain Assembly
Introduction
Getting Started
Namespaces
Leadtools.Twain Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.