Events and actions supported by the Capture Client controls

The capture controls used in the capture activities expose events that correspond to the toolbar buttons, context menus, and hotkeys. Example: The OnDeletePages event is fired to delete the selected pages. Most of the events are pre-populated with actions to perform the intended operation and are available in multiple capture controls. Access to these events is based on the assigned capture permissions . You can customize these events in the TotalAgility Form Designer.

The following table describes the events available for capture controls, when they are fired and the action they perform.

Event Capture Control Fired Action

OnDeletePages

All controls except the Verification control.

On selecting one or more pages, and selecting the Delete Page action using the toolbar, page context menu or a hotkey.

Deletes the selected pages.

OnMovePage

All controls except the Verification control.

On moving one or more pages using a drag-and-drop operation or a hotkey.

Moves the selected pages.

OnRotatePage

All controls except the Verification control.

On selecting one or more pages and selecting a Rotate Page action using the toolbar, page context menu or a hotkey.

Rotates the selected pages.

OnChangeDocumentType

All controls except the Verification control.

On changing the document type for a document and pressing the ENTER key.

None

OnCreateDocument

All controls except the Verification control.

Never

None

OnSelectDocument

All

When the selected document changes.

None

OnSelectFolder

All

When the selected folder changes. (Example: When a folder is selected in the Navigator.)

None

OnDeleteDocument

All controls except the Verification control.

On selecting a single document, and selecting the Delete action using the toolbar, document context menu, or a hotkey.

Deletes the selected document.

OnDeleteDocuments

All controls except the Verification control.

On selecting multiple documents, and selecting the Delete action using the toolbar, document context menu, or a hotkey.

Deletes the selected documents.

OnRejectDocuments

All

On selecting multiple documents and selecting the Reject action using the toolbar, document context menu, or a hotkey.

Rejects the selected documents.

OnUnRejectDocuments

All

On selecting multiple documents, and selecting the Unreject action using the toolbar, document context menu, or a hotkey.

Un-rejects the selected documents.

OnMergeDocument

All controls except the Verification control.

On selecting a single document and selecting the Merge to Previous Document action using the document context menu, or a hotkey.

Merges the selected document to the previous documents.

OnMergeDocuments

All controls except the Verification control.

On selecting multiple documents and selecting the Merge selected documents action using the document context menu, or a hotkey.

Merges the selected documents.

OnSplitDocument

All controls except the Verification control.

On selecting a single page and selecting the Split Document action using the page context menu or a hotkey.

Splits the document at the selected page.

OnMoveDocument

All controls except the Verification control.

On selecting a single document and moving the document using the drag-and-drop operation or a hotkey.

Moves the selected document.

OnCreateFolder

All controls except the Verification control.

On selecting a folder and selecting the Create Folder action from the folder context menu, or a hotkey.

Creates a new child folder.

OnDeleteFolder

All controls except the Verification control.

On selecting a folder and selecting the Create Folder action from the folder context menu, or a hotkey.

Deletes the selected folder.

OnMergeFolder

All controls except the Verification control.

Never

Not supported.

OnSplitFolder

All controls except the Verification control.

Never

Not supported.

OnMoveFolder

All controls except the Verification control.

On selecting a folder and moving the folder using the drag-and-drop operation.

Moves the selected folder to a new location.

OnSaveFieldChanges

All controls except the Verification control.

On modifying the fields of a document or folder, and navigating to a different document or folder.

Saves if any fields are changed.

OnCaptureCancelActivity

All controls except the Verification control.

On selecting the Cancel activity action using the toolbar or a hotkey.

Saves any changes, and cancels the activity.

OnCaptureCompleteActivity

All controls except the Verification control.

On selecting the Complete activity action using the toolba,r or a hotkey.

Saves any changes and completes the activity.

OnCaptureOpenActivity

All controls except the Verification control.

Never

None

OnCaptureComplete

AndTakeNextActivity

All controls except the Verification control.

On selecting the Complete and Take Next activity action using the toolbar, or a hotkey.

Saves any changes, completes the activity and takes the next activity from the work queue.

OnCaptureSaveActivity

All controls except the Verification control.

Never

None

