Leadtools.Twain Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.8.31
TwainSession Class Methods
See Also 
Leadtools.Twain Namespace : TwainSession Class


For a list of all members of this type, see TwainSession members.

Public Methods

 NameDescription
Public MethodAcquire Acquires one or more images from a TWAIN source.  
Public MethodAcquireFast (Document/Medical only) Acquires one or more images from a TWAIN source and stores the images in the specified file(s).  
Public MethodAcquireToImage Acquires one or more images from a TWAIN source.  
Public MethodFindConfiguration (Document/Medical only) Gets all available configurations for the current session.  
Public MethodFindFastConfiguration (Document/Medical only) Determines the best scanner configuration.  
Public MethodGetCapability Gets the TwainCapability value at the specified index from the array of capabilities supported by the selected TWAIN source.  
Public MethodGetDeviceEventCapability Gets device events capability values for current TWAIN session.  
Public MethodGetDeviceEventData Gets information for specific device event  
Public MethodGetJpegCompression Gets the current or default JPEG compression settings for the TWAIN session.  
Public Methodstatic (Shared in Visual Basic)IsAvailable Determines whether a TWAIN source is installed.  
Public MethodIsTransferModeAvailable Check if the specific transfer mode is supported in the current Twain source.  
Public MethodLoadTemplateFile Loads the TWAIN capability values stored in the specified template file and sets the selected TWAIN source using these values.  
Public MethodModifyRgbResponse Sets the RGB elements to be used when transferring data from the current TWAIN source.  
Public MethodQueryCapability Gets all the supported values of the requested capability.  
Public MethodQueryFileSystem Query Twain file system.  
Public MethodQuerySourceInformation Gets information about the available TWAIN Data Sources.  
Public MethodQuerySupportedCapabilities Gets an array of Twain Capabilities supported in the current session.
 
Public Methodraise_AcquireMultiPage (Document/Medical only) Occurs during multipage image scanning  
Public Methodraise_AcquirePage Occurs after an image is acquired.  
Public Methodraise_FastConfiguration (Document/Medical only) Occurs during fast twain configuration testing.  
Public Methodraise_GetDeviceEvent Occurs after a device event is received.  
Public Methodraise_LoadTemplate Occurs loading of a TWAIN Template using LoadTemplateFile  
Public Methodraise_SaveTemplate Occurs saving of a TWAIN Template SaveTemplateFile.  
Public Methodraise_SetProperty Occurs when setting TWAIN capability using Properties  
Public MethodResetDeviceEventCapability Resets CAP_DEVICEEVENT capability to defaults values  
Public MethodSaveTemplateFile Enumerates all supported capabilities, and the current values, for the currently selected TWAIN source and saves them to the specified template file.  
Public MethodSelectedSourceName Gets the name of the selected TWAIN source. This name is provided by the manufacturer.  
Public MethodSelectSource Displays the TWAIN dialog box to be used to select a TWAIN source for acquiring images.  
Public MethodSetCapability Sets the value of the specified capability.  
Public MethodSetDeviceEventCapability Sets CAP_DEVICEEVENT capability values  
Public MethodSetJpegCompression 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 MethodShowProgressIndicator Enables or disables the display of a progress indicator during the acquisition of images from the current TWAIN source.  
Public MethodShowTemplateDialog Displays the TWAIN source manufacturer's template dialog, without actually acquiring an image.  
Public MethodShutdown Ends a TWAIN session.  
Public MethodStartup Initializes the TWAIN session.  
Public MethodStopFeeder Stop acquiring images only from the feeder of the TWAIN source.  
Public MethodUpdateExtraImageInformation Gets the extended image information.  
Top

Protected Methods

 NameDescription
Protected Methodraise__acquireMultiPage (Document/Medical only) Occurs during multipage image scanning  
Protected Methodraise__acquirePage Occurs after an image is acquired.  
Protected Methodraise__fastConfiguration (Document/Medical only) Occurs during fast twain configuration testing.  
Protected Methodraise__getDeviceEvent Occurs after a device event is received.  
Protected Methodraise__loadTemplate Occurs loading of a TWAIN Template using LoadTemplateFile  
Protected Methodraise__saveTemplate Occurs saving of a TWAIN Template SaveTemplateFile.  
Protected Methodraise__setProperty Occurs when setting TWAIN capability using Properties  
Top

See Also