Leadtools TWAIN (Leadtools.Twain assembly)

TwainSession Class Members

Show in webframe
Properties  Methods  Events


The following tables list the members exposed by TwainSession.

Public Constructors
 NameDescription
TwainSession ConstructorConstructs a new TwainSession object with default values.  
Top
Public Properties
 NameDescription
AcquirePageOptionsGets or sets the paper size and paper orientation values to use when transferring images from the current TWAIN source.  
DuplexScanningModeGets the duplex mode value.  
EnableAcquireMultiPageEvent(Document/Medical only) Enables or disables the generation of the AcquireMultiPage event.  
EnableDuplexScanningEnables or disables the duplex mode.  
EnableFastConfigurationEvent(Document/Medical only) Enables or disables the generation of the FastConfiguration event.  
EnableGetDeviceEventEnables or disables firing GetDeviceEvent event  
EnableSetPropertyEventEnable or disable firing property event when calling calling set Properties property.  
EnableShowUserInterfaceOnlyGets or sets flag that indicates whether to display the Twain user interface with or without the Scan button, if supported.  
ImageBitsPerPixelGets or sets the bits per pixel value used to transfer images from the current TWAIN source.  
ImageEffectsGets or sets the brightness, highlight and contrast values to use when transferring images from the current TWAIN source.  
ImageFrameGets or sets the image frame used when transferring images from the current TWAIN source.  
ImageUnitGets or sets the image unit value used to transfer images from the current TWAIN source.  
MaximumTransferCountGets or sets the maximum number of images that can be transferred from the current TWAIN source.  
PropertiesGets or Sets the current data source properties.  
ResolutionGets or sets the horizontal and vertical resolution used to transfer images from the current TWAIN source.  
TransferOptionsGets and sets the options used for transferring data from the current TWAIN source.  
Top
Public Methods
 NameDescription
AcquireAcquires 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).  
AcquireToImageAcquires 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.  
GetCapabilityGets the TwainCapability value at the specified index from the array of capabilities supported by the selected TWAIN source.  
GetDeviceEventCapabilityGets device events capability values for current TWAIN session.  
GetDeviceEventDataGets information for specific device event  
GetJpegCompressionGets the current or default JPEG compression settings for the TWAIN session.  
IsAvailableDetermines whether a TWAIN source is installed.  
IsTransferModeAvailableCheck if the specific transfer mode is supported in the current Twain source.  
LoadTemplateFileLoads the TWAIN capability values stored in the specified template file and sets the selected TWAIN source using these values.  
ModifyRgbResponseSets the RGB elements to be used when transferring data from the current TWAIN source.  
QueryCapabilityGets all the supported values of the requested capability.  
QueryFileSystemQuery Twain file system.  
QuerySourceInformationGets information about the available TWAIN Data Sources.  
QuerySupportedCapabilitiesGets an array of Twain Capabilities supported in the current session.
 
raise_AcquireMultiPage(Document/Medical only) Occurs during multipage image scanning  
raise_AcquirePageOccurs after an image is acquired.  
raise_FastConfiguration(Document/Medical only) Occurs during fast twain configuration testing.  
raise_GetDeviceEventOccurs after a device event is received.  
raise_LoadTemplateOccurs loading of a TWAIN Template using LoadTemplateFile  
raise_SaveTemplateOccurs saving of a TWAIN Template SaveTemplateFile(String).  
raise_SetPropertyOccurs when setting TWAIN capability using Properties  
ResetDeviceEventCapabilityResets CAP_DEVICEEVENT capability to defaults values  
SaveCustomDSDataSaves the custom data source data to a file  
SaveTemplateFileOverloaded. Enumerates all supported capabilities, and the current values, for the currently selected TWAIN source and saves them to the specified template file.  
SelectedSourceNameGets the name of the selected TWAIN source. This name is provided by the manufacturer.  
SelectSourceDisplays the TWAIN dialog box to be used to select a TWAIN source for acquiring images.  
SetCapabilitySets the value of the specified capability.  
SetDeviceEventCapabilitySets CAP_DEVICEEVENT capability values  
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.  
SetVersionSets the desired Twain version to work with.  
ShowProgressIndicatorEnables or disables the display of a progress indicator during the acquisition of images from the current TWAIN source.  
ShowTemplateDialogDisplays the TWAIN source manufacturer's template dialog, without actually acquiring an image.  
ShutdownEnds a TWAIN session.  
StartupInitializes the TWAIN session.  
Startup2Initializes the TWAIN session.  
StopFeederStop acquiring images only from the feeder of the TWAIN source.  
UpdateCustomDSDataUpdate the custom data source  
UpdateExtraImageInformationGets the extended image information.  
Top
Protected Methods
 NameDescription
raise__acquireMultiPage(Document/Medical only) Occurs during multipage image scanning  
raise__acquirePageOccurs after an image is acquired.  
raise__fastConfiguration(Document/Medical only) Occurs during fast twain configuration testing.  
raise__getDeviceEventOccurs after a device event is received.  
raise__loadTemplateOccurs loading of a TWAIN Template using LoadTemplateFile  
raise__saveTemplateOccurs saving of a TWAIN Template SaveTemplateFile(String).  
raise__setPropertyOccurs when setting TWAIN capability using Properties  
Top
Public Events
 NameDescription
AcquireMultiPage(Document/Medical only) Occurs twice for each scanned page, if the EnableAcquireMultiPageEvent property is set to true.  
AcquirePageOccurs 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.  
GetDeviceEventOccurs for for each device event received from the TWAIN source to the application  
LoadTemplateOccurs when loading TWAIN capabilities from the currently selected TWAIN source to a template file by calling the LoadTemplateFile method.  
SaveTemplateOccurs when saving TWAIN capabilities from the currently selected TWAIN source to a template file by calling the SaveTemplateFile(String) method.  
SetPropertyOccurs when setting TWAIN capabilities to currently selected TWAIN source by calling the Properties property.  
Top
See Also

Reference

TwainSession Class
Leadtools.Twain Namespace

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.