Enables scripted content fragments to get contextual and configuration data related to the current widget / content fragment.
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| IsInWidgetPreviewMode | bool | Returns true when the widget's containing page, header, or footer is being edited | ||
| RegionName | string | Name of the current widget's region | ||
| WrapperElementId | string | DOM Id of the current widget's wrapper element |
Methods
ApplyTokens
Process tokens, such as resources, in a string
Usage
#set($stringResponse = $core_v2_widget.ApplyTokens($html))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| html | string | Html | Required |
Return Type
string
ClearValue
Removes the configured value for a property.
Usage
$core_v2_widget.ClearValue($propertyName)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required |
ExecuteEmbeddedFile
Usage
#set($stringResponse = $core_v2_widget.ExecuteEmbeddedFile($propertyName, $fileName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| fileName | string | File Name | Required |
Return Type
string
ExecuteFile
Loads, executes, and returns the content of an attached widget script file
Usage
#set($stringResponse = $core_v2_widget.ExecuteFile($fileName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| fileName | string | Name of attached widget script | Required |
Return Type
string
GetBoolValue
Returns the boolean widget configuration value specified by the property name
Usage
#set($nullableResponse = $core_v2_widget.GetBoolValue($propertyName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required |
Return Type
bool?
GetBoolValue
Returns the boolean widget configuration value specified by the property name
Usage
#set($nullableResponse = $core_v2_widget.GetBoolValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | bool | Default Value | Required |
Return Type
bool?
GetColorValue
Returns the color widget configuration value specified by the property name
Usage
#set($stringResponse = $core_v2_widget.GetColorValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | string | Default Value | Required |
Return Type
string
GetCustomValue
Returns the custom widget configuration value specified by the property name
Usage
#set($stringResponse = $core_v2_widget.GetCustomValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | string | Default Value | Required |
Return Type
string
GetDateTimeValue
Returns the DateTime widget configuration value specified by the property name
Usage
#set($nullableResponse = $core_v2_widget.GetDateTimeValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | DateTime | Default Value | Required |
Return Type
DateTime?
GetDateTimeValue
Returns the DateTime widget configuration value specified by the property name
Usage
#set($nullableResponse = $core_v2_widget.GetDateTimeValue($propertyName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required |
Return Type
DateTime?
GetDoubleValue
Returns the double widget configuration value specified by the property name
Usage
#set($nullableResponse = $core_v2_widget.GetDoubleValue($propertyName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required |
Return Type
double?
GetDoubleValue
Returns the double widget configuration value specified by the property name
Usage
#set($nullableResponse = $core_v2_widget.GetDoubleValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | double | Default Value | Required |
Return Type
double?
GetEmbeddedFile
Usage
#set($fileResponse = $core_v2_widget.GetEmbeddedFile($propertyName, $fileName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| fileName | string | File Name | Required |
Return Type
GetEmbeddedFileByUrl
Usage
#set($fileResponse = $core_v2_widget.GetEmbeddedFileByUrl($propertyName, $url))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| url | string | Url | Required |
Return Type
GetEmbeddedFiles
Usage
#set($iEnumerableResponse = $core_v2_widget.GetEmbeddedFiles($propertyName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required |
Return Type
IEnumerable<File>
GetExecutedEmbeddedFileUrl
Usage
#set($stringResponse = $core_v2_widget.GetExecutedEmbeddedFileUrl($propertyName, $fileName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| fileName | string | File Name | Required |
Return Type
string
GetExecutedFileUrl
Returns an absolute URL for a given widget attachment which, when requested, processes the attachment and reeturns its output
Usage
#set($stringResponse = $core_v2_widget.GetExecutedFileUrl($fileName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| fileName | string | Name of attached widget script | Required |
Return Type
string
GetFileUrl
Returns an absolute URL for a given widget attachment
Usage
#set($stringResponse = $core_v2_widget.GetFileUrl($fileName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| fileName | string | Name of widget attachment | Required |
Return Type
string
GetGuidValue
Returns the Guid widget configuration value specified by the property name
Usage
#set($nullableResponse = $core_v2_widget.GetGuidValue($propertyName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required |
Return Type
Guid?
GetGuidValue
Returns the Guid widget configuration value specified by the property name
Usage
#set($nullableResponse = $core_v2_widget.GetGuidValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | Guid | Default Value | Required |
Return Type
Guid?
GetHtmlValue
Returns the HTML widget configuration value specified by the property name
Usage
#set($stringResponse = $core_v2_widget.GetHtmlValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | string | Default Value | Required |
Return Type
string
GetIntValue
Returns the integer widget configuration value specified by the property name
Usage
#set($nullableResponse = $core_v2_widget.GetIntValue($propertyName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required |
Return Type
int?
GetIntValue
Returns the integer widget configuration value specified by the property name
Usage
#set($nullableResponse = $core_v2_widget.GetIntValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | int | Default Value | Required |
Return Type
int?
GetStringValue
Returns the string widget configuration value specified by the property name
Usage
#set($stringResponse = $core_v2_widget.GetStringValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | string | Default Value | Required |
Return Type
string
GetUnitValue
Returns the Unit widget configuration value specified by the property name
Usage
#set($stringResponse = $core_v2_widget.GetUnitValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | string | Default Value | Required |
Return Type
string
GetUrlListValue
Returns the URL list widget configuration value specified by the property name
Usage
#set($iListResponse = $core_v2_widget.GetUrlListValue($propertyName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required |
Return Type
IList<string>
GetUrlValue
Returns the URL widget configuration value specified by the property name
Usage
#set($stringResponse = $core_v2_widget.GetUrlValue($propertyName, $defaultValue))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| defaultValue | string | Default Value | Required |
Return Type
string
Hide
Hides the current widget
Usage
$core_v2_widget.Hide()
RenderEmbeddedFile
Usage
#set($stringResponse = $core_v2_widget.RenderEmbeddedFile($propertyName, $fileName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| fileName | string | File Name | Required |
Return Type
string
RenderFile
Loads and returns the content of an attached file without executing it
Usage
#set($stringResponse = $core_v2_widget.RenderFile($fileName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| fileName | string | Name of widget attachment | Required |
Return Type
string
SetBoolValue
Sets a boolean widget configuration value
Usage
$core_v2_widget.SetBoolValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | bool | Value | Required |
SetColorValue
Sets a Color widget configuration value
Usage
$core_v2_widget.SetColorValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | string | Value | Required |
SetCustomValue
Sets a custom widget configuration value
Usage
$core_v2_widget.SetCustomValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | string | Value | Required |
SetDateTimeValue
Sets a DateTime widget configuration value
Usage
$core_v2_widget.SetDateTimeValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | DateTime | Value | Required |
SetDoubleValue
Sets a double widget configuration value
Usage
$core_v2_widget.SetDoubleValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | double | Value | Required |
SetGuidValue
Sets a guid widget configuration value
Usage
$core_v2_widget.SetGuidValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | string | Value | Required |
SetHtmlValue
Sets an HTML widget configuration value
Usage
$core_v2_widget.SetHtmlValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | string | Value | Required |
SetIntValue
Sets an integer widget configuration value
Usage
$core_v2_widget.SetIntValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | int | Value | Required |
SetStringValue
Sets a string widget configuration value
Usage
$core_v2_widget.SetStringValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | string | Value | Required |
SetUnitValue
Sets a unit widget configuration value
Usage
$core_v2_widget.SetUnitValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | string | Value | Required |
SetUrlListValue
Sets a URL list widget configuration value
Usage
$core_v2_widget.SetUrlListValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | IList<string> | Value | Required |
SetUrlValue
Sets a URL widget configuration value
Usage
$core_v2_widget.SetUrlValue($propertyName, $value)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| propertyName | string | Property Name | Required | ||
| value | string | Value | Required |
UniqueId
Strengthens a given id to be unique across an entire page. Used to explicitly generate safe ids for DOM elements
Usage
#set($stringResponse = $core_v2_widget.UniqueId($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | string | Non-unique string | Required |
Return Type
string