|
Octobox API
4.1.0
Octobox Scripting API
|
Base class of extraction activity scripts containing all extraction events. More...
Public Member Functions | |
| virtual void | Batch_Closed (SCProcess batch) |
| Event called when a batch is closed. More... | |
| virtual void | Batch_Loaded (SCProcess batch) |
| Event called when a new batch is loaded. More... | |
| virtual void | Document_AfterExtract (SCDocument document) |
| Event called when a document is extracted. More... | |
| virtual void | Document_BeforeExtract (SCDocument document) |
| Event called before a document is extracted. More... | |
| virtual void | Field_AfterExtract (SCDocument document, SCExtractionResult result) |
| Event called after a non zone locator field is extracted. 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 of extraction activity scripts containing all extraction events.
|
inlinevirtual |
Event called when a batch is closed.
| batch | Current batch |
|
inlinevirtual |
Event called when a new batch is loaded.
| batch | The batch loaded in the validation module |
|
inlinevirtual |
Event called when a document is extracted.
| document | Current document |
|
inlinevirtual |
Event called before a document is extracted.
| document | Current document |
|
inlinevirtual |
Event called after a non zone locator field is extracted.
| document | Current document. Null when batchfield extraction |
| result | Extraction field to use |
1.8.13