Leadtools TWAIN (Leadtools.Twain assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.30
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 Method AcquireAcquires 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 AcquireToImageAcquires 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 GetCapabilityGets the TwainCapability value at the specified index from the array of capabilities supported by the selected TWAIN source.  
public Method GetDeviceEventCapabilityGets device events capability values for current TWAIN session.  
public Method GetDeviceEventDataGets information for specific device event  
public Method GetJpegCompressionGets the current or default JPEG compression settings for the TWAIN session.  
public Methodstatic (Shared in Visual Basic) IsAvailableDetermines whether a TWAIN source is installed.  
public Method IsTransferModeAvailableCheck if the specific transfer mode is supported in the current Twain source.  
public Method LoadTemplateFileLoads the TWAIN capability values stored in the specified template file and sets the selected TWAIN source using these values.  
public Method ModifyRgbResponseSets the RGB elements to be used when transferring data from the current TWAIN source.  
public Method QueryCapabilityGets all the supported values of the requested capability.  
public Method QueryFileSystemQuery Twain file system.  
public Method QuerySourceInformationGets information about the available TWAIN Data Sources.  
public Method QuerySupportedCapabilitiesGets an array of Twain Capabilities supported in the current session.
 
public Method raise_AcquireMultiPage(Document/Medical only) Occurs during multipage image scanning  
public Method raise_AcquirePageOccurs after an image is acquired.  
public Method raise_FastConfiguration(Document/Medical only) Occurs during fast twain configuration testing.  
public Method raise_GetDeviceEventOccurs after a device event is received.  
public Method raise_LoadTemplateOccurs loading of a TWAIN Template using LoadTemplateFile  
public Method raise_SaveTemplateOccurs saving of a TWAIN Template SaveTemplateFile.  
public Method raise_SetPropertyOccurs when setting TWAIN capability using TwainSession.Properties  
public Method ResetDeviceEventCapabilityResets CAP_DEVICEEVENT capability to defaults values  
public Method SaveCustomDSDataSaves the custom data source data to a file  
public Method SaveTemplateFileEnumerates all supported capabilities, and the current values, for the currently selected TWAIN source and saves them to the specified template file.  
public Method SelectedSourceNameGets the name of the selected TWAIN source. This name is provided by the manufacturer.  
public Method SelectSourceDisplays the TWAIN dialog box to be used to select a TWAIN source for acquiring images.  
public Method SetCapabilitySets the value of the specified capability.  
public Method SetDeviceEventCapabilitySets CAP_DEVICEEVENT capability values  
public Method SetJpegCompressionSets 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 ShowProgressIndicatorEnables or disables the display of a progress indicator during the acquisition of images from the current TWAIN source.  
public Method ShowTemplateDialogDisplays the TWAIN source manufacturer's template dialog, without actually acquiring an image.  
public Method ShutdownEnds a TWAIN session.  
public Method StartupInitializes the TWAIN session.  
public Method Startup2Initializes the TWAIN session.  
public Method StopFeederStop acquiring images only from the feeder of the TWAIN source.  
public Method UpdateCustomDSDataUpdate the custom data source  
public Method UpdateExtraImageInformationGets the extended image information.  
Top

Protected Methods

 NameDescription
protected Method raise__acquireMultiPage(Document/Medical only) Occurs during multipage image scanning  
protected Method raise__acquirePageOccurs after an image is acquired.  
protected Method raise__fastConfiguration(Document/Medical only) Occurs during fast twain configuration testing.  
protected Method raise__getDeviceEventOccurs after a device event is received.  
protected Method raise__loadTemplateOccurs loading of a TWAIN Template using LoadTemplateFile  
protected Method raise__saveTemplateOccurs saving of a TWAIN Template SaveTemplateFile.  
protected Method raise__setPropertyOccurs when setting TWAIN capability using TwainSession.Properties  
Top

See Also