Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
FieldFormatterScriptBaseabstract

Base class for all field formatter scripts. More...

Inheritance diagram for FieldFormatterScriptBase:
ScriptBase

Public Member Functions

abstract FieldFormatterResult FormatField (String value)
 Format a field value and return the result. 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 for all field formatter scripts.

Member Function Documentation

◆ FormatField()

abstract FieldFormatterResult FormatField ( String  value)
pure virtual

Format a field value and return the result.

Parameters
valueValue to format
Returns
Formatted result