core_v2_theme Script API

Ben Tiedt — Wed, 20 Nov 2019 14:55:32 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:55:32

Enables scripted content fragments to get contextual and configuration data related to the theme.

GetBoolValue
GetColorValue
GetCustomValue
GetDateTimeValue
GetDoubleValue
GetGuidValue
GetHtmlValue
GetIntValue
GetPaletteColorValue
GetPaletteDoubleValue
GetPaletteIntValue
GetPaletteStringValue
GetPaletteUnitValue
GetStringValue
GetUnitValue
GetUrlListValue
GetUrlValue

Methods

GetBoolValue

Returns the boolean theme configuration value specified by the property name

Velocity

#set($booleanResponse = $core_v2_theme.GetBoolValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var booleanResponse = core_v2_theme.GetBoolValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`String`	Property Name	Required
defaultValue	`Boolean`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

Boolean

GetColorValue

Returns the color theme configuration value specified by the property name

Velocity

#set($stringResponse = $core_v2_theme.GetColorValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetColorValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`String`	Property Name	Required
defaultValue	`String`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

String

GetCustomValue

Returns the custom theme configuration value specified by the property name

Velocity

#set($stringResponse = $core_v2_theme.GetCustomValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetCustomValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`String`	Property Name	Required
defaultValue	`String`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

String

GetDateTimeValue

Returns the DateTime theme configuration value specified by the property name

Velocity

#set($dateTimeResponse = $core_v2_theme.GetDateTimeValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var dateTimeResponse = core_v2_theme.GetDateTimeValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`String`	Property Name	Required
defaultValue	`DateTime`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

DateTime

GetDoubleValue

Returns the double theme configuration value specified by the property name

Velocity

#set($doubleResponse = $core_v2_theme.GetDoubleValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var doubleResponse = core_v2_theme.GetDoubleValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`String`	Property Name	Required
defaultValue	`Double`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

Double

GetGuidValue

Returns the Guid theme configuration value specified by the property name

Velocity

#set($guidResponse = $core_v2_theme.GetGuidValue($propertyName, $inheritanceDepth))

JavaScript

var guidResponse = core_v2_theme.GetGuidValue(propertyName, inheritanceDepth);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`String`	Property Name	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

Guid

GetHtmlValue

Returns the HTML theme configuration value specified by the property name

Velocity

#set($stringResponse = $core_v2_theme.GetHtmlValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetHtmlValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`String`	Property Name	Required
defaultValue	`String`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

String

GetIntValue

Returns the integer theme configuration value specified by the property name

Velocity

#set($int32Response = $core_v2_theme.GetIntValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var int32Response = core_v2_theme.GetIntValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`String`	Property Name	Required
defaultValue	`Int32`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

Int32

GetPaletteColorValue

Velocity

#set($stringResponse = $core_v2_theme.GetPaletteColorValue($paletteTypeId, $paletteId, $valueId, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetPaletteColorValue(paletteTypeId, paletteId, valueId, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
paletteTypeId	`String`	Palette Type Id	Required
paletteId	`String`	Palette Id	Required
valueId	`String`	Value Id	Required
defaultValue	`String`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

String

GetPaletteDoubleValue

Velocity

#set($doubleResponse = $core_v2_theme.GetPaletteDoubleValue($paletteTypeId, $paletteId, $valueId, $defaultValue, $inheritanceDepth))

JavaScript

var doubleResponse = core_v2_theme.GetPaletteDoubleValue(paletteTypeId, paletteId, valueId, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
paletteTypeId	`String`	Palette Type Id	Required
paletteId	`String`	Palette Id	Required
valueId	`String`	Value Id	Required
defaultValue	`Double`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

Double

GetPaletteIntValue

Velocity

#set($int32Response = $core_v2_theme.GetPaletteIntValue($paletteTypeId, $paletteId, $valueId, $defaultValue, $inheritanceDepth))

JavaScript

var int32Response = core_v2_theme.GetPaletteIntValue(paletteTypeId, paletteId, valueId, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
paletteTypeId	`String`	Palette Type Id	Required
paletteId	`String`	Palette Id	Required
valueId	`String`	Value Id	Required
defaultValue	`Int32`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

Int32

GetPaletteStringValue

Velocity

#set($stringResponse = $core_v2_theme.GetPaletteStringValue($paletteTypeId, $paletteId, $valueId, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetPaletteStringValue(paletteTypeId, paletteId, valueId, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
paletteTypeId	`String`	Palette Type Id	Required
paletteId	`String`	Palette Id	Required
valueId	`String`	Value Id	Required
defaultValue	`String`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

String

GetPaletteUnitValue

Velocity

#set($stringResponse = $core_v2_theme.GetPaletteUnitValue($paletteTypeId, $paletteId, $valueId, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetPaletteUnitValue(paletteTypeId, paletteId, valueId, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
paletteTypeId	`String`	Palette Type Id	Required
paletteId	`String`	Palette Id	Required
valueId	`String`	Value Id	Required
defaultValue	`String`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

String

GetStringValue

Returns the string theme configuration value specified by the property name

Velocity

#set($stringResponse = $core_v2_theme.GetStringValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetStringValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`String`	Property Name	Required
defaultValue	`String`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

String

GetUnitValue

Returns the Unit theme configuration value specified by the property name

Velocity

#set($stringResponse = $core_v2_theme.GetUnitValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetUnitValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`String`	Property Name	Required
defaultValue	`String`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

String

GetUrlListValue

Returns the URL list theme configuration value specified by the property name

Velocity

#set($iListResponse = $core_v2_theme.GetUrlListValue($propertyName, $inheritanceDepth))

JavaScript

var iListResponse = core_v2_theme.GetUrlListValue(propertyName, inheritanceDepth);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`String`	Property Name	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

IList of String

GetUrlValue

Returns the URL theme configuration value specified by the property name

Velocity

#set($stringResponse = $core_v2_theme.GetUrlValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetUrlValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`String`	Property Name	Required
defaultValue	`String`	Default Value	Required
inheritanceDepth	`Int32`	Inheritance Depth	Required

Returns

String