Enables scripted content fragments to encode data for rendering.
Methods
HtmlAttributeEncode
Encodes text for use within HTML or XML attributes
Usage
#set($stringResponse = $core_v2_encoding.HtmlAttributeEncode($text))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
text | string | Raw text | Required |
Return Type
string
HtmlDecode
HTML-decodes text
Usage
#set($stringResponse = $core_v2_encoding.HtmlDecode($html))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
html | string | HTML-encoded text | Required |
Return Type
string
HtmlEncode
HTML-encodes text. Note, most text properties on data returned by the Platform API is already pre-encoded.
Usage
#set($stringResponse = $core_v2_encoding.HtmlEncode($text))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
text | string | Raw text | Required |
Return Type
string
HtmlEnsureEncoded
Ensures that text is HTML-encoded.
Usage
#set($stringResponse = $core_v2_encoding.HtmlEnsureEncoded($text))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
text | string | Raw text | Required |
Return Type
string
JavascriptEncode
Escapes text for use within JavaScript string literals or JSON values
Usage
#set($stringResponse = $core_v2_encoding.JavascriptEncode($text))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
text | string | Raw text | Required |
Return Type
string
JavascriptEncode
Escapes dates into a format suitable for javascript parsing.
Usage
#set($stringResponse = $core_v2_encoding.JavascriptEncode($date))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
date | DateTime | Source date | Required |
Return Type
string
UrlDecode
Decodes text that was URL encoded
Usage
#set($stringResponse = $core_v2_encoding.UrlDecode($text))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
text | string | Encoded text | Required |
Return Type
string
UrlDecodeFileComponent
Usage
#set($stringResponse = $core_v2_encoding.UrlDecodeFileComponent($urlToDecode))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
urlToDecode | string | Url To Decode | Required |
Return Type
string
UrlEncode
Encodes text for use within URL query parameters
Usage
#set($stringResponse = $core_v2_encoding.UrlEncode($text))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
text | string | Raw text | Required |
Return Type
string