OnSwapFrontAndBackSides

All controls except the Verification control.

On selecting a duplex page and then selecting the Swap Front and Back Sides operation using the page context menu, or a hotkey.

Swaps the front and back sides of the selected duplex pages.

OnRejectPages

All

On selecting one or more pages and selecting the Reject action using the toolbar, the page context menu, or a hotkey.

Rejects the selected pages.

OnUnrejectPages

All

On selecting one or more pages and selecting the Unreject action using the toolbar, the page context menu, or a hotkey.

Un-rejects the selected pages.

OnCreateNewJob

Scan Control in a Scan Create New Job form.

On selecting the Create New Job action using the toolbar, or a hotkey.

Creates a new job.

OnConfirmDocumentType

Document Review Control

On selecting a document and selecting the Confirm Document Type action using the toolbar, or a hotkey.

Confirms the document type for the selected document.

OnOverrideDocument

Problem

Document Review Control

On selecting a document and selecting the Override Problem action using the toolbar, or a hotkey.

Overrides the problem for the selected document and makes the document valid in document review.

OnRestoreDocument

Problem

Document Review Control

On selecting a document and selecting the Restore Problem action using the toolbar, or a hotkey.

Restores the problem for the selected document.

OnOverrideFolder

Problem

Document Review Control

On selecting a folder and selecting the Restore Problem action using the toolbar, or a hotkey.

Overrides the problem for the selected folder and makes the folder valid in Document Review.

OnRestoreFolder

Problem

Document Review Control

On selecting a folder and selecting the Restore Problem action using the toolbar, or a hotkey.

Restores the folder problem.

Capture field events

Event Fired Action
Choice Field

SelectionChanged

When you change a field and shift the focus from it.

None

OnFieldConfirmed

When you select a field and then select the Confirm Field action by pressing the ENTER key on keyboard.

Confirm the selected field.

FieldForcedValid

When you select a field and then select the Force Field Valid action by pressing the CTRL+ENTER key.

Force the selected field to be valid.

OnComboBoxDropDown

When you focus the Choice field and expand the choice list.

None

Text Field

TextChanged

When you change a field and shift the focus from it.

None

OnFieldConfirmed

When you select a field and then select the Confirm Field action by pressing the ENTER key.

Confirm the selected field.

FieldForcedValid

When you select a field and then select the Force Field Valid action by pressing the CTRL+ENTER key.

Force the selected field to be valid.

Boolean

CheckChanged

When you change a field and shift the focus from it.

None

OnFieldConfirmed

When you select a field and select the Confirm Field action by pressing the ENTER key.

Confirm the selected field

FieldForcedValid

When you select a field and then select the Force Field Valid action using the toolbar or the CTRL+ENTER key.

Force the selected field to be valid.

Table

OnTableCellConfirmed

When you select the table cell and select the Confirm Field action by pressing the ENTER key.

Confirm the selected table cell.

OnTableCellForcedValid

When you select a field and select the Force Field Valid action using the toolbar or the CTRL+ENTER key.

Force the selected table cell to be valid.

OnTableForcedValid

When you select a table and select the Force Field Valid action using the toolbar or the CTRL+ENTER key.

Force the selected table to be valid.

OnTableRowAdded

When you select the Add Row action from a table toolbar.

Add a new last row to the table.

OnTableRowInserted

When you select a Insert Row action from a table toolbar.

Insert a row in the table before the currently selected cell or row. If there is no selected cell or row, the new row is added to the end of the table.

OnTableRowDeleted

When you select a Table Row select the Delete Row action from a table toolbar.

Delete the selected table rows.

OnInterpolateTable

When you select a Table Row and select the interpolate table action from a table toolbar.

Perform interpolation using the selected row as the template for finding additional rows.

OnTableCellComboBoxDropDown

When you focus the Table cell in a choice column and then expand the choice list.

None

OnTablePopulatedRowInserted

When you add a row to a table in a form using the Add Row action.

Insert a row populated with data into the table.

OnTablePopulatedRowsInserted

When you add a row to a table in a form using the Add Row action.

Execute a .NET action to insert multiple rows into the table.

RowSelected

When you select a table row or any cell in that row.

None