$core_v2_utility Widget Extension

Enables scripted content fragments to have access to useful utility methods

Properties

Name	Type	Description
CurrentDate	`DateTime`	The current date
CurrentUserDate	`DateTime`	The current user date
NewLine	`string`	New Line Character

Methods

AdjustTimeZone

Converts the date to new time zone. OBSOLETE in 10.1

Usage

#set($dateTimeResponse = $core_v2_utility.AdjustTimeZone($date, $timeZoneId))

Parameters

Name	Type	Description	Required	Default	Options
date	`DateTime`	Date	Required
timeZoneId	`string`	Time Zone Id	Required

Return Type

DateTime

ContainsContent

Usage

#set($booleanResponse = $core_v2_utility.ContainsContent($html))

Parameters

Name	Type	Description	Required	Default	Options
html	`string`	Html	Required

Return Type

bool

Describe

Returns debug information about a given object, recursing all properties

Usage

#set($stringResponse = $core_v2_utility.Describe($item, "%{Depth = $depthArg, Format = $formatArg}"))

Parameters

Name	Type	Description	Required	Default	Options
item	`Object`	Item	Required
Depth	`int`	Depth of traversal	Optional	2
Format	`string`	Format	Optional	list	list, text

Return Type

string

Describe

Returns debug information about a given object, recursing all properties

Usage

#set($stringResponse = $core_v2_utility.Describe($o))

Parameters

Name	Type	Description	Required	Default	Options
o	`Object`	O	Required

Return Type

string

FlattenHierarchy

Flattens a nested hierarchy of objects

Usage

#set($iListResponse = $core_v2_utility.FlattenHierarchy($hierarchy, $recursiveProperty, "%{ExpandToChildProperty = $expandToChildPropertyArg, ExpandToChildValue = $expandToChildValueArg, ExpandToLevel = $expandToLevelArg, HiddenProperty = $hiddenPropertyArg}"))

Parameters

Name	Type	Description	Required
hierarchy	`IEnumerable`	Hierarchy	Required
recursiveProperty	`string`	Recursive Property	Required
ExpandToChildProperty	`string`	Expand To Child Property	Optional
ExpandToChildValue	`string`	Expand To Child Value	Optional
ExpandToLevel	`int`	Expand To Level	Optional
HiddenProperty	`string`	Hidden Property	Optional

Return Type

IList<FlattenedHierarchyItem>

FlattenHierarchy

Flattens a nested hierarchy of objects

Usage

#set($iListResponse = $core_v2_utility.FlattenHierarchy($hierarchy, $recursiveProperty))

Parameters

Name	Type	Description	Required	Default	Options
hierarchy	`IEnumerable`	Hierarchy	Required
recursiveProperty	`string`	Recursive Property	Required

Return Type

IList<FlattenedHierarchyItem>

GetTemporaryData

Retrieves temporary data

Usage

#set($stringResponse = $core_v2_utility.GetTemporaryData($key))

Parameters

Name	Type	Description	Required	Default	Options
key	`string`	Key	Required

Return Type

string

GetTimestamp

Creates an timestamp representation of the date supplied.

Usage

#set($stringResponse = $core_v2_utility.GetTimestamp($date))

Parameters

Name	Type	Description	Required	Default	Options
date	`DateTime`	Date	Required

Return Type

string

IsMatch

Tests a string against a regular expression pattern

Usage

#set($booleanResponse = $core_v2_utility.IsMatch($input, $pattern, "%{RegexOptions = $regexOptionsArg}"))

Parameters

Name	Type	Description	Required	Options
input	`string`	Input	Required
pattern	`string`	Pattern	Required
RegexOptions	`IList<string>`	List of options.	Optional	Compiled, CultureInvariant, ECMAScript, ExplicitCapture, IgnoreCase, IgnorePatternWhitespace, Multiline, None, RightToLeft, Singleline

Return Type

bool

IsMatch

Tests a string against a regular expression pattern

Usage

#set($booleanResponse = $core_v2_utility.IsMatch($input, $pattern))

Parameters

Name	Type	Description	Required	Default	Options
input	`string`	Input	Required
pattern	`string`	Pattern	Required

Return Type

bool

Join

Joins a list of items into a single string

Usage

#set($stringResponse = $core_v2_utility.Join($separator, $items))

Parameters

Name	Type	Description	Required	Default	Options
separator	`string`	Separator	Required
items	`IList<string>`	Items	Required

Return Type

string

MakeList

Converts an array of strings into an IList of strings

Usage

#set($iListResponse = $core_v2_utility.MakeList($items))

Parameters

Name	Type	Description	Required	Default	Options
items	`string[]`	Items	Required

Return Type

IList<string>

ParseBool

Converts a string to a bool. false if unparseable

Usage

#set($booleanResponse = $core_v2_utility.ParseBool($boolean))

Parameters

Name	Type	Description	Required	Default	Options
boolean	`string`	Boolean	Required

Return Type

bool

