Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
ValidationScriptBase

Base class containing all available events in the validation module. More...

Inheritance diagram for ValidationScriptBase:
ScriptBase

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...
 

Detailed Description

Base class containing all available events in the validation module.

Member Function Documentation

◆ ActionButton_Clicked()

virtual void ActionButton_Clicked ( SCProcess  batch,
SCDocument  document,
int  mediumIndex,
int  pageIndex,
string  buttonName 
)
inlinevirtual

Event called when a custom action button is clicked. Scope: Validation module.

Parameters
batchCurrent batch
documentCurrent document

///

Parameters
mediumIndexZero based index of the current medium

///

Parameters
pageIndexZero based index of the current page
buttonNameName of the button that was clicked

◆ Batch_Closed()

virtual void Batch_Closed ( SCProcess  batch,
SCProcessStates  state 
)
inlinevirtual

Event called when a batch is closed. Scope: Validation activity and validation module.

Parameters
batchCurrent batch
stateState in which the batch is closed

◆ Batch_Loaded()

virtual void Batch_Loaded ( SCProcess  batch)
inlinevirtual

Event called when a new batch is loaded. Scope: Validation activity and validation module.

Parameters
batchThe batch loaded in the validation module

◆ Button_Clicked()

virtual void Button_Clicked ( SCDocument  document,
string  buttonName 
)
inlinevirtual

Event called when a button is clicked. Scope: Validation module.

Parameters
documentCurrent document
buttonNameName of the button that was clicked

◆ ComboBox_BeforeDropDown()

virtual void ComboBox_BeforeDropDown ( SCDocument  document,
string  comboboxName,
List< SCValidationListItem >  comboboxItems 
)
inlinevirtual

Event called when a combobox is selected and before the dropdown items are shown. Scope: Validation module.

Parameters
documentCurrent document
comboboxNameName of the combobox
comboboxItemsList of current items in the dropdown. This may be repopulated

◆ Document_AfterReclassified()

virtual void Document_AfterReclassified ( SCDocument  document,
string  oldType 
)
inlinevirtual

Event called after a document was reclassified. Scope: Validation module. For multivalidation this event will only be triggered on the multi validation profile

Parameters
documentCurrent document
oldTypeOld document type

◆ Document_BeforeReclassified()

virtual void Document_BeforeReclassified ( SCDocument  document,
string  newType,
ref bool  cancel 
)
inlinevirtual

Event called when a user requested a document reclassification. Scope: Validation module.

Parameters
documentCurrent document
newTypeNew document type
cancelSet to true to cancel reclassification

◆ Document_Loaded()

virtual void Document_Loaded ( SCDocument  document)
inlinevirtual

Event called when a new document is loaded. Scope: Validation activity and validation module.

Parameters
documentDocument that was loaded

◆ Document_Validated()

virtual bool Document_Validated ( SCDocument  document)
inlinevirtual

Event called when a document is validated. Scope: Validation activity and validation module.

Parameters
documentCurrent document
Returns
True to explicitly send this document to the validation module, False to depend on existing validation results

◆ Field_AfterAdded()

virtual void Field_AfterAdded ( SCDocument  document,
SCExtractionResult  field,
SCAlternative  alternative 
)
inlinevirtual

Event called after a new zone was manually created in zone selection mode Scope: Validation module.

Parameters
documentThe current document.
fieldField the new alternative was added to.
alternativeAlternative that was added.

◆ Field_AfterAssigned()

virtual void Field_AfterAssigned ( SCDocument  document,
List< SCAlternative >  assignedAlternatives,
SCExtractionResult  result 
)
inlinevirtual

Event called when alternatives were assigned to an extraction result in zone selection mode. Scope: Validation module.

Parameters
documentThe current document.
assignedAlternativesList of alternatives that were assigned to the target result.
resultField the alternatives were assigned to.

◆ Field_AfterChanged()

virtual void Field_AfterChanged ( SCDocument  document,
SCExtractionResult  field 
)
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.

Parameters
documentCurrent document
fieldField that was changed

◆ Field_AfterExtrapolate()

virtual void Field_AfterExtrapolate ( SCDocument  document,
List< SCAlternative >  addedAlternatives,
SCExtractionResult  result 
)
inlinevirtual

Event called when field extrapolation was executed in zone selection mode. Scope: Validation module.

Parameters
documentThe current document.
addedAlternativesList of alternatives that were found and added to the target result.
resultField the alternatives were added to.

◆ Fields_AfterConfirmed()

virtual void Fields_AfterConfirmed ( SCDocument  document,
List< SCAlternative >  confirmedAlternatives,
SCExtractionResult  result 
)
inlinevirtual

Event called when zones are confirmed in zone selection mode. Scope: Validation module.

Parameters
documentThe current document.
confirmedAlternativesList of alternatives that were confirmed.
resultField the alternatives were confirmed on.

◆ Fields_AfterDeleted()

virtual void Fields_AfterDeleted ( SCDocument  document,
List< SCAlternative >  removedAlternatives,
SCExtractionResult  result 
)
inlinevirtual

Event called when zones are deleted in zone selection mode. Scope: Validation module.

Parameters
documentThe current document.
removedAlternativesList of alternatives that were removed from the result.
resultField the alternatives were removed from.

◆ Fields_AfterMerge()

virtual void Fields_AfterMerge ( SCDocument  document,
List< SCAlternative >  mergedAlternatives,
SCAlternative  mergeResult 
)
inlinevirtual

Event called after merging is executed. Scope: Validation module.

Parameters
documentThe current document.
mergedAlternativesList of alternatives that were merged.
mergeResultResulting alternative after merge.

◆ Fields_BeforeMerge()

virtual void Fields_BeforeMerge ( SCDocument  document,
List< KeyValuePair< SCAlternative, string >>  alternativesToMerge 
)
inlinevirtual

Event called before merging is executed. Scope: Validation module.

Parameters
documentThe current document.
alternativesToMergeList of alternatives and their corresponding field name that will be merged.

◆ LookupDialog_Closed()

virtual void LookupDialog_Closed ( SCDocument  document,
string  dialogName,
SCLookupResult  result 
)
inlinevirtual

Event called when a lookup dialog was closed and a value was chosen. Scope: Validation module.

Parameters
documentCurrent document
dialogNameName of the dialog. When launched by a validation rule the name of that rule will be used
resultResulting record of the lookup

◆ TableCell_AfterChanged()

virtual void TableCell_AfterChanged ( SCDocument  document,
SCExtractionResult  field,
int  rowIndex 
)
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.

Parameters
documentCurrent document
fieldField that was changed
rowIndexIndex of row or alternative that was changed