Calendar Utility methods for scripted widgets
Methods
AdjustForServerTime
Usage
#set($dateTimeResponse = $calendar_v1_UI.AdjustForServerTime($userTime))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userTime | DateTime | User Time | Required |
Return Type
DateTime
AdjustForUserTime
Usage
#set($dateTimeResponse = $calendar_v1_UI.AdjustForUserTime($serverTime))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serverTime | DateTime | Server Time | Required |
Return Type
DateTime
ApplyDateFilter
Usage
#set($iEnumerableResponse = $calendar_v1_UI.ApplyDateFilter($filterDate, $eventsToFilter))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
filterDate | DateTime | Filter Date | Required | ||
eventsToFilter | IEnumerable<Event> | Events To Filter | Required |
Return Type
IEnumerable<Event>
DaysInMonth
Usage
#set($int32Response = $calendar_v1_UI.DaysInMonth($year, $month))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
year | string | Year | Required | ||
month | string | Month | Required |
Return Type
int
GetStartDayOfWeek
Usage
#set($int32Response = $calendar_v1_UI.GetStartDayOfWeek($date))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
date | DateTime | Date | Required |
Return Type
int
ParseDateTimeExact
Converts a string in 'mm/dd/yyyy HH:mm:ss' format to a DateTime. Minimum Date if unparseable.
Usage
#set($dateTimeResponse = $calendar_v1_UI.ParseDateTimeExact($date))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
date | string | Date | Required |
Return Type
DateTime
RoundUp
Usage
#set($dateTimeResponse = $calendar_v1_UI.RoundUp($date, $interval))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
date | DateTime | Date | Required | ||
interval | int | Interval | Required |
Return Type
DateTime
ToCultureSafeString
Usage
#set($stringResponse = $calendar_v1_UI.ToCultureSafeString($date))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
date | DateTime | Date | Required |
Return Type
string
TranslateDayOfWeek
Usage
#set($stringResponse = $calendar_v1_UI.TranslateDayOfWeek($weekDay, $forMini))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
weekDay | int | Week Day | Required | ||
forMini | bool | For Mini | Required |
Return Type
string