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.
Inheritance
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll
Syntax
public class RadCalendarDay : INotifyPropertyChanged
Constructors
RadCalendarDay()
Declaration
public RadCalendarDay()
RadCalendarDay(DateTime)
Declaration
public RadCalendarDay(DateTime date)
Parameters
System.DateTime
date
|
RadCalendarDay(DateTime, CalendarDayCollection)
Declaration
public RadCalendarDay(DateTime date, CalendarDayCollection owner)
Parameters
System.DateTime
date
|
CalendarDayCollection
owner
|
RadCalendarDay(CalendarDayCollection)
Declaration
public RadCalendarDay(CalendarDayCollection owner)
Parameters
CalendarDayCollection
owner
|
Properties
Date
Gets or sets the date represented by this RadCalendarDay.
Declaration
public virtual DateTime Date { get; set; }
Property Value
System.DateTime
|
Disabled
Gets or sets a value indicating whether the RadCalendarDay is disabled
Declaration
public bool Disabled { get; set; }
Property Value
System.Boolean
|
Image
Gets or sets the image associated with a particular RadCalendarDay object.
Declaration
public virtual Image Image { get; set; }
Property Value
System.Drawing.Image
|
IsToday
Gets or sets a value indicating whether the RadCalendarDay represents the current date.
Declaration
public bool IsToday { get; }
Property Value
System.Boolean
|
IsWeekend
Gets or sets a value indicating whether the RadCalendarDay is mapped to a date that represents a non working day/weekend.
Declaration
public bool IsWeekend { get; }
Property Value
System.Boolean
|
Owner
The owner of RadCalendarDay object.
Declaration
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
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
public bool Selectable { get; set; }
Property Value
System.Boolean
|
Selected
Gets or sets a value indicating whether the RadCalendarDay is selected
Declaration
public bool Selected { get; set; }
Property Value
System.Boolean
|
TemplateItem
Gets or sets the template associated with a particular RadCalendarDay object. The template must inherit from RadHostItem.
Declaration
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
public string ToolTip { get; set; }
Property Value
System.String
|
Methods
CreateDay(DateTime)
Declaration
public static RadCalendarDay CreateDay(DateTime date)
Parameters
System.DateTime
date
the DateTime object associated with this particular RadCalendarDay. |
Returns
RadCalendarDay
|
CreateDay(DateTime, CalendarDayCollection)
Declaration
protected static RadCalendarDay CreateDay(DateTime date, CalendarDayCollection owner)
Parameters
System.DateTime
date
the DateTime object associated with this particular RadCalendarDay. |
CalendarDayCollection
owner
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
protected virtual RecurringEvents IsRecurring(DateTime compareTime, Calendar processCalendar)
Parameters
System.DateTime
compareTime
the DateTime to compare. |
System.Globalization.Calendar
processCalendar
the System.Globalization.Calendar object used to check whether the DateTime represents a recurring event. |
Returns
RecurringEvents
|
OnNotifyPropertyChanged(PropertyChangedEventArgs)
Raises the PropertyChanged event.
Declaration
protected virtual void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
System.ComponentModel.PropertyChangedEventArgs
e
PropertyChangedEventArgs instance containing the name of the property. |
OnNotifyPropertyChanged(String)
Raises the PropertyChanged event.
Declaration
protected virtual void OnNotifyPropertyChanged(string propertyName)
Parameters
System.String
propertyName
The name of the property. |
SetToday(Boolean)
Sets whether RadCalendarDay object is associated with a DateTime equal to today's date.
Declaration
protected void SetToday(bool value)
Parameters
System.Boolean
value
True if RadCalendarDay object is associated with today's date. |
SetWeekend(Boolean)
Sets whether RadCalendarDay object is associated with a DateTime that represents a weekend day.
Declaration
protected void SetWeekend(bool value)
Parameters
System.Boolean
value
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
public static DateTime TruncateTimeComponent(DateTime value)
Parameters
System.DateTime
value
the DateTime object to be processed. |
Returns
System.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
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler
|