|
Octobox API
4.1.0
Octobox Scripting API
|
Base class containing all available events in the ZoneSelection 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: 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... | |
Base class containing all available events in the ZoneSelection module.
|
inlinevirtual |
Event called when a custom action button is clicked. Scope: ZoneSelection 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: ZoneSelection activity and ZoneSelection 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 new document is loaded. Scope: ZoneSelection activity and ZoneSelection module.
| document | Document that was loaded |
|
inlinevirtual |
Event called when a document is validated. Scope: ZoneSelection activity and ZoneSelection module.
| document | Current document |
1.8.13