Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
ZoneSelectionScriptBase

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

Inheritance diagram for ZoneSelectionScriptBase:
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: ZoneSelection module. More...
 
virtual void Batch_Closed (SCProcess batch, SCProcessStates state)
 Event called when a batch is closed. Scope: ZoneSelection activity and ZoneSelection 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 Document_Loaded (SCDocument document)
 Event called when a new document is loaded. Scope: ZoneSelection activity and ZoneSelection module. More...
 
virtual bool Document_Validated (SCDocument document)
 Event called when a document is validated. Scope: ZoneSelection activity and ZoneSelection 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 ZoneSelection 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: ZoneSelection 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: ZoneSelection activity and ZoneSelection 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

◆ Document_Loaded()

virtual void Document_Loaded ( SCDocument  document)
inlinevirtual

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

Parameters
documentDocument that was loaded

◆ Document_Validated()

virtual bool Document_Validated ( SCDocument  document)
inlinevirtual

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

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