The following tables list the members exposed by TwainSession.
Public Constructors
| Name | Description | |
|---|---|---|
| TwainSession Constructor | Constructs a new TwainSession object with default values. |
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 | (Read only) Gets the duplex mode value. |
|
| EnableAcquireMultiPageEvent | (Document/Medical only) Enables or disables the generation of the TwainSession.AcquireMultiPage event. |
|
| EnableDuplexScanning | Enables or disables the duplex mode. |
|
| EnableFastConfigurationEvent | (Document/Medical only) Enables or disables the generation of the TwainSession.FastConfiguration event. |
|
| EnableGetDeviceEvent | Enables or disables firing Leadtools.Twain.TwainSession.GetDeviceEvent event |
|
| EnableSetPropertyEvent | Enable or disable firing property event when calling calling set TwainSession.Properties property. |
|
| EnableShowUserInterfaceOnly | Gets or sets 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 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). |
|
| 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. |
| IsAvailable | Determines whether a TWAIN source is installed. |
|
| IsTransferModeAvailable | Check if the specific transfer mode is supported in 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 the supported values of the requested capability. |
|
| QueryFileSystem | Query Twain file system. |
|
| QuerySourceInformation | Gets information about the available TWAIN Data Sources. |
|
| QuerySupportedCapabilities | Gets an array of Twain Capabilities supported in the current session. |
|
| raise_AcquireMultiPage | (Document/Medical only) Occurs during multipage image scanning |
|
| raise_AcquirePage | Occurs after an image is acquired. |
|
| raise_FastConfiguration | (Document/Medical only) Occurs during fast twain configuration testing. |
|
| raise_GetDeviceEvent | Occurs after a device event is received. |
|
| raise_LoadTemplate | Occurs loading of a TWAIN Template using LoadTemplateFile |
|
| raise_SaveTemplate | Occurs saving of a TWAIN Template SaveTemplateFile. |
|
| raise_SetProperty | Occurs when setting TWAIN capability using TwainSession.Properties |
|
| ResetDeviceEventCapability | Resets CAP_DEVICEEVENT capability to defaults values |
|
| SaveCustomDSData | Saves the custom data source data to a file |
|
| SaveTemplateFile | Enumerates all supported capabilities, and the current values, for the currently selected TWAIN source and saves them to the specified template file. |
|
| SelectedSourceName | Gets the name of the selected TWAIN source. This name is provided by the manufacturer. |
|
| 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. |
|
| 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. |
Protected Methods
| Name | Description | |
|---|---|---|
| raise__acquireMultiPage | (Document/Medical only) Occurs during multipage image scanning |
|
| raise__acquirePage | Occurs after an image is acquired. |
|
| raise__fastConfiguration | (Document/Medical only) Occurs during fast twain configuration testing. |
|
| raise__getDeviceEvent | Occurs after a device event is received. |
|
| raise__loadTemplate | Occurs loading of a TWAIN Template using LoadTemplateFile |
|
| raise__saveTemplate | Occurs saving of a TWAIN Template SaveTemplateFile. |
|
| raise__setProperty | Occurs when setting TWAIN capability using TwainSession.Properties |
Public Events
| 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 Leadtools.Twain.TwainSession.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 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 TwainSession.Properties property. |