ParseDate

Converts numerically-formatted year, month, date, hour, and minute strings into a DateTime

Usage

#set($dateTimeResponse = $core_v2_utility.ParseDate($year, $month, $day, $hour, $minute))

Parameters

Name	Type	Description	Required
year	`string`	Year	Required
month	`string`	Month	Required
day	`string`	Day	Required
hour	`string`	Hour	Required
minute	`string`	Minute	Required

Return Type

DateTime

ParseDate

Converts a string to a DateTime. Minimum Date if unparseable.

Usage

#set($dateTimeResponse = $core_v2_utility.ParseDate($date))

Parameters

Name	Type	Description	Required	Default	Options
date	`string`	Date	Required

Return Type

DateTime

ParseDate

Converts numerically-formatted year, month, and date strings into a DateTime

Usage

#set($dateTimeResponse = $core_v2_utility.ParseDate($year, $month, $day))

Parameters

Name	Type	Description	Required
year	`string`	Year	Required
month	`string`	Month	Required
day	`string`	Day	Required

Return Type

DateTime

ParseDouble

Converts a string to a double. -1.0 if unparseable

Usage

#set($doubleResponse = $core_v2_utility.ParseDouble($input))

Parameters

Name	Type	Description	Required	Default	Options
input	`string`	Input	Required

Return Type

double

ParseGuid

Converts a string to a guid. Empty guid if unparseable

Usage

#set($guidResponse = $core_v2_utility.ParseGuid($guid))

Parameters

Name	Type	Description	Required	Default	Options
guid	`string`	Guid	Required

Return Type

Guid

ParseInt

Converts a string to an integer. -1 if unparseable

Usage

#set($int32Response = $core_v2_utility.ParseInt($input))

Parameters

Name	Type	Description	Required	Default	Options
input	`string`	Input	Required

Return Type

int

ParseLong

Converts a string to a long. -1 if unparseable

Usage

#set($int64Response = $core_v2_utility.ParseLong($input))

Parameters

Name	Type	Description	Required	Default	Options
input	`string`	Input	Required

Return Type

Int64

ParseTimestamp

Converts the timestamp string to DateTime.

Usage

#set($dateTimeResponse = $core_v2_utility.ParseTimestamp($timestamp))

Parameters

Name	Type	Description	Required	Default	Options
timestamp	`string`	Timestamp	Required

Return Type

DateTime

Replace

Replaces all parts of a string matching a regular expression pattern with a replacement

Usage

#set($stringResponse = $core_v2_utility.Replace($input, $pattern, $replacement))

Parameters

Name	Type	Description	Required
input	`string`	Input	Required
pattern	`string`	Pattern	Required
replacement	`string`	Replacement	Required

Return Type

string

Replace

Replaces all parts of a string matching a regular expression pattern with a replacement

Usage

#set($stringResponse = $core_v2_utility.Replace($input, $pattern, $replacement, "%{RegexOptions = $regexOptionsArg}"))

Parameters

Name	Type	Description	Required	Options
input	`string`	Input	Required
pattern	`string`	Pattern	Required
replacement	`string`	Replacement	Required
RegexOptions	`IList<string>`	List of options.	Optional	Compiled, CultureInvariant, ECMAScript, ExplicitCapture, IgnoreCase, IgnorePatternWhitespace, Multiline, None, RightToLeft, Singleline

Return Type

string

Slice

Returns a subset of a list of strings

Usage

#set($iListResponse = $core_v2_utility.Slice($array, $startIndex, $length))

Parameters

Name	Type	Description	Required
array	`IList<string>`	Array	Required
startIndex	`int`	Zero-based index to begin slice	Required
length	`int`	Length of slice	Required

Return Type

IList<string>

Split

Splits a string into separate items

Usage

#set($iListResponse = $core_v2_utility.Split($separator, $joined, $count))

Parameters

Name	Type	Description	Required
separator	`string`	Separator	Required
joined	`string`	Joined	Required
count	`int`	Count	Required

Return Type

IList<string>

Split

Splits a string into separate items

Usage

#set($iListResponse = $core_v2_utility.Split($separator, $joined))

Parameters

Name	Type	Description	Required	Default	Options
separator	`string`	Separator	Required
joined	`string`	Joined	Required

Return Type

IList<string>

StoreTemporaryData

Stores temporary data

Usage

#set($stringResponse = $core_v2_utility.StoreTemporaryData($data))

Parameters

Name	Type	Description	Required	Default	Options
data	`string`	Data	Required

Return Type

string

ToJson

Serializes an object to JSON

Usage

#set($stringResponse = $core_v2_utility.ToJson($value))

Parameters

Name	Type	Description	Required	Default	Options
value	`Object`	Value	Required

Return Type

string

Trim

Trims whitespace around a string

Usage

#set($stringResponse = $core_v2_utility.Trim($input))

Parameters

Name	Type	Description	Required	Default	Options
input	`string`	Input	Required

Return Type

string

Recommended