| Property Name |
Property Type |
Description |
| Ancestors |
System.Collections.Generic.IEnumerable(Of T) |
Enumerates the parent controls of this control. |
| BatchViewer |
Grooper.Core.BatchViewer |
Specifies the associated BatchViewer control associated with this control (if any).
If set, then the ScanControl will automatically update the associated BatchViewer control as it performs its operations. |
| DeviceSettingsEnabled |
System.Boolean |
Indicates whether the Edit Profile command is currently enabled. |
| IsBusy |
System.Boolean |
Returns true if the ScanControl is currently scanning. |
| ScanEnabled |
System.Boolean |
Indicates whether the Scan command is currently enabled. |
| ScannerProfile |
Grooper.Capture.ScannerProfile |
Gets or sets the currently active Scanner Profile. |
| Method Name |
Description |
| Append(PagesToScan As Int32) |
Starts the scanning process, inserting the newly-scanned pages before the currently selected node.
| Parameters |
| PagesToScan |
| Type: Int32 |
| |
|
| CreateMenuItem(Database As GrooperDb, Items As IEnumerable, CommandType As Type, Handler As EventHandler, ContextInstance As Object) As ToolStripMenuItem |
Creates a ToolStripMenuItem for a specific command type, if the command is enabled for a list of selected objects.
| Parameters |
| Database |
| Type: GrooperDb |
| The Grooper database. |
| |
| Items |
| Type: IEnumerable |
| The list of selected objects. |
| |
| CommandType |
| Type: Type |
| A type deriving from ObjectCommand. |
| |
| Handler |
| Type: EventHandler |
| The "Click" event handler to be wired up to the menu item. |
| |
| ContextInstance |
| Type: Object |
| An optional context instance. |
|
| CreateMenuItems(Database As GrooperDb, CommandTypes As IEnumerable(Of Type), Items As IEnumerable, Handler As EventHandler) As List(Of ToolStripMenuItem) |
Creates a list ToolStripMenuItems from a list of command types, returning one ToolStripMenuItem for each enabled command.
| Parameters |
| Database |
| Type: GrooperDb |
| The Grooper database. |
| |
| CommandTypes |
| Type: IEnumerable`1 |
| A list types deriving from ObjectCommand. |
| |
| Items |
| Type: IEnumerable |
| The list of selected objects. |
| |
| Handler |
| Type: EventHandler |
| The "Click" event handler to be wired up to the menu item. |
|
| CreateToolStripButtons(Database As GrooperDb, CommandTypes As IEnumerable(Of Type), Items As IEnumerable, Handler As EventHandler) As IEnumerable(Of ToolStripButton) |
Creates a list ToolStripButtons from a list of command types, returning one ToolStripButton for each enabled command.
| Parameters |
| Database |
| Type: GrooperDb |
| The Grooper database. |
| |
| CommandTypes |
| Type: IEnumerable`1 |
| A list types deriving from ObjectCommand. |
| |
| Items |
| Type: IEnumerable |
| The list of selected objects. |
| |
| Handler |
| Type: EventHandler |
| The "Click" event handler to be wired up to the button. |
|
| Dispose(disposing As Boolean) |
Releases the unmanaged resources used by the control and its child controls and optionally releases the managed resources.
| Parameters |
| disposing |
| Type: Boolean |
| true to release both managed and unmanaged resources; false to release only unmanaged resources. |
|
| Finalize() |
Releases unmanaged resources and performs other cleanup operations before the is reclaimed by garbage collection. |
| GetControlCommandTypes(ObjectType As Type, RepositoryId As Guid) As IEnumerable(Of Type) |
Returns a list of object commands which apply to a specific object type within the context of this control.
| Parameters |
| ObjectType |
| Type: Type |
| The object type. |
| |
| RepositoryId |
| Type: Guid |
| The GUID ID of the Grooper repository. |
|
| Initialize(Settings As Settings) |
Initializes the control. This method must be called prior to using the control.
| Parameters |
| Settings |
| Type: Settings |
| |
|
| Replace(PagesToScan As Int32) |
Rescans the currently selected pages. If the number of pages scanned is less than the number of pages selected, the additional selected pages are left unaltered.
If the number of pages scanned is more than the number of pages selected, the additional scanned pages are inserted after the last replaced page.
| Parameters |
| PagesToScan |
| Type: Int32 |
| |
|
| Scan() |
Starts the scanning process. The Scan() command always appends to the batch. To insert or replace pages, see the Rescan() and ScanInsert() commands. |
| ScanInsert(InsertAfter As Boolean, PagesToScan As Int32) |
Starts the scanning process, inserting the newly-scanned pages before the currently selected node.
| Parameters |
| InsertAfter |
| Type: Boolean |
| |
| |
| PagesToScan |
| Type: Int32 |
| |
|
| ShowValidationErrors(Items As ValidationErrorList, AllowInvalid As Boolean) As Boolean |
| Parameters |
| Items |
| Type: ValidationErrorList |
| |
| |
| AllowInvalid |
| Type: Boolean |
| |
|
| ValidateObject(Item As GrooperObject, AllowInvalid As Boolean) As Boolean |
| Parameters |
| Item |
| Type: GrooperObject |
| |
| |
| AllowInvalid |
| Type: Boolean |
| |
|
| ValidateProperties() As ValidationErrorList |
|