IsisController Class |
The IsisController class allows for lower level access to ISIS drivers, providing greater
control over the acquisition and access to custom device properties.
Inheritance HierarchySystemObject
Atalasoft.IsisIsisController
Atalasoft.IsisIsisController
Namespace: Atalasoft.Isis
Assembly: Atalasoft.dotImage.Isis (in Atalasoft.dotImage.Isis.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe IsisController type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | IsisController |
Initializes a new instance of IsisController class.
|
Properties| Name | Description | |
|---|---|---|
 | AcquiredImageType |
Gets or sets the type of image to be returned from a scanner. The default value is AtalaImage.
|
| ActiveDevice |
Gets or sets the IsisDevice to work with.
|
| CodecManager |
Gets the list of available codecs that can be used to compress scanned image data.
|
| Devices |
Gets a collection of installed IsisDevice in the system.
|
| IsDisposed |
Gets a value indicating whether the object is disposed.
|
| LastErrorDescription |
Gets description of the last error returned from ISIS device.
|
| State |
Gets a value indicating state of ISIS device.
|
Methods| Name | Description | |
|---|---|---|
| Acquire |
Acquires an image from the active device.
|
| AcquireToFile(IsisFileType, IsisCompression) |
Acquires an image from the active device to a file.
|
| AcquireToFile(IsisCompression, String, String, String, String, String) |
Acquires an image from the active device to PDF document.
|
| Close |
Closes any open driver connections.
|
| Dispose |
Closes any ISIS drivers and releases resources back to the system.
|
 | Dispose(Boolean) |
Closes any ISIS drivers and releases resources back to the system.
|
 | EnumTypeFromSetting |
Detects the type of the desired setting.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | IsisController destructor.
(Overrides ObjectFinalize.) |
| GetAffectedSettings |
Returns a list of properties that are affected by changing the specified property value.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetIntValue |
Retrieves setting value as integer.
|
| GetRationalValue |
Retrieves setting value as Rational.
|
| GetSettingType |
Retrieves ISIS type of the specified setting.
|
| GetStringValue |
Retrieve setting value as string.
|
| GetSupportedIntValues |
Gets the list of supported integer values of the specified setting.
|
| GetSupportedListValues |
Gets the list of supported values and currently selected value index.
|
| GetSupportedRationalValues |
Gets the list of supported Rational values of the specified setting.
|
| GetSupportedSettings |
Gets the list of supported settings.
|
| GetSupportedStringValues |
Gets the list of supported string values of the specified setting.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Open |
Opens active ISIS device.
|
| QuerySupport |
Checks whether the specified setting is supported by ISIS device.
|
| RestoreIniSettings |
Restores configuration of the active device from the specified INI file.
|
| RestoreSettings(Stream) |
Restores configuration information of active device from.
|
| RestoreSettings(String) |
Restores configuration information of active device from.
|
| RestoreSettings(ISettingDataManager) |
Restores configuration information of active device from.
|
| SaveIniSettings |
Saves configuration information of the active device to the specified INI file.
|
| SaveSettings(Stream) |
Saves configuration of the active device to the stream.
|
| SaveSettings(String) |
Saves configuration of the active device to the specified file.
|
| SaveSettings(ISettingDataManager) |
Saves configuration of the active device to a data manager.
|
| SetIntValue |
Sets integer setting value.
|
| SetRationalValue |
Sets Rational setting value.
|
| SetStringValue |
Sets string setting value.
|
| ShowConfigurationDialog |
Displays a dialog box showing configuration information for a scanner and allowing the configuration information to be changed by the user.
|
| ShowDeviceDialog |
Displays a scanner configuration dialog, allowing users to change scan settings.
|
| ShowSelectSource |
Shows Select Source dialog which allows the user to select, add, or configure a scanner.
|
| 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.
|
| BarcodeDetected |
This event is fired to notify the application when a barcode is detected.
|
| DataAcquired |
This event fires after the data has been transferred but before it has been processed by DotIsis.
|
| ErrorNotification |
This event is fired error is appeared.
|
| FileAcquisition |
This event is fired just before acquiring an image directly to file. You must fill in the
FileName property of the IsisFileAcquisitionEventArgs object.
|
| ImageAcquired |
This event will fire for each image acquired.
|
| ImageAcquiring |
This event is fired before the data is transferred from the device, allows the transfer to be canceled.
|
| Yield |
This event is fired during scanning and allows an application to implement yield function in order to obtain
processor attention when the SDK performs such a long operation.
|
RemarksError handling.
In case of problems in attempt to access ISIS device, IsisController methods can throw IsisException or fire ErrorNotification event depends on whether ErrorNotification event is handled in user's code or not. In case if the event is handled, the ErrorNotification is fired and the method, where the problem occurred, returns default value if applicable.See Also