Click or drag to resize

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 Hierarchy
SystemObject
  Atalasoft.IsisIsisController

Namespace:  Atalasoft.Isis
Assembly:  Atalasoft.dotImage.Isis (in Atalasoft.dotImage.Isis.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class IsisController : IDisposable

The IsisController type exposes the following members.

Constructors
  NameDescription
Public methodIsisController
Initializes a new instance of IsisController class.
Top
Properties
  NameDescription
Public propertyAcquiredImageType
Gets or sets the type of image to be returned from a scanner. The default value is AtalaImage.
Public propertyActiveDevice
Gets or sets the IsisDevice to work with.
Public propertyCodecManager
Gets the list of available codecs that can be used to compress scanned image data.
Public propertyDevices
Gets a collection of installed IsisDevice in the system.
Public propertyIsDisposed
Gets a value indicating whether the object is disposed.
Public propertyLastErrorDescription
Gets description of the last error returned from ISIS device.
Public propertyState
Gets a value indicating state of ISIS device.
Top
Methods
  NameDescription
Public methodAcquire
Acquires an image from the active device.
Public methodAcquireToFile(IsisFileType, IsisCompression)
Acquires an image from the active device to a file.
Public methodAcquireToFile(IsisCompression, String, String, String, String, String)
Acquires an image from the active device to PDF document.
Public methodClose
Closes any open driver connections.
Public methodDispose
Closes any ISIS drivers and releases resources back to the system.
Protected methodDispose(Boolean)
Closes any ISIS drivers and releases resources back to the system.
Public methodStatic memberEnumTypeFromSetting
Detects the type of the desired setting.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
IsisController destructor.
(Overrides ObjectFinalize.)
Public methodGetAffectedSettings
Returns a list of properties that are affected by changing the specified property value.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetIntValue
Retrieves setting value as integer.
Public methodGetRationalValue
Retrieves setting value as Rational.
Public methodGetSettingType
Retrieves ISIS type of the specified setting.
Public methodGetStringValue
Retrieve setting value as string.
Public methodGetSupportedIntValues
Gets the list of supported integer values of the specified setting.
Public methodGetSupportedListValues
Gets the list of supported values and currently selected value index.
Public methodGetSupportedRationalValues
Gets the list of supported Rational values of the specified setting.
Public methodGetSupportedSettings
Gets the list of supported settings.
Public methodGetSupportedStringValues
Gets the list of supported string values of the specified setting.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOpen
Opens active ISIS device.
Public methodQuerySupport
Checks whether the specified setting is supported by ISIS device.
Public methodRestoreIniSettings
Restores configuration of the active device from the specified INI file.
Public methodRestoreSettings(Stream)
Restores configuration information of active device from.
Public methodRestoreSettings(String)
Restores configuration information of active device from.
Public methodRestoreSettings(ISettingDataManager)
Restores configuration information of active device from.
Public methodSaveIniSettings
Saves configuration information of the active device to the specified INI file.
Public methodSaveSettings(Stream)
Saves configuration of the active device to the stream.
Public methodSaveSettings(String)
Saves configuration of the active device to the specified file.
Public methodSaveSettings(ISettingDataManager)
Saves configuration of the active device to a data manager.
Public methodSetIntValue
Sets integer setting value.
Public methodSetRationalValue
Sets Rational setting value.
Public methodSetStringValue
Sets string setting value.
Public methodShowConfigurationDialog
Displays a dialog box showing configuration information for a scanner and allowing the configuration information to be changed by the user.
Public methodShowDeviceDialog
Displays a scanner configuration dialog, allowing users to change scan settings.
Public methodShowSelectSource
Shows Select Source dialog which allows the user to select, add, or configure a scanner.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventAcquireCanceled
This event will fire if the user has canceled the acquisition.
Public eventAcquireFinished
This event will fire when all of the images have been acquired. This is useful when a document feeder is used.
Public eventBarcodeDetected
This event is fired to notify the application when a barcode is detected.
Public eventDataAcquired
This event fires after the data has been transferred but before it has been processed by DotIsis.
Public eventErrorNotification
This event is fired error is appeared.
Public eventFileAcquisition
This event is fired just before acquiring an image directly to file. You must fill in the FileName property of the IsisFileAcquisitionEventArgs object.
Public eventImageAcquired
This event will fire for each image acquired.
Public eventImageAcquiring
This event is fired before the data is transferred from the device, allows the transfer to be canceled.
Public eventYield
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.
Top
Remarks

Error 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