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

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

Static Public Member Functions

static SCDatabase GetDatabaseByName (string name)
 Return the requested local database object More...
 
static List< SCDatabase > GetDatabasesCollection ()
 Return a collection of all databases. More...
 
static SCFormatter GetFormatterByName (string name)
 Find field formatter based on the passed through name. More...
 
static List< SCFormatter > GetFormattersCollection ()
 Get collection of all available field formatters. This function makes a deep copy of every available formatter and may take some time. Using the FormatterByName functions is advised. More...
 
static SCLocator GetLocatorByName (string name)
 Find field formatter based on the passed through name. 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 List< SCLocator > GetLocatorsCollection ()
 Get collection of all available locators. This function makes a deep copy of every available locator and may take some time. Using the LocatorByName functions is advised. More...
 
static SCValidationRule GetValidationRuleByName (string name)
 Find Validation Rule based on the passed through name. More...
 
static List< SCValidationRule > GetValidationRulesCollection ()
 Get collection of all available validation rules. This function makes a deep copy of every available validationrule and may take some time. Using the ValidationRuleByName functions is advised. More...
 

Events

static Func< string, IDatabase > GetDatabaseByNameEvent
 Event GetDatabaseByNameEvent. More...
 
static Func< List< IDatabase > > GetDatabaseCollection
 Event GetDatabaseCollection. More...
 
static Func< string, IFieldFormatter > GetFormatterByNameEvent
 Event GetFormatterByName. More...
 
static Func< List< IFieldFormatter > > GetFormatterCollection
 Event GetFormatterCollection. More...
 
static Func< string, ILocator > GetLocaterByNameEvent
 Event GetLocByName. More...
 
static Func< List< ILocator > > GetLocatorCollection
 Event GetLocatorCollection. More...
 
static Func< string, IValidationRule > GetValidationRuleByNameEvent
 Event GetValidationRuleByNameEvent. More...
 
static Func< List< IValidationRule > > GetValidationRuleCollection
 Event GetValidationRuleCollection. More...
 

Detailed Description

Object containing common scripting properties and functions.

Member Function Documentation

◆ GetDatabaseByName()

static SCDatabase GetDatabaseByName ( string  name)
inlinestatic

Return the requested local database object

Parameters
nameDatabase name

◆ GetDatabasesCollection()

static List<SCDatabase> GetDatabasesCollection ( )
inlinestatic

Return a collection of all databases.

Returns

◆ GetFormatterByName()

static SCFormatter GetFormatterByName ( string  name)
inlinestatic

Find field formatter based on the passed through name.

Parameters
nameName to find
Returns
Return the requested field formatter

◆ GetFormattersCollection()

static List<SCFormatter> GetFormattersCollection ( )
inlinestatic

Get collection of all available field formatters. This function makes a deep copy of every available formatter and may take some time. Using the FormatterByName functions is advised.

Returns
Return a collection of all field formatters

◆ GetLocatorByName()

static SCLocator GetLocatorByName ( string  name)
inlinestatic

Find field formatter based on the passed through name.

Parameters
nameName to find
Returns
Return the requested field formatter

◆ 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

◆ GetLocatorsCollection()

static List<SCLocator> GetLocatorsCollection ( )
inlinestatic

Get collection of all available locators. This function makes a deep copy of every available locator and may take some time. Using the LocatorByName functions is advised.

Returns
Return a collection of all locators

◆ GetValidationRuleByName()

static SCValidationRule GetValidationRuleByName ( string  name)
inlinestatic

Find Validation Rule based on the passed through name.

Parameters
nameName to find
Returns
Return the requested validation rule

◆ GetValidationRulesCollection()

static List<SCValidationRule> GetValidationRulesCollection ( )
inlinestatic

Get collection of all available validation rules. This function makes a deep copy of every available validationrule and may take some time. Using the ValidationRuleByName functions is advised.

Returns
Return a collection of all validation rules

Event Documentation

◆ GetDatabaseByNameEvent

Func<string, IDatabase> GetDatabaseByNameEvent
static

Event GetDatabaseByNameEvent.

◆ GetDatabaseCollection

Func<List<IDatabase> > GetDatabaseCollection
static

Event GetDatabaseCollection.

◆ GetFormatterByNameEvent

Func<string, IFieldFormatter> GetFormatterByNameEvent
static

Event GetFormatterByName.

◆ GetFormatterCollection

Func<List<IFieldFormatter> > GetFormatterCollection
static

Event GetFormatterCollection.

◆ GetLocaterByNameEvent

Func<string, ILocator> GetLocaterByNameEvent
static

Event GetLocByName.

◆ GetLocatorCollection

Func<List<ILocator> > GetLocatorCollection
static

Event GetLocatorCollection.

◆ GetValidationRuleByNameEvent

Func<string, IValidationRule> GetValidationRuleByNameEvent
static

Event GetValidationRuleByNameEvent.

◆ GetValidationRuleCollection

Func<List<IValidationRule> > GetValidationRuleCollection
static

Event GetValidationRuleCollection.