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 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
Delete pages	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.
Move page	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.
Rotate page	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.
Change document type	All controls except the Verification control.	On changing the document type for a document and pressing the ENTER key.	None
Create document	All controls except the Document review, Scan and Validation controls.	Never	None
Select document	All	When the selected document changes.	None
Select folder	All	When the selected folder changes. (For example, when a folder is selected in the Navigator.)	None
Delete document	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.
Delete documents	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.
Reject documents	All	On selecting multiple documents and selecting the Reject action using the toolbar, document context menu, or a hotkey.	Rejects the selected documents.
Unreject documents	All	On selecting multiple documents, and selecting the Unreject action using the toolbar, document context menu, or a hotkey.	Un-rejects the selected documents.
Merge document	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.
Merge documents	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.
Scan form loaded	All	On Scan CNJ form load.	None
Scan activity form loaded	All	On Scan activity form load.	None
Scan complete	Scan control
Validation form loaded	Validation control	On selecting the document for validation.	Validates the selected document.
Verification form loaded	Verification control	On selecting the document for verification.	Verifies the selected document.
Document review form loaded	Document review control	On selecting the document for review.	Reviews the selected document.
Split document	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.
Move document	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.
Create folder	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.
Delete folder	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.
Merge folder	All controls except the Document review, Scan and Validation controls.	Never	Not supported.
Split folder	All controls except the Document review, Scan and Validation controls.	Never	Not supported.
Move folder	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.
Save field changes	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.
Capture cancel activity	All	On selecting the Cancel activity action using the toolbar or a hotkey.	Saves any changes, and cancels the activity.
Capture complete activity	All	On selecting the Complete activity action using the toolbar or a hotkey.	Saves any changes and completes the activity.
Capture open activity	All controls except the Document review, Scan, Verification and Validation controls.	Never	None
Capture complete and take next activity	All	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.
Capture save activity	All controls except the Document review, Scan, Verification and Validation controls.	Never	None
Swap front and back sides	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.
Process tab form load	Scan	On selecting the process that contains initialization variables.	Gets the initialization variables.
Reject pages	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.
Unreject pages	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.
Create new job	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.
Confirm document type	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.
Override document 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.
Restore document 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.
Override folder 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.
Restore folder 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
Selection changed	When you change a field and shift the focus from it.	None
Field confirmed	When you select a field and then select the Confirm Field action by pressing the ENTER key on keyboard.	Confirm the selected field.
Field forced valid	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.
Combo box drop-down	When you focus the Choice field and expand the choice list.	None
Text Field
Text changed	When you change a field and shift the focus from it.	None
Field confirmed	When you select a field and then select the Confirm Field action by pressing the ENTER key.	Confirm the selected field.
Field forced valid	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
Check changed	When you change a field and shift the focus from it.	None
On field confirmed	When you select a field and select the Confirm Field action by pressing the ENTER key.	Confirm the selected field
Field forced valid	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
Table cell confirmed	When you select the table cell and select the Confirm Field action by pressing the ENTER key.	Confirm the selected table cell.
Table cell forced valid	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.
Table forced valid	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.
Table row added	When you select the Add Row action from a table toolbar.	Add a new last row to the table.
Table row inserted	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.
Table row deleted	When you select a Table Row select the Delete Row action from a table toolbar.	Delete the selected table rows.
Interpolate table	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.
Table cell combo box drop down	When you focus the Table cell in a choice column and then expand the choice list.	None
Table populated row inserted	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.
Table populated rows inserted	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.
Row selected	When you select a table row or any cell in that row.	None
Row deselected	When you deselect a table row or any cell in that row.	None