Class
RadCalendarDay

RadCalendarDay represents a object that maps date value to corresponding visual settings. Also the object implements Boolean properties that represent the nature of the selected date - whether it is a weekend, disabled or selected in the context of the calendar. Mostly the values of those properties are set at runtime when a RadCalendarDay instance is constructed and passed to the DayRender event.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

cs-api-definition
public class RadCalendarDay : INotifyPropertyChanged

Inheritance: objectRadCalendarDay

Implements: INotifyPropertyChanged

Constructors

RadCalendarDay()

Declaration

cs-api-definition
public RadCalendarDay()

RadCalendarDay(CalendarDayCollection)

Declaration

cs-api-definition
public RadCalendarDay(CalendarDayCollection owner)

Parameters

owner

CalendarDayCollection

RadCalendarDay(DateTime)

Declaration

cs-api-definition
public RadCalendarDay(DateTime date)

Parameters

date

DateTime

RadCalendarDay(DateTime, CalendarDayCollection)

Declaration

cs-api-definition
public RadCalendarDay(DateTime date, CalendarDayCollection owner)

Parameters

date

DateTime

owner

CalendarDayCollection

Properties

Date

Gets or sets the date represented by this RadCalendarDay.

Declaration

cs-api-definition
public virtual DateTime Date { get; set; }

Property Value

DateTime

Disabled

Gets or sets a value indicating whether the RadCalendarDay is disabled

Declaration

cs-api-definition
public bool Disabled { get; set; }

Property Value

bool

Image

Gets or sets the image associated with a particular RadCalendarDay object.

Declaration

cs-api-definition
[Browsable(true)]
public virtual Image Image { get; set; }

Property Value

Image

IsToday

Gets or sets a value indicating whether the RadCalendarDay represents the current date.

Declaration

cs-api-definition
public bool IsToday { get; }

Property Value

bool

IsWeekend

Gets or sets a value indicating whether the RadCalendarDay is mapped to a date that represents a non working day/weekend.

Declaration

cs-api-definition
public bool IsWeekend { get; }

Property Value

bool

Owner

The owner of RadCalendarDay object.

Declaration

cs-api-definition
protected CalendarDayCollection Owner { get; set; }

Property Value

CalendarDayCollection

Recurring

Gets or sets a value indicating whether the RadCalendarDay settings are repeated/recurring through out the valid date range displayed by the calendar.

Declaration

cs-api-definition
public RecurringEvents Recurring { get; set; }

Property Value

RecurringEvents

Remarks

The RecurringEvents enumeration determines which part of the date is handled (day or day and month).

Selectable

Gets or sets a value indicating whether the RadCalendarDay is qualified as available for selection.

Declaration

cs-api-definition
public bool Selectable { get; set; }

Property Value

bool

Selected

Gets or sets a value indicating whether the RadCalendarDay is selected

Declaration

cs-api-definition
public bool Selected { get; set; }

Property Value

bool

TemplateItem

Gets or sets the template associated with a particular RadCalendarDay object. The template must inherit from RadHostItem.

Declaration

cs-api-definition
[Browsable(true)]
public virtual RadHostItem TemplateItem { get; set; }

Property Value

RadHostItem

ToolTip

Gets or sets the text displayed when the mouse pointer hovers over the calendar day.

Declaration

cs-api-definition
public string ToolTip { get; set; }

Property Value

string

Methods

CreateDay(DateTime)

Declaration

cs-api-definition
public static RadCalendarDay CreateDay(DateTime date)

Parameters

date

DateTime

the DateTime object associated with this particular RadCalendarDay.

Returns

RadCalendarDay

CreateDay(DateTime, CalendarDayCollection)

Declaration

cs-api-definition
protected static RadCalendarDay CreateDay(DateTime date, CalendarDayCollection owner)

Parameters

date

DateTime

the DateTime object associated with this particular RadCalendarDay.

owner

CalendarDayCollection

the CalendarDayCollection that contains this particular RadCalendarDay.

Returns

RadCalendarDay

IsRecurring(DateTime, Calendar)

Checks whether RadCalendarDay object is associated with a DateTime that represents a recurring event.

Declaration

cs-api-definition
protected virtual RecurringEvents IsRecurring(DateTime compareTime, Calendar processCalendar)

Parameters

compareTime

DateTime

the DateTime to compare.

processCalendar

Calendar

the System.Globalization.Calendar object used to check whether the DateTime represents a recurring event.

Returns

RecurringEvents

OnNotifyPropertyChanged(PropertyChangedEventArgs)

Raises the PropertyChanged event.

Declaration

cs-api-definition
protected virtual void OnNotifyPropertyChanged(PropertyChangedEventArgs e)

Parameters

e

PropertyChangedEventArgs

PropertyChangedEventArgs instance containing the name of the property.

OnNotifyPropertyChanged(string)

Raises the PropertyChanged event.

Declaration

cs-api-definition
protected virtual void OnNotifyPropertyChanged(string propertyName)

Parameters

propertyName

string

The name of the property.

SetToday(bool)

Sets whether RadCalendarDay object is associated with a DateTime equal to today's date.

Declaration

cs-api-definition
protected void SetToday(bool value)

Parameters

value

bool

True if RadCalendarDay object is associated with today's date.

SetWeekend(bool)

Sets whether RadCalendarDay object is associated with a DateTime that represents a weekend day.

Declaration

cs-api-definition
protected void SetWeekend(bool value)

Parameters

value

bool

True if RadCalendarDay object is associated with a DateTime that represents a weekend day.

TruncateTimeComponent(DateTime)

Removes the time component of a DateTime object, thus leaving only the date part.

Declaration

cs-api-definition
public static DateTime TruncateTimeComponent(DateTime value)

Parameters

value

DateTime

the DateTime object to be processed.

Returns

DateTime

the DateTime object containing only the date part of the original DateTime object.

Events

PropertyChanged

Occurs when when a property of an object changes change. Calling the event is developer's responsibility.

Declaration

cs-api-definition
[Browsable(false)]
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged