New to Telerik UI for WinForms? Start a free 30-day trial

CalProperty

Class

ICalendar Property object.

Definition

Namespace:Telerik.WinControls.UI.Scheduler.ICalendar

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:

public class CalProperty : IEquatable<CalProperty>

Inheritance: objectCalProperty

Implements: IEquatable<CalProperty>

Constructors

CalProperty(string, string)

Initializes a new instance of the CalProperty class.

public CalProperty(string name, string value)

Parameters:namestring

The name.

valuestring

The value.

Properties

Name

string

Gets or sets the property name.

public string Name { get; }

Property Value:

The name.

Parameters

Dictionary<string, string>

Gets or sets the parameters.

public Dictionary<string, string> Parameters { get; }

Property Value:

The parameters.

this[string]

string

Gets the string with the specified key.

public string this[string key] { get; }

Parameters:keystringProperty Value:

The parameter value, or null when the key is not present.

Value

string

Gets or sets the value.

public string Value { get; }

Property Value:

The value.

Methods

Equals(CalProperty)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(CalProperty other)

Parameters:otherCalProperty

An object to compare with this object.

Returns:

bool

True if the current object is equal to the other parameter; otherwise, false.

Implements: IEquatable<CalProperty>.Equals(CalProperty)

IsParameterValueDate()

Determines whether the property's VALUE parameter specifies the date value type. The comparison ignores surrounding whitespace and letter casing.

public bool IsParameterValueDate()

Returns:

bool

true when the parameter value is DATE; otherwise, false.

ToDateTime()

Parses the property value as a date or date-time without supplying a time zone for a TZID parameter.

public DateTime ToDateTime()

Returns:

DateTime

The parsed date or date-time.

Exceptions: CalendarParseException

The value cannot be parsed or requires a matching time zone.

ToDateTime(TimeZoneInfo)

Parses the property value as a date or date-time, checking any TZID parameter against the supplied time zone.

public DateTime ToDateTime(TimeZoneInfo timeZone)

Parameters:timeZoneTimeZoneInfo

The time zone that must match the property's TZID parameter, when present.

Returns:

DateTime

The parsed date or date-time.

Exceptions: CalendarParseException

The value cannot be parsed or its TZID does not match timeZone.

ToDuration()

Parses the property value as an iCalendar duration.

public TimeSpan ToDuration()

Returns:

TimeSpan

The duration represented by the property.

Exceptions: CalendarParseException

The property value is not a valid duration.

ToExceptionDates()

Parses the comma-separated date values in the property as recurrence exception dates.

public IList<DateTime> ToExceptionDates()

Returns:

IList<DateTime>

The parsed exception dates.

Exceptions: CalendarParseException

One or more date values cannot be parsed.

ToRecurrenceRule()

Parses the property value as a recurrence rule.

public RecurrenceRule ToRecurrenceRule()

Returns:

RecurrenceRule

The parsed recurrence rule.

Exceptions: CalendarParseException

The property value is not a valid recurrence rule.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns:

string

A string that represents the current object.

Overrides: object.ToString()

ToText(CalProperty)

Decodes the escaped text value of an iCalendar property.

public static string ToText(CalProperty property)

Parameters:propertyCalProperty

The property whose value will be decoded.

Returns:

string

The decoded text, or null when property is null.

ToTimeSpan()

Parses the signed hour, minute, and optional second value stored in the property.

public TimeSpan ToTimeSpan()

Returns:

TimeSpan

The parsed time span.

Exceptions: CalendarParseException

The property value is not in the expected time-span format.