Class
CalHelper

A helper class for Telerik.WinControls.UI.Scheduler.ICalendar.

Definition

Namespace:Telerik.WinControls.UI.Scheduler.ICalendar

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:

cs-api-definition
public static class CalHelper

Inheritance: objectCalHelper

Methods

GetAppointmentBackground(string)

Gets the appoitment background.

Declaration

cs-api-definition
public static AppointmentBackground GetAppointmentBackground(string backgroundName)

Parameters

backgroundName

string

Name of the background.

Returns

AppointmentBackground

Default return is None

GetAppointmentBackgroundName(AppointmentBackground)

Gets the name of the appoitment background.

Declaration

cs-api-definition
public static string GetAppointmentBackgroundName(AppointmentBackground background)

Parameters

background

AppointmentBackground

The background.

Returns

string

Default return is None

GetAppointmentReminder(CalProperty, IEvent)

Gets the reminder time span from its string representation.

Declaration

cs-api-definition
public static TimeSpan? GetAppointmentReminder(CalProperty reminder, IEvent appointment)

Parameters

reminder

CalProperty

The string representation

appointment

IEvent

The appointment for which to get the reminder time span.

Returns

TimeSpan?

The reminder timespan of null if there is no such

GetAppointmentStatus(string)

Gets the appoitment status.

Declaration

cs-api-definition
public static AppointmentStatus GetAppointmentStatus(string statusName)

Parameters

statusName

string

Name of the status.

Returns

AppointmentStatus

Default return is Busy

GetAppointmentStatusName(AppointmentStatus)

Gets the name of the appoitment status.

Declaration

cs-api-definition
public static string GetAppointmentStatusName(AppointmentStatus status)

Parameters

status

AppointmentStatus

The status.

Returns

string

Default return is Busy

GetModernAppointmentBackground(string)

Gets the appoitment background.

Declaration

cs-api-definition
public static AppointmentCategory GetModernAppointmentBackground(string backgroundName)

Parameters

backgroundName

string

Name of the background.

Returns

AppointmentCategory

Default return is None

GetModernAppointmentBackgroundName(AppointmentCategory)

Gets the name of the appoitment modern background.

Declaration

cs-api-definition
public static string GetModernAppointmentBackgroundName(AppointmentCategory category)

Parameters

category

AppointmentCategory

The background.

Returns

string

Default return is None

GetReminderString(TimeSpan)

Gets an ICal string representation of the reminder time span.

Declaration

cs-api-definition
public static string GetReminderString(TimeSpan reminder)

Parameters

reminder

TimeSpan

The time span.

Returns

string

The string representation.

RecurrenceRuleToRruleString(RecurrenceRule)

Converts the RecurrenceRule to a RRULE string. Note that the RRULE string representation cannot be converted back to RecurrenceRule, as it contains only part of the information held by the RecurrenceRule object. If you need to convert back the string representation, use the RecurrenceRuleToString(RecurrenceRule) method.

Declaration

cs-api-definition
public static string RecurrenceRuleToRruleString(RecurrenceRule rule)

Parameters

rule

RecurrenceRule

The recurrence rule.

Returns

string

RecurrenceRuleToRruleString(RecurrenceRule, CultureInfo)

Note that the RRULE string representation cannot be converted back to RecurrenceRule, as it contains only part of the information held by the RecurrenceRule object. If you need to convert back the string representation, use the RecurrenceRuleToString(RecurrenceRule, CultureInfo) method.

Declaration

cs-api-definition
public static string RecurrenceRuleToRruleString(RecurrenceRule rule, CultureInfo culture)

Parameters

rule

RecurrenceRule

The recurrence rule.

culture

CultureInfo

Returns

string

RecurrenceRuleToString(RecurrenceRule)

Converts the RecurrenceRule to string in the iCalendar format.

Declaration

cs-api-definition
public static string RecurrenceRuleToString(RecurrenceRule rule)

Parameters

rule

RecurrenceRule

The recurrence rule.

Returns

string

RecurrenceRuleToString(RecurrenceRule, CultureInfo)

Converts the RecurrenceRule to string in the iCalendar format.

Declaration

cs-api-definition
public static string RecurrenceRuleToString(RecurrenceRule rule, CultureInfo culture)

Parameters

rule

RecurrenceRule

The recurrence rule.

culture

CultureInfo

Returns

string

TryParseRecurrenceRule(string, out RecurrenceRule)

Tries to parse recurrence pattern.

Declaration

cs-api-definition
public static bool TryParseRecurrenceRule(string valueToParse, out RecurrenceRule result)

Parameters

valueToParse

string

The string to parse.

result

RecurrenceRule

The result.

Returns

bool