|
Octobox API
4.1.0
Octobox Scripting API
|
Base class containing all available events in the validation module. More...
Public Member Functions | |
| virtual void | ActionButton_Clicked (SCProcess batch, SCDocument document, int mediumIndex, int pageIndex, string buttonName) |
| Event called when a custom action button is clicked. Scope: Validation module. More... | |
| virtual void | Batch_Closed (SCProcess batch, SCProcessStates state) |
| Event called when a batch is closed. Scope: Validation activity and validation module. More... | |
| virtual void | Batch_Loaded (SCProcess batch) |
| Event called when a new batch is loaded. Scope: Validation activity and validation module. More... | |
| virtual void | Button_Clicked (SCDocument document, string buttonName) |
| Event called when a button is clicked. Scope: Validation module. More... | |
| virtual void | ComboBox_BeforeDropDown (SCDocument document, string comboboxName, List< SCValidationListItem > comboboxItems) |
| Event called when a combobox is selected and before the dropdown items are shown. Scope: Validation module. More... | |
| virtual void | Document_AfterReclassified (SCDocument document, string oldType) |
| Event called after a document was reclassified. Scope: Validation module. For multivalidation this event will only be triggered on the multi validation profile More... | |
| virtual void | Document_BeforeReclassified (SCDocument document, string newType, ref bool cancel) |
| Event called when a user requested a document reclassification. Scope: Validation module. More... | |
| virtual void | Document_Loaded (SCDocument document) |
| Event called when a new document is loaded. Scope: Validation activity and validation module. More... | |
| virtual bool | Document_Validated (SCDocument document) |
| Event called when a document is validated. Scope: Validation activity and validation module. More... | |
| virtual void | Field_AfterAdded (SCDocument document, SCExtractionResult field, SCAlternative alternative) |
| Event called after a new zone was manually created in zone selection mode Scope: Validation module. More... | |
| virtual void | Field_AfterAssigned (SCDocument document, List< SCAlternative > assignedAlternatives, SCExtractionResult result) |
| Event called when alternatives were assigned to an extraction result in zone selection mode. Scope: Validation module. More... | |
| virtual void | Field_AfterChanged (SCDocument document, SCExtractionResult field) |
| Event called when a fields value is changed by the user and after execution of the optional field formatter and validation rule. Scope: Validation module. More... | |
| virtual void | Field_AfterExtrapolate (SCDocument document, List< SCAlternative > addedAlternatives, SCExtractionResult result) |
| Event called when field extrapolation was executed in zone selection mode. Scope: Validation module. More... | |
| virtual void | Fields_AfterConfirmed (SCDocument document, List< SCAlternative > confirmedAlternatives, SCExtractionResult result) |
| Event called when zones are confirmed in zone selection mode. Scope: Validation module. More... | |
| virtual void | Fields_AfterDeleted (SCDocument document, List< SCAlternative > removedAlternatives, SCExtractionResult result) |
| Event called when zones are deleted in zone selection mode. Scope: Validation module. More... | |
| virtual void | Fields_AfterMerge (SCDocument document, List< SCAlternative > mergedAlternatives, SCAlternative mergeResult) |
| Event called after merging is executed. Scope: Validation module. More... | |
| virtual void | Fields_BeforeMerge (SCDocument document, List< KeyValuePair< SCAlternative, string >> alternativesToMerge) |
| Event called before merging is executed. Scope: Validation module. More... | |
| virtual void | LookupDialog_Closed (SCDocument document, string dialogName, SCLookupResult result) |
| Event called when a lookup dialog was closed and a value was chosen. Scope: Validation module. More... | |
| virtual void | TableCell_AfterChanged (SCDocument document, SCExtractionResult field, int rowIndex) |
| Event called when a table cells value is changed by the user and after execution of the optional field formatter and validation rule. Scope: Validation module. More... | |
Additional Inherited Members | |
Data Fields inherited from ScriptBase | |
| Action< string > | LogInfo |
| Write text to the Octobox logging at information level. More... | |
| Action< string > | LogMsg |
| Write text to the Octobox logging at normal level. More... | |
Properties inherited from ScriptBase | |
| SCProcess | Batch [get, set] |
| Batch object containing global values available to all scripts. More... | |
| CancellationToken | CancellationToken [get, set] |
| Cancellation token that can be checked for process cancellation on long running script actions. More... | |
| SourceApplications | SourceApplication [get, set] |
| Application that called this function. More... | |
Base class containing all available events in the validation module.
|
inlinevirtual |
Event called when a custom action button is clicked. Scope: Validation module.
| batch | Current batch |
| document | Current document |
///
| mediumIndex | Zero based index of the current medium |
///
| pageIndex | Zero based index of the current page |
| buttonName | Name of the button that was clicked |
|
inlinevirtual |
Event called when a batch is closed. Scope: Validation activity and validation module.
| batch | Current batch |
| state | State in which the batch is closed |
|
inlinevirtual |
Event called when a new batch is loaded. Scope: Validation activity and validation module.
| batch | The batch loaded in the validation module |
|
inlinevirtual |
Event called when a button is clicked. Scope: Validation module.
| document | Current document |
| buttonName | Name of the button that was clicked |
|
inlinevirtual |
Event called when a combobox is selected and before the dropdown items are shown. Scope: Validation module.
| document | Current document |
| comboboxName | Name of the combobox |
| comboboxItems | List of current items in the dropdown. This may be repopulated |
|
inlinevirtual |
Event called after a document was reclassified. Scope: Validation module. For multivalidation this event will only be triggered on the multi validation profile
| document | Current document |
| oldType | Old document type |
|
inlinevirtual |
Event called when a user requested a document reclassification. Scope: Validation module.
| document | Current document |
| newType | New document type |
| cancel | Set to true to cancel reclassification |
|
inlinevirtual |
Event called when a new document is loaded. Scope: Validation activity and validation module.
| document | Document that was loaded |
|
inlinevirtual |
Event called when a document is validated. Scope: Validation activity and validation module.
| document | Current document |
|
inlinevirtual |
Event called after a new zone was manually created in zone selection mode Scope: Validation module.
| document | The current document. |
| field | Field the new alternative was added to. |
| alternative | Alternative that was added. |
|
inlinevirtual |
Event called when alternatives were assigned to an extraction result in zone selection mode. Scope: Validation module.
| document | The current document. |
| assignedAlternatives | List of alternatives that were assigned to the target result. |
| result | Field the alternatives were assigned to. |
|
inlinevirtual |
Event called when a fields value is changed by the user and after execution of the optional field formatter and validation rule. Scope: Validation module.
| document | Current document |
| field | Field that was changed |
|
inlinevirtual |
Event called when field extrapolation was executed in zone selection mode. Scope: Validation module.
| document | The current document. |
| addedAlternatives | List of alternatives that were found and added to the target result. |
| result | Field the alternatives were added to. |
|
inlinevirtual |
Event called when zones are confirmed in zone selection mode. Scope: Validation module.
| document | The current document. |
| confirmedAlternatives | List of alternatives that were confirmed. |
| result | Field the alternatives were confirmed on. |
|
inlinevirtual |
Event called when zones are deleted in zone selection mode. Scope: Validation module.
| document | The current document. |
| removedAlternatives | List of alternatives that were removed from the result. |
| result | Field the alternatives were removed from. |
|
inlinevirtual |
Event called after merging is executed. Scope: Validation module.
| document | The current document. |
| mergedAlternatives | List of alternatives that were merged. |
| mergeResult | Resulting alternative after merge. |
|
inlinevirtual |
Event called before merging is executed. Scope: Validation module.
| document | The current document. |
| alternativesToMerge | List of alternatives and their corresponding field name that will be merged. |
|
inlinevirtual |
Event called when a lookup dialog was closed and a value was chosen. Scope: Validation module.
| document | Current document |
| dialogName | Name of the dialog. When launched by a validation rule the name of that rule will be used |
| result | Resulting record of the lookup |
|
inlinevirtual |
Event called when a table cells value is changed by the user and after execution of the optional field formatter and validation rule. Scope: Validation module.
| document | Current document |
| field | Field that was changed |
| rowIndex | Index of row or alternative that was changed |
1.8.13