- Properties
- ClearValue
- GetBoolValue
- GetColorValue
- GetCustomValue
- GetDataType
- GetDateTimeValue
- GetDoubleValue
- GetGuidValue
- GetHtmlValue
- GetIntValue
- GetStringValue
- GetUnitValue
- GetUrlListValue
- GetUrlValue
- ResolveResource
- SetBoolValue
- SetColorValue
- SetCustomValue
- SetDateTimeValue
- SetDoubleValue
- SetGuidValue
- SetHtmlValue
- SetIntValue
- SetStringValue
- SetUnitValue
- SetUrlListValue
- SetUrlValue
Properties
Name | Access | Type | Description |
---|---|---|---|
Action | Read | String | The purpose of the exection of this property rule. When Action is 'Render', the rule is being executed to be rendered on the client side and an HTML response is required. When Action is 'Execute', the rule is being executed on the server side and no UI is expected. |
CanStoreUrlContents | Read | Boolean | Returns true if the configuration store for this property supports storing referenced URL contents. When URL contents can be stored, local CFS URL references in HTML, Url, UrlList, and configured Custom properties will be saved with this configuration data. |
DateFormatString | Read | String | The .net format string used to format a DateTime object into a date string. |
DateTimeFormatString | Read | String | The .net format string used to format a DateTime object into a date-and-time string. |
FormId | Read | String | The client identifier used by the form. This ID can be used with the dynamicForm jQuery plugin to interace with other properties within the same configuration form. Only available when Action is 'Render'. |
InitialValue | Read | Object | The current value of the property. Only available when Action is 'Render'. |
Property | Read | Property | The property associated to the rule. |
Rule | Read | PropertyRule | The rule being executed. |
SerializedInitialValue | Read | String | The current value of the property as serialized value. Only available when Action is 'Render'. |
TimeFormatString | Read | String | The .net format string used to format a DateTime object into a time string. |
UniqueId | Read | String | The unique identifier to use for client rendering. Any additional identifiers required by the rendering of the property should be extended from this one. Only available when Action is 'Render'. |
ValidUrlPattern | Read | String | The regular expression pattern that can be used to validate a URL. |
Methods
ClearValue
Removes the configured value for a property. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.ClearValue($propertyId)
JavaScript
context_v2_propertyRule.ClearValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
NothingGetBoolValue
Returns the boolean widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($nullableResponse = $context_v2_propertyRule.GetBoolValue($propertyId))
JavaScript
var nullableResponse = context_v2_propertyRule.GetBoolValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
Nullable of Boolean
GetColorValue
Returns the color widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($stringResponse = $context_v2_propertyRule.GetColorValue($propertyId))
JavaScript
var stringResponse = context_v2_propertyRule.GetColorValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
String
GetCustomValue
Returns the custom widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($stringResponse = $context_v2_propertyRule.GetCustomValue($propertyId))
JavaScript
var stringResponse = context_v2_propertyRule.GetCustomValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
String
GetDataType
Returns the data type of the requested property. Only available when Action is 'Execute'.
Velocity
#set($stringResponse = $context_v2_propertyRule.GetDataType($propertyId))
JavaScript
var stringResponse = context_v2_propertyRule.GetDataType(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
String
GetDateTimeValue
Returns the DateTime widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($nullableResponse = $context_v2_propertyRule.GetDateTimeValue($propertyId))
JavaScript
var nullableResponse = context_v2_propertyRule.GetDateTimeValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
Nullable of DateTime
GetDoubleValue
Returns the double widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($nullableResponse = $context_v2_propertyRule.GetDoubleValue($propertyId))
JavaScript
var nullableResponse = context_v2_propertyRule.GetDoubleValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
Nullable of Double
GetGuidValue
Returns the Guid widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($nullableResponse = $context_v2_propertyRule.GetGuidValue($propertyId))
JavaScript
var nullableResponse = context_v2_propertyRule.GetGuidValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
Nullable of Guid
GetHtmlValue
Returns the HTML widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($stringResponse = $context_v2_propertyRule.GetHtmlValue($propertyId))
JavaScript
var stringResponse = context_v2_propertyRule.GetHtmlValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
String
GetIntValue
Returns the integer widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($nullableResponse = $context_v2_propertyRule.GetIntValue($propertyId))
JavaScript
var nullableResponse = context_v2_propertyRule.GetIntValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
Nullable of Int32
GetStringValue
Returns the string widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($stringResponse = $context_v2_propertyRule.GetStringValue($propertyId))
JavaScript
var stringResponse = context_v2_propertyRule.GetStringValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
String
GetUnitValue
Returns the Unit widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($stringResponse = $context_v2_propertyRule.GetUnitValue($propertyId))
JavaScript
var stringResponse = context_v2_propertyRule.GetUnitValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
String
GetUrlListValue
Returns the URL list widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($iListResponse = $context_v2_propertyRule.GetUrlListValue($propertyId))
JavaScript
var iListResponse = context_v2_propertyRule.GetUrlListValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
IList of String
GetUrlValue
Returns the URL widget configuration value specified by the property name. Only available when Action is 'Execute'.
Velocity
#set($stringResponse = $context_v2_propertyRule.GetUrlValue($propertyId))
JavaScript
var stringResponse = context_v2_propertyRule.GetUrlValue(propertyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required |
Returns
String
ResolveResource
Resolves a language resource name to a string or defaults to the provided text if the resource is not available.
Velocity
#set($stringResponse = $context_v2_propertyRule.ResolveResource($resourceName, $defaultText))
JavaScript
var stringResponse = context_v2_propertyRule.ResolveResource(resourceName, defaultText);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
resourceName | String | Resource Name | Required | ||
defaultText | String | Default Text | Required |
Returns
String
SetBoolValue
Sets a boolean widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetBoolValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetBoolValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | Nullable of Boolean | Value | Required |
Returns
NothingSetColorValue
Sets a Color widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetColorValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetColorValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | String | Value | Required |
Returns
NothingSetCustomValue
Sets a custom widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetCustomValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetCustomValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | String | Value | Required |
Returns
NothingSetDateTimeValue
Sets a DateTime widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetDateTimeValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetDateTimeValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | Nullable of DateTime | Value | Required |
Returns
NothingSetDoubleValue
Sets a double widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetDoubleValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetDoubleValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | Nullable of Double | Value | Required |
Returns
NothingSetGuidValue
Sets a guid widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetGuidValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetGuidValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | String | Value | Required |
Returns
NothingSetHtmlValue
Sets an HTML widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetHtmlValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetHtmlValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | String | Value | Required |
Returns
NothingSetIntValue
Sets an integer widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetIntValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetIntValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | Nullable of Int32 | Value | Required |
Returns
NothingSetStringValue
Sets a string widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetStringValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetStringValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | String | Value | Required |
Returns
NothingSetUnitValue
Sets a unit widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetUnitValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetUnitValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | String | Value | Required |
Returns
NothingSetUrlListValue
Sets a URL list widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetUrlListValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetUrlListValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | IList of String | Value | Required |
Returns
NothingSetUrlValue
Sets a URL widget configuration value. Only available when Action is 'Execute'.
Velocity
$context_v2_propertyRule.SetUrlValue($propertyId, $value)
JavaScript
context_v2_propertyRule.SetUrlValue(propertyId, value);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
propertyId | String | Property Id | Required | ||
value | String | Value | Required |