Grooper.Capture.CaptureDevice

Capture Devices provide connectivity to hardware capture devices, such as ISIS or TWAIN document scanners. Each Scanner Profile in Grooper is associated with a capture device, specified at the time the Scanner Profile is created in the Scan Control.


Inherits from: Grooper.ConnectedObject

Constructors

Signature Description
New (gdb As GrooperDb, Protocol As Type) Initializes a new instance of the CaptureDevice class.
Parameters
gdb
          Type: GrooperDb
          The Grooper database.
 
Protocol
          Type: Type
          

Fields

Field Name Field Type Description
CaptureCanceled As System.Boolean System.Boolean
Database As Grooper.GrooperDb Grooper.GrooperDb
ProtocolSettings As Grooper.Capture.CaptureProtocol+ProtocolSettings Grooper.Capture.CaptureProtocol.ProtocolSettings
ProtocolType As System.Type System.Type

Properties

Property Name Property Type Description
HasReferenceProperties System.Boolean Returns true if the object has properties which reference Grooper Node objects.
IsEmpty System.Boolean Returns true if all properties with a ViewableAttribute are set to their default value.
IsWriteable System.Boolean Returns true if the object is writable, or false if it is not.
Name System.String Returns the name of the Capture Device.
Root Grooper.GrooperRoot Returns the root node
ScannerSettings System.String Displays the settings dialog box for the scanner capture device.

Methods

Method Name Description
AcquireFinished()
CancelScan() Cancels the active scan operation.
DoScan(JobInfo As ScanJobInfo) As Boolean
Parameters
JobInfo
          Type: ScanJobInfo
          
GetLastError() As String Returns the last error.
GetProperties() As PropertyDescriptorCollection
GetReferences() As List(Of GrooperNode) Returns a list of GrooperNode objects referenced in the properties of this object.
ImageAcquired(cp As CapturedPage)
Parameters
cp
          Type: CapturedPage
          
Initialize(sp As ScannerProfile) Itializes the scanner capture device.
Parameters
sp
          Type: ScannerProfile
          
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently enabled.
Parameters
PropertyName
          Type: String
          The name of the property to determine the enabled state for.
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently visible.
Parameters
PropertyName
          Type: String
          The name of the property to determine the visible state for.
IsType(Type As Type) As Boolean Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters
Type
          Type: Type
          The type to check.
Serialize() As String Serializes the object.
SetDatabase(Database As GrooperDb) Sets the database connection of the object.
Parameters
Database
          Type: GrooperDb
          
SetLastError(Message As String, pa() As Object())
Parameters
Message
          Type: String
          
 
pa
          Type: Object
          
SetLastError(EventArgs As ScanConditionEventArgs)
Parameters
EventArgs
          Type: ScanConditionEventArgs
          
ShowScannerUI(Parent As IWin32Window) As Boolean Displays the user interface for the scanner capture device.
Parameters
Parent
          Type: IWin32Window
          
StartScan(sp As ScannerProfile, PagesToScan As Int32) As Boolean Starts a scan operation.
Parameters
sp
          Type: ScannerProfile
          
 
PagesToScan
          Type: Int32
          
ToString() As String Returns a string value representation of the connected object.
Uninitialize() Unitializes the scanner capture device.
ValidateProperties() As ValidationErrorList Validates the properties of the object, returning a list of validation errors.

Events

Event Name Description
PageAcquired(sender As Object, e As PageAcquiredEventArgs) Fired each time a page is acquired from the capture device

PageAcquiredEventArgs
cp
 Type: CapturedPage
  
 
QueueFull
 Type: Boolean
  
ScanCondition(sender As Object, e As ScanConditionEventArgs) Fired each time a scan condition/error occurs

ScanConditionEventArgs
Type
 Type: ScanConditionType
  
 
Cancel
 Type: Boolean
  
 
DisableDoubleFeedDetection
 Type: Boolean
  
 
Message
 Type: String