Atalasoft.Twain Namespace |
Classes| Class | Description | |
|---|---|---|
 | AcquireEventArgs |
Contains information about the image just acquired.
|
 | Acquisition | This is the main class for image acquisitions. Use this class by itself for standard acquires, or
use it to get a Device object for more control over the acquire operation. For low level access to
Twain, use the TwainController object. |
| AsynchronousExceptionEventArgs | This class is passed to an AsynchronousExceptionEventHandler when there is an exception
during an asynchronous acquisition. |
| Device | Contains information about a single device and handles the acquisition of images from that device. |
| DeviceCollection | Contains a collection of all Device objects on the system. |
| DeviceEventArgs | Contains information about a device event. |
| DocumentFeeder | Gives control over the document feeder used by a scanner. |
| FileInformation | Contains information about a specific file in the FileSystem. |
| FileSystem | Contains methods which can navigate the file system of a camera. |
| FileTransferEventArgs | Contains information about the file transfer used in the FileTransfer event. |
| FormDataCollection | The FormDataCollection is used with the HttpPost class to send form
information to a web server. |
| HttpPost | This class allows can post image data to a server without user interaction. |
| InvalidStateException | This exception is fired when an action, such as setting a property, has been taken before the device is in
the proper state. |
| MemoryDataTransferEventArgs | This class is used with the MemoryDataTransfer event of the TwainController. |
| MemoryFileTransferEventArgs | This class contains information for a memory file transfer. |
| TwainBarCode | This class provides access to barcode and patchcode specific methods. |
| TwainCapability | This class is used with SendCommand to get or set device capabilities. |
| TwainController | The TwainController class allows for lower level access to Twain, providing greater
control over the acquisition and access to custom device properties. |
| TwainCustomData | This class is used with SendCommand to query the device for its current
settings or to restore previously saved settings. |
| TwainDataImageInfoEventArgs | This class is passed to the BeforeTwainDataTransfer event to supply general
information about the image about to be acquired. |
| TwainDataTransferEventArgs | This class is used with the TwainDataTransfer event to allow the acquired
data to be handled by the developer instead of by DotTwain. |
| TwainDeviceCallbackEventArgs | This class is used with the TwainDeviceCallbackEventHandler and provides information passed
from the device to the application. |
| TwainDeviceEvent | This class is used with SendCommand to obtain information about a device
event when the TwainEventMessage retrieved from ProcessEvent(Message, TwainEventMessage) is
MSG_DEVICEEVENT. |
| TwainEvent | This class is used with SendCommand to process Windows messages during an
acquisition. |
| TwainException | This is a general exception due to an error while using DotTwain. |
| TwainExtendedImageInformation | This class is used with SendCommand to get extended image information from
the device. |
| TwainFileSystem | This class is used with SendCommand to control the file system of a Twain compatible camera. |
| TwainHandle | This class is used with SendCommand to pass a handle to Twain. |
| TwainIdentity | This class is used to identify your application to Twain and to provide information about each Twain
compatible device found on the system. |
| TwainImageInfo | This class is used with SendCommand to get information about the image about
to be scanned or the one that was just acquired. |
| TwainImageLayout | This class is used with the SendCommand method to get or set image layout
data. |
| TwainManager | The TwainManager class is used to control which version of TWAIN is used by DotTwain. TWAIN 2.x (twaindsm.dll) will be used by default if it exists on the system, otherwise TWAIN version 1.x (twain_32.dll) is used. Some drivers will not work with TWAIN 2.x, such as WIA drivers. To use these drivers you can force DotTwain to use version 1.x by setting the ForceTwain1xBehavior property to true before creating an instance of Acquisition or TwainController. |
| TwainMemory | This class represents a memory object passed into TWAIN or returned from TWAIN. |
| TwainResolution | Describes the horizontal and vertical resolution. |
| TwainUserInterface | This class is used with the SendCommand method to display or hide the driver
interface. |
| UnsupportedCapabilityException | This exception is caused when trying to use features of Twain which are unsupported by the device. For instance, if you try to perform an acquire directly to file and the device does not support this feature, an UnsupportedCapabilityException will be generated. |
Interfaces| Interface | Description | |
|---|---|---|
 | ITwainDataStructure | This interface is used for data classes sent to the SendCommand(TwainTriplet, TwainIdentity, ITwainDataStructure) method.
|
Delegates| Delegate | Description | |
|---|---|---|
 | AsynchronousExceptionEventHandler | This event handler is used to notify the application of any exceptions during an asynchronous acquisition.
|
| BeforeTwainDataTransferEventHandler | This event handler is used to provide information about the data that is about to be scanned. |
| DeviceEventHandler | This event handler is used to pass the DeviceEventFlagss to the application. |
| FileTransferEventHandler | This event handler is used when acquiring images directly to a file. |
| ImageAcquiredEventHandler | This event handler is used to notify the application when an image has been acquired. |
| MemoryDataTransferEventHandler | This event handler is used in the TwainController to capture a memory transfer as data is
being sent from the driver. |
| MemoryFileTransferEventHandler | This event handler is used in the TwainController and Acquisition objects to
request a file format and Stream for saving the scanned image. |
| TwainDataTransferEventHandler | This event handler is used to allow the data retrieved from the device to be handled by the developer
instead of by DotTwain. |
| TwainDeviceCallbackEventHandler | This delegate is used with the RegisterTwainCallback(TwainDeviceCallbackEventHandler) method to allow the use of a callback instead of a message loop for device communication. This feature is only available when using TWAIN 2.0 or higher. |
Enumerations| Enumeration | Description | |
|---|---|---|
 | AlarmTypeFlags | |
| AutoDiscardMode | Used with AutoDiscardBlankPages to enable or disable this feature in the driver.
|
| BarCodeSearchMode | Specifies the search mode for barcode recognition. |
| BarCodeType | Specifies the bar code type priority for the SetSearchPriorities(BarCodeType) method.
|
| BatchJobControl | Used to set the batch mode of the device. |
| BitDepthReductionMode | The bit depth reduction mode for the Source. |
| ClearBufferMode | These values are used to determine how the device will clear its internal buffer. |
| ColorFilterFlags | The filter values for the ColorFilter device property. |
| CompressionMode | Compression modes used during file and memory transfers. |
| CountryCode | A list of country codes used by Twain devices. |
| DeviceCapability | The device capabilities which can be tested with the QueryCapability(DeviceCapability, Boolean) method. This
enumeration is also used with the low level TwainController. |
| DeviceEventFlags | A set of bit flags used to indicate which device events you want to receive. |
| DocumentFeederAlignment | Used to determine the alignment of the paper in a document feeder. |
| DocumentFeederOrder | Used to set the page order of the document feeder. |
| DuplexMode | The duplex mode supported by the device. |
| FileItemType | Indicates the type of file or device camera position. |
| FlashMode | Specifies the type of flash, if any, was used by the device. |
| FlipRotationMode | Specifies the type of flip rotation the Source will perform. |
| ImageFilterMode | A list of filter the source can apply to the image. |
| ImagePixelType | Used to determine the type of image being transferred. |
| ImprinterEndorserMode | Used with SetImprinterEndorser to specify the type of string to use. |
| ImprinterEndorserType | Bit flags used to indicate which printers for imprinting or endorsing are available. |
| LanguageType | Languages used by the source device. |
| LightPathMode | Specifies the type of light path used. |
| LightSourceMode | Specifies the light characteristics used for the acquisition. |
| NoiseFilterMode | Specifies the noise filter to use for the acquisition. |
| OrientationMode | Used to set the orientation of the image. |
| OverscanMode | Specifies the type of Overscan used by the device. |
| PatchCodeType | Specifies the type of patchcode to work with. |
| PowerSupplyMode | Specifies the type of power supply being used by the device. |
| QueryOperation | Specifies the type of operation that can be performed on a specific capability. |
| SourceImageFormat | Specifies the type of image format to use when saving directly from the source device. |
| StaticFrameSizeType | An enumeration of standard frame sizes used by FrameSize. |
| TwainAutoSize | Specifies the type of auto sizing to perform. |
| TwainCameraSide | Specifies which camera to enable or disable in the EnableCamera(TwainCameraSide, Boolean) method. |
| TwainConditionCode | These codes are returned from the GetConditionCode method in the Device
and TwainController classes. |
| TwainContainer | Specifies the type of container used for capabilities in the TwainCapability class.
|
| TwainDataGroupFlags | Indicates the control groups supported by the device. The TwainIdentity class provides this
information about the device. |
| TwainEventMessage | These messages are passed to the WndProc during acquisition to indicate events from the device. |
| TwainExtendedImageInfoID | Used to specify which extended parameters are requested from the driver. |
| TwainFeederPocket | Specifies feeder pockets available for page ouput. |
| TwainFeederType | Specifies the feeder type to use with the specified parameters. |
| TwainIccProfileOption | Specifies the type of ICC profile support to use. |
| TwainItemType | Specifies the item type used for item data in TWAIN. |
| TwainPixelFlavor | Determines whether Black or White is represented by the value zero. |
| TwainReturnCode | These values are returned from Twain and the device. The LastReturnCode property of
the Device object provides this value as do the methods in the TwainController class.
|
| TwainState | Indicates the current Twain state. This value can be retrieved from the State property
of the Device and TwainController classes. |
| TwainTransferMethod | Specifies the transfer method used. This can be set with the TransferMethod property
of the Device object. |
| TwainTriplet | Specifies the Twain operation to perform in the SendCommand method of
TwainController. See the Twain specification for more information about these operations. |
| UnitType | Used to set the units of measure for the acquire. |