Enables scripted content fragments to retrieve localized text and format data.
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| Code | string | Identifies the current language code, for example, en. | ||
| CodeAndLocale | string | Identifies the current language code and locale, for example, en-us. | ||
| IsRightToLeft | bool | Identifies if the accessing user's language is rendered right to left. | ||
| NewLine | string | Environment-aware new line character |
Methods
FormatAgoDate
Formats a date as a readable 'time ago' format. DEPRECATED: Parameter "useUserTime" is no longer supported
Usage
#set($stringResponse = $core_v2_language.FormatAgoDate($date, $useUserTime))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| date | DateTime | Date | Required | ||
| useUserTime | bool | Use User Time | Required |
Return Type
string
FormatAgoDate
Formats a date as a readable 'time ago' format
Usage
#set($stringResponse = $core_v2_language.FormatAgoDate($date))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| date | DateTime | Date | Required |
Return Type
string
FormatDataSize
Formats a data size
Usage
#set($stringResponse = $core_v2_language.FormatDataSize($size))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| size | int | Size | Required |
Return Type
string
FormatDate
Formats a date to the default date format
Usage
#set($stringResponse = $core_v2_language.FormatDate($date))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| date | DateTime | Date | Required |
Return Type
string
FormatDate
Formats a date to a custom date format
Usage
#set($stringResponse = $core_v2_language.FormatDate($date, $format))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| date | DateTime | Date | Required | ||
| format | string | Supports standard and custom datetime formats as defined msdn.microsoft.com/.../az4se3k1.aspx and msdn.microsoft.com/.../8kb3ddd4.aspx | Required |
Return Type
string
FormatDate
Formats a date to a custom date format and or adjusted time zone
Usage
#set($stringResponse = $core_v2_language.FormatDate($date, "%{AdjustTimeZone = $adjustTimeZoneArg, Format = $formatArg, TimeZoneId = $timeZoneIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| date | DateTime | Date | Required | ||
| AdjustTimeZone | bool | When true, converts to accessing user's time zone. DEPRECATED: this parameter is no longer supported | Optional | True | |
| Format | string | Custom format | Optional | ||
| TimeZoneId | string | TimeZone Id | Optional |
Return Type
string
FormatDateAndTime
Formats a date to the default date and time format
Usage
#set($stringResponse = $core_v2_language.FormatDateAndTime($date))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| date | DateTime | Date | Required |
Return Type
string
FormatDateAndTime
Formats a date to the default date and time format
Usage
#set($stringResponse = $core_v2_language.FormatDateAndTime($date, "%{AdjustTimeZone = $adjustTimeZoneArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| date | DateTime | Date | Required | ||
| AdjustTimeZone | bool | When true, converts to accessing user's time zone. DEPRECATED: this parameter is no longer supported | Optional | True |
Return Type
string
FormatNumber
Formats a number
Usage
#set($stringResponse = $core_v2_language.FormatNumber($number))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| number | int | Number | Required |
Return Type
string
FormatNumber
Formats a number
Usage
#set($stringResponse = $core_v2_language.FormatNumber($number))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| number | double | Number | Required |
Return Type
string
FormatString
Replaces each format item in a specified string with the text equivalent of a corresponding object's value.
Usage
#set($stringResponse = $core_v2_language.FormatString($format, $parameters))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| format | string | Format string including indexed placeholders: {0}, {1}, {2}, etc | Required | ||
| parameters | string[] | Parameters | Required |
Return Type
string
FormatString
Replaces each format item of the format {NAME} with the value of the item with that name in the parameters dictionary.
Usage
#set($stringResponse = $core_v2_language.FormatString($format, "%{ = $Arg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| format | string | Format string including named parameters in the format {name}. | Required | ||
| Parameter values, indexed by name. | Optional |
Return Type
string
FormatTime
Formats the time component of a date/time using the site default time format.
Usage
#set($stringResponse = $core_v2_language.FormatTime($time))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| time | DateTime | Time | Required |
Return Type
string
FormatUrl
Formats a URL
Usage
#set($stringResponse = $core_v2_language.FormatUrl($url))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| url | string | Url | Required |
Return Type
string
GetInitials
Returns initials for a full Name
Usage
#set($stringResponse = $core_v2_language.GetInitials($fullName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| fullName | string | Full Name | Required |
Return Type
string
GetResource
Gets the widget-specified language resource defined by a resource name
Usage
#set($stringResponse = $core_v2_language.GetResource($resourceName))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| resourceName | string | Resource Name | Required |
Return Type
string
Lowercase
Converts a string to lower-case
Usage
#set($stringResponse = $core_v2_language.Lowercase($text))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| text | string | Text | Required |
Return Type
string
RemoveHtml
Removes HTML from a string
Usage
#set($stringResponse = $core_v2_language.RemoveHtml($html))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| html | string | Html | Required |
Return Type
string
Truncate
Truncates text as close to the desiredLength as possible without breaking words. Also removes HTML
Usage
#set($stringResponse = $core_v2_language.Truncate($text, $desiredLength, $ellipsis))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| text | string | Text | Required | ||
| desiredLength | int | Desired Length | Required | ||
| ellipsis | string | String to truncate | Required |
Return Type
string
Truncate
Truncates text as close to the desiredLength as possible without breaking words.
Usage
#set($stringResponse = $core_v2_language.Truncate($text, $desiredLength, "%{Ellipsis = $ellipsisArg, MaintainHtmlFormatting = $maintainHtmlFormattingArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| text | string | String to truncate | Required | ||
| desiredLength | int | Desired length to truncate at. Truncation will break on the next word boundary. | Required | ||
| Ellipsis | string | String to append after the truncated string. | Optional | ... | |
| MaintainHtmlFormatting | bool | When true, maintains HTML formatting within the trucated string. | Optional | False |
Return Type
string
Uppercase
Converts a string to upper-case
Usage
#set($stringResponse = $core_v2_language.Uppercase($text))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| text | string | Text | Required |
Return Type
string