Octobox API  4.1.0
Octobox Scripting API
Public Member Functions | Properties
SCFormatter

Object with the formatting settings. More...

Public Member Functions

string Execute (SCDocument doc, SCExtractionResult field)
 Find the extraction field in the document. More...
 
string FormatValue (string value)
 Get the formatted value of a passed through value. More...
 

Properties

string Description [get]
 Description of the formatter. More...
 
FormatterTypes FieldFormatterType [get]
 Formatting type. More...
 
Guid Id [get]
 GUID of the formatter. More...
 
string Name [get]
 Name of the formatter. More...
 

Detailed Description

Object with the formatting settings.

Member Function Documentation

◆ Execute()

string Execute ( SCDocument  doc,
SCExtractionResult  field 
)
inline

Find the extraction field in the document.

Parameters
docCurrent document
fieldExtraction result field to use
Returns
Formatted string of the found value

◆ FormatValue()

string FormatValue ( string  value)
inline

Get the formatted value of a passed through value.

Parameters
valueValue to format
Returns
Formatted value

Property Documentation

◆ Description

string Description
get

Description of the formatter.

◆ FieldFormatterType

FormatterTypes FieldFormatterType
get

Formatting type.

◆ Id

Guid Id
get

GUID of the formatter.

◆ Name

string Name
get

Name of the formatter.