Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
ExtractionScriptBase

Base class of extraction activity scripts containing all extraction events. More...

Inheritance diagram for ExtractionScriptBase:
ScriptBase

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

Detailed Description

Base class of extraction activity scripts containing all extraction events.

Member Function Documentation

◆ Batch_Closed()

virtual void Batch_Closed ( SCProcess  batch)
inlinevirtual

Event called when a batch is closed.

Parameters
batchCurrent batch

◆ Batch_Loaded()

virtual void Batch_Loaded ( SCProcess  batch)
inlinevirtual

Event called when a new batch is loaded.

Parameters
batchThe batch loaded in the validation module

◆ Document_AfterExtract()

virtual void Document_AfterExtract ( SCDocument  document)
inlinevirtual

Event called when a document is extracted.

Parameters
documentCurrent document

◆ Document_BeforeExtract()

virtual void Document_BeforeExtract ( SCDocument  document)
inlinevirtual

Event called before a document is extracted.

Parameters
documentCurrent document

◆ Field_AfterExtract()

virtual void Field_AfterExtract ( SCDocument  document,
SCExtractionResult  result 
)
inlinevirtual

Event called after a non zone locator field is extracted.

Parameters
documentCurrent document. Null when batchfield extraction
resultExtraction field to use