|
Octobox API
4.1.0
Octobox Scripting API
|
Base class for any plugin activity. More...
Public Member Functions | |
| void | Dispose () |
| Not used More... | |
| abstract bool | Execute (SCProcess batch, SettingsProfile settings) |
| Execute this activity on the current batch. More... | |
| bool | Execute (IDocumentProcess docProcess, SettingsProfile settings, IFieldPopulator pop) |
| Not used More... | |
Data Fields | |
| Func< string, string > | GetValueAsPath |
| Get value of any existing internal meta data field "{CESomeValue}" and remove invalid file path characters. More... | |
| Func< string, string > | GetValueAsText |
| Get value of any existing internal meta data field "{CESomeValue}". More... | |
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... | |
Additional Inherited Members | |
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 for any plugin activity.
|
inline |
Not used
|
pure virtual |
Execute this activity on the current batch.
| batch | The batch object to process |
| settings | The activity plugin settings |
|
inline |
Not used
| docProcess | |
| settings | |
| pop |
| Func<string, string> GetValueAsPath |
Get value of any existing internal meta data field "{CESomeValue}" and remove invalid file path characters.
| Func<string, string> GetValueAsText |
Get value of any existing internal meta data field "{CESomeValue}".
1.8.13