Octobox API  3.0.0
Octobox Scripting API
Static Public Member Functions | Events
SCProjectCollections

Object containing common scripting properties and functions. More...

Static Public Member Functions

static IDatabaseDictionary GetDictionaryByName (string name)
 Return the database dictionary for a passed through database name. More...
 
static SCFormatter GetFormatterByName (string name)
 Find Formatter based on the passed through name. More...
 
static IDatabaseLocal GetLocalDatabaseByName (string name)
 Return the database connection for a text based database. More...
 
static SCLocatorFormat GetLocatorFormatByName (string name)
 Find locator of type Locator Format based on the passed through name. More...
 
static SCLocatorFunctionFile GetLocatorFunctionFileByName (string name)
 Find locator of type Function File based on the passed through name. More...
 
static SCValidationRule GetValidationRuleByName (string name)
 Find Validation Rule based on the passed through name. More...
 

Events

static Func< string, IDatabase > GetDatabasesDatabase
 Event DatabasesDatabase. More...
 
static Func< string, IDatabase > GetDatabasesDictionary
 Event DatabasesDictionary. More...
 
static Func< string, IFieldFormatter > GetFieldFormatter
 Event FieldFormatter. More...
 
static Func< string, ILocator > GetLocatorFormat
 Event LocatorFormat. More...
 
static Func< string, ILocator > GetLocatorFunctionFile
 Event LocatorFunctionFile. More...
 
static Func< string, IValidationRule > GetValidationRule
 Event ValidationRule. More...
 

Detailed Description

Object containing common scripting properties and functions.

Member Function Documentation

◆ GetDictionaryByName()

static IDatabaseDictionary GetDictionaryByName ( string  name)
inlinestatic

Return the database dictionary for a passed through database name.

Parameters
nameName to find

◆ GetFormatterByName()

static SCFormatter GetFormatterByName ( string  name)
inlinestatic

Find Formatter based on the passed through name.

Parameters
nameName to find
Returns
Return the found formatter

◆ GetLocalDatabaseByName()

static IDatabaseLocal GetLocalDatabaseByName ( string  name)
inlinestatic

Return the database connection for a text based database.

Parameters
nameName to find

◆ GetLocatorFormatByName()

static SCLocatorFormat GetLocatorFormatByName ( string  name)
inlinestatic

Find locator of type Locator Format based on the passed through name.

Parameters
nameName to find
Returns
Return the found locator format

◆ GetLocatorFunctionFileByName()

static SCLocatorFunctionFile GetLocatorFunctionFileByName ( string  name)
inlinestatic

Find locator of type Function File based on the passed through name.

Parameters
nameName to find
Returns
Return the found locator function file

◆ GetValidationRuleByName()

static SCValidationRule GetValidationRuleByName ( string  name)
inlinestatic

Find Validation Rule based on the passed through name.

Parameters
nameName to find
Returns
Return the found validation rule

Event Documentation

◆ GetDatabasesDatabase

Func<string, IDatabase> GetDatabasesDatabase
static

Event DatabasesDatabase.

◆ GetDatabasesDictionary

Func<string, IDatabase> GetDatabasesDictionary
static

Event DatabasesDictionary.

◆ GetFieldFormatter

Func<string, IFieldFormatter> GetFieldFormatter
static

Event FieldFormatter.

◆ GetLocatorFormat

Func<string, ILocator> GetLocatorFormat
static

Event LocatorFormat.

◆ GetLocatorFunctionFile

Func<string, ILocator> GetLocatorFunctionFile
static

Event LocatorFunctionFile.

◆ GetValidationRule

Func<string, IValidationRule> GetValidationRule
static

Event ValidationRule.