TwainController Class |
The TwainController class allows for lower level access to Twain, providing greater
control over the acquisition and access to custom device properties.
Inheritance HierarchySystemObject
Atalasoft.TwainTwainController
Atalasoft.TwainTwainController
Namespace: Atalasoft.Twain
Assembly: Atalasoft.DotTwain (in Atalasoft.DotTwain.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe TwainController type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
  | TwainController(IWin32Window) | Creates a new instance of TwainController specifying the parent window. |
| TwainController(IWin32Window, TwainIdentity) | Creates a new instance of TwainController specifying the parent window and application identity
information. |
Properties| Name | Description | |
|---|---|---|
 | ApplicationIdentity | Gets or sets the application identity sent to Twain for the session. |
| BadImageInfoDetected | Gets a value indicating whether the driver returned an invalid TW_IMAGEINFO structure. |
| CurrentDevice | Gets or sets the device to work with. |
| LastAcquireConditionCode | Gets the last condition code returned from TWAIN for an acquire. |
| State | Gets the current Twain state. |
| SystemHasTwain | Gets a value indicating whether the twain_32.dll has been found on the system. |
Methods| Name | Description | |
|---|---|---|
| CloseSource | Use this method to close the connection to the device. |
| CloseSourceManager | Use to close the source manager and release Twain. |
| CreateTwainMemory | Returns a new TwainMemory class for the specified pointer. |
| Dispose | Closes any TWAIN connections and releases resources back to the system. |
 | Dispose(Boolean) | Closes any TWAIN connections and releases resources back to the system. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allow the TwainController to chance to clean up any resources before being collected by the garbage
collector. (Overrides ObjectFinalize.) |
| FreeTwainMemory | Release memory allocated for TWAIN. |
| GetCapabilityArray | Retrieves an array of values to the specified capability. |
| GetCapabilityTwainType | Returns the TWAIN type for the specified capability. |
| GetCapabilityType | Use this method to determine the .NET Type DotTwain expects for a specific capability.
|
| GetCapabilityValue(DeviceCapability, Boolean) | Reads a Boolean capability value. |
| GetCapabilityValue(DeviceCapability, RectangleF) | Reads a RectangleF capability value. |
| GetCapabilityValue(DeviceCapability, Int32) | Reads an Int32 capability value. |
| GetCapabilityValue(DeviceCapability, Single) | Reads a Single capability value. |
| GetCapabilityValue(DeviceCapability, String) | Reads a String capability value. |
| GetConditionCode | Returns the condition code from the source manager. |
| GetConditionCode(TwainIdentity) | Returns the condition code from the source device. |
| GetDefaultDevice | Returns the identity of the default system device. |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetPendingTransferCount | Use this method to get the number of pages waiting to be acquired, reset the pending count or to end the
current page. |
| GetTwainDevices | Returns an array of TwainIdentity classes; one for each Twain compatible device found on the
system. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitiateDataTransfer | Use this method to have DotTwain handle the data acquisition details. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OpenSource | Opens a connection to the CurrentDevice. |
| OpenSource(TwainIdentity) | Opens a connection to the device passed in. |
| OpenSourceManager | Opens a connection to the TWAIN Source Manager. |
| ProcessEvent | This method will process the Message object retrieved from
PreFilterMessage to determine if the message should be handled by the device or passed along the
message loop. |
| ReadTwainContainerData(TwainContainer, TwainMemory) | Returns the value of a memory pointer retrieved from a device. |
| ReadTwainContainerData(TwainContainer, IntPtr) | Returns the value of a memory pointer retrieved from a device. |
| RegisterTwainCallback | Sets up a callback for TWAIN device messages instead of using the traditional message loop. This should only be called when using the TwainController directly; the Device object automatically handles the callback. The callback feature is only supported when using the TWAIN 2.0 Data Source Manager |
| ResetAllCapabilities | Call this method to reset all capabilities supported by the device. |
| ResetCapability | Resets a single capability to its startup value. |
| SendCommand(TwainTriplet, TwainIdentity, ITwainDataStructure) | Send a command to the TWAIN API |
| SendCommand(Int32, Int32, Int32, TwainIdentity, ITwainDataStructure) | Sends a command triplet that may not be contained in the TwainTriplet enumeration.
|
| SetCapabilityArray | Sets an array of values for a specific capability to the device. |
| SetCapabilityValue(DeviceCapability, Boolean) | Sets a capability to a Boolean value. |
| SetCapabilityValue(DeviceCapability, RectangleF) | Set a capability to a RectangleF value. |
| SetCapabilityValue(DeviceCapability, Int32) | Sets a capability to an Int32 value. |
| SetCapabilityValue(DeviceCapability, Single) | Sets a capability to a Single value. |
| SetCapabilityValue(DeviceCapability, String) | Sets a capability to a String value. |
| SetExtendedImageInfoOptions | Sets the extended image information id values that will be retrieved when acquiring data. |
| SetThreadUIControl | Sets the parent control used to invoke events from the TwainController. This method is
automatically called by the Device object when acquiring images. |
| ShowSelectSource | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | AcquireCanceled | This event will fire if the user has canceled the acquisition. |
| AcquireFinished | This event will fire when all of the images have been acquired. This is useful when a document feeder is
used. |
| BeforeTwainDataTransfer | This event will fire before the data is transferred from the device, allow the transfer to be canceled.
|
| FileTransfer | This event will fire just before acquiring an image directly to file. You must fill in the FileName property of the FileTransferEventArgs object. |
| ImageAcquired | This event will fire for each image acquired. |
| MemoryDataTransfer | This event is raised during a memory transfer to allow developers to handle processing the data instead of
DotTwain. |
| MemoryFileTransfer | This event is raised during a memory file transfer before each image is scanned. Use this event to
indicate the file format for the image and provide a Stream to store the image into. |
| TwainDataTransfer | This event fires after the data has been transferred but before it has been processed by DotTwain.
|
| TwainException | Raised when there is an exception in the TwainController. If this event is not handled,
the exception will be thrown instead. |
See Also