Click or drag to resize

IsisAcquisition Class

This is the main class for image acquisitions with ISIS devices. Use this class by itself for standard acquires, or use it to get an IsisDevice object for more control over the acquire operation. For low level access to ISIS drivers, use the IsisController object.
Inheritance Hierarchy

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 IsisAcquisition : Component

The IsisAcquisition type exposes the following members.

Constructors
  NameDescription
Public methodIsisAcquisition
Creates a new instance of IsisAcquisition.
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.
Protected propertyCanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
Public propertyCodecManager
Gets the list of available codecs that can be used to compress scanned image data.
Public propertyContainer
Gets the IContainer that contains the Component.
(Inherited from Component.)
Protected propertyDesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Public propertyDevices
Gets a collection of installed ISIS scanners in the system.
Protected propertyEvents
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Public propertySite
Gets or sets the ISite of the Component.
(Inherited from Component.)
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 methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose
Releases all resources used by the Component.
(Inherited from Component.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the Component and optionally releases the managed resources.
(Inherited from Component.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodGetService
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodOnAcquireCanceled
Handles AcquireCanceled event.
Protected methodOnAcquireFinished
Handles AcquireFinished event.
Protected methodOnBarcodeDetected
Handles BarcodeDetected event.
Protected methodOnDataAcquired
Handles DataAcquired event.
Protected methodOnErrorNotification
Handles ErrorNotification event.
Protected methodOnFileAcquisition
Handles FileAcquisition event.
Protected methodOnImageAcquired
Handles ImageAcquired event.
Protected methodOnYield
Handles Yield event.
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 containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
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 eventDisposed
Occurs when the component is disposed by a call to the Dispose method.
(Inherited from Component.)
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
IsisAcquisition is also a component which can be added to the Visual Studio .NET toolbox. This enables properties and events to be established at design time.
See Also