ClassRadCalendar
Represents a calendar control that enables users to select dates from a highly customizable calendar interface.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Editors")]
public class RadCalendar : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadCalendar
Implements:
Inherited Members
Constructors
RadCalendar()
Initializes a new instance of the RadCalendar class.
Declaration
public RadCalendar()
Properties
AllowColumnHeaderSelectors
Gets or sets whether column headers ( if displayed by a MonthView object) will act as column selectors.
Declaration
public bool AllowColumnHeaderSelectors { get; set; }
Property Value
AllowFastNavigation
Gets or sets whether the fast navigation in RadCalendar is allowed.
AllowFishEye
Gets or sets whether the zooming functionality is enabled.
AllowMultipleSelect
Allows the selection of multiple dates. If not set, only a single date is selected, and if any dates are all ready selected, they are cleared.
Declaration
[Bindable(false)]
public bool AllowMultipleSelect { get; set; }
Property Value
AllowMultipleView
Allows RadCalendar to render multiple months in a single view.
Declaration
[Bindable(false)]
public bool AllowMultipleView { get; set; }
Property Value
AllowNavigation
Gets or sets whether navigating RadCalendar is allowed.
AllowRowHeaderSelectors
Gets or sets whether row headers ( if displayed by a MonthView object) will act as row selectors.
AllowSelect
Allows the selection of dates. If not set, selection is forbidden, and if any dates are all ready selected, they are cleared.
Declaration
[Bindable(false)]
public bool AllowSelect { get; set; }
Property Value
AllowViewSelector
Gets or sets whether the view selector will be allowed to select all dates presented by the CalendarView.
CalendarElement
Gets the main RadCalendarElement that encapsulates the core functionality of the calendar control.
Declaration
[Browsable(false)]
public RadCalendarElement CalendarElement { get; }
Property Value
A RadCalendarElement representing the main element in the hierarchy tree.
CellAlign
Gets or sets the horizontal alignment of the date cells content inside the calendar area.
Declaration
public ContentAlignment CellAlign { get; set; }
Property Value
Remarks
|
Member name |
Description |
|---|---|
|
Center | The contents of a container are centered. |
| Left | The contents of a container are left justified. |
| Right | The contents of a container are right justified. |
CellHorizontalSpacing
Gets or sets the horizontal spacing between the calendar cells.
CellMargin
Gets or sets the margin of the calendar cells.
CellPadding
Gets or sets the padding of the calendar cells.
CellToolTipFormat
Gets or sets the format string that is applied to the days cells tooltip.
Declaration
public string CellToolTipFormat { get; set; }
Property Value
Remarks
The property should contain either a format specifier character or a custom format pattern. For more information, see the summary page for System.Globalization.DateTimeFormatInfo.
By default this property uses formatting string of 'dddd, MMMM dd, yyyy'. Valid formats are all supported by the .NET Framework.
Example:
- "d" is the standard short date pattern.
- "%d" returns the day of the month; "%d" is a custom pattern.
- "d " returns the day of the month followed by a white-space character; "d " is a custom pattern.
CellVerticalSpacing
Gets or sets the vertical spacing between the calendar cells.
ClearButton
Gets the clear button of the footer element
Declaration
public RadButtonElement ClearButton { get; }
Property Value
ColumnHeaderImage
Gets or sets the image displayed for all column header elements.
Declaration
[Bindable(false)]
public Image ColumnHeaderImage { get; set; }
Property Value
The image displayed for all CalendarView column header elements. The default value is null.
ColumnHeaderText
Gets or sets the text displayed for all column header elements.
Declaration
[Bindable(false)]
public string ColumnHeaderText { get; set; }
Property Value
The text displayed for all CalendarView column header elements. The default value is "".
Remarks
Use the ColumnHeaderText property to provide custom text for all CalendarView column header elements.
Columns
Gets or sets the the count of columns to be displayed by a single CalendarView.
Declaration
public int Columns { get; set; }
Property Value
Remarks
If the calendar represents a multi view, this property applies to the child views inside the multi view.
Culture
Gets or sets the CultureInfo supported by this RadCalendar object.
Describes the names of the culture, the writing system, and the calendar used, as well as access to culture-specific objects that provide methods for common operations, such as formatting dates and sorting strings.
Declaration
[TypeConverter(typeof(CultureInfoConverter))]
public CultureInfo Culture { get; set; }
Property Value
Remarks
The culture names follow the RFC 1766 standard in the format "<languagecode2>-<country/regioncode2>", where <languagecode2> is a lowercase two-letter code derived from ISO 639-1 and <country/regioncode2> is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is "en-US". In cases where a two-letter language code is not available, the three-letter code derived from ISO 639-2 is used; for example, the three-letter code "div" is used for cultures that use the Dhivehi language. Some culture names have suffixes that specify the script; for example, "-Cyrl" specifies the Cyrillic script, "-Latn" specifies the Latin script.
The following predefined CultureInfo names and identifiers are accepted and used by this class and other classes in the System.Globalization namespace.
| Culture Name | Culture Identifier | Language-Country/Region |
|---|---|---|
| "" (empty string) | 0x007F | invariant culture |
| af | 0x0036 | Afrikaans |
| af-ZA | 0x0436 | Afrikaans - South Africa |
| sq | 0x001C | Albanian |
| sq-AL | 0x041C | Albanian - Albania |
| ar | 0x0001 | Arabic |
| ar-DZ | 0x1401 | Arabic - Algeria |
| ar-BH | 0x3C01 | Arabic - Bahrain |
| ar-EG | 0x0C01 | Arabic - Egypt |
| ar-IQ | 0x0801 | Arabic - Iraq |
| ar-JO | 0x2C01 | Arabic - Jordan |
| ar-KW | 0x3401 | Arabic - Kuwait |
| ar-LB | 0x3001 | Arabic - Lebanon |
| ar-LY | 0x1001 | Arabic - Libya |
| ar-MA | 0x1801 | Arabic - Morocco |
| ar-OM | 0x2001 | Arabic - Oman |
| ar-QA | 0x4001 | Arabic - Qatar |
| ar-SA | 0x0401 | Arabic - Saudi Arabia |
| ar-SY | 0x2801 | Arabic - Syria |
| ar-TN | 0x1C01 | Arabic - Tunisia |
| ar-AE | 0x3801 | Arabic - United Arab Emirates |
| ar-YE | 0x2401 | Arabic - Yemen |
| hy | 0x002B | Armenian |
| hy-AM | 0x042B | Armenian - Armenia |
| az | 0x002C | Azeri |
| az-AZ-Cyrl | 0x082C | Azeri (Cyrillic) - Azerbaijan |
| az-AZ-Latn | 0x042C | Azeri (Latin) - Azerbaijan |
| eu | 0x002D | Basque |
| eu-ES | 0x042D | Basque - Basque |
| be | 0x0023 | Belarusian |
| be-BY | 0x0423 | Belarusian - Belarus |
| bg | 0x0002 | Bulgarian |
| bg-BG | 0x0402 | Bulgarian - Bulgaria |
| ca | 0x0003 | Catalan |
| ca-ES | 0x0403 | Catalan - Catalan |
| zh-HK | 0x0C04 | Chinese - Hong Kong SAR |
| zh-MO | 0x1404 | Chinese - Macau SAR |
| zh-CN | 0x0804 | Chinese - China |
| zh-CHS | 0x0004 | Chinese (Simplified) |
| zh-SG | 0x1004 | Chinese - Singapore |
| zh-TW | 0x0404 | Chinese - Taiwan |
| zh-CHT | 0x7C04 | Chinese (Traditional) |
| hr | 0x001A | Croatian |
| hr-HR | 0x041A | Croatian - Croatia |
| cs | 0x0005 | Czech |
| cs-CZ | 0x0405 | Czech - Czech Republic |
| da | 0x0006 | Danish |
| da-DK | 0x0406 | Danish - Denmark |
| div | 0x0065 | Dhivehi |
| div-MV | 0x0465 | Dhivehi - Maldives |
| nl | 0x0013 | Dutch |
| nl-BE | 0x0813 | Dutch - Belgium |
| nl-NL | 0x0413 | Dutch - The Netherlands |
| en | 0x0009 | English |
| en-AU | 0x0C09 | English - Australia |
| en-BZ | 0x2809 | English - Belize |
| en-CA | 0x1009 | English - Canada |
| en-CB | 0x2409 | English - Caribbean |
| en-IE | 0x1809 | English - Ireland |
| en-JM | 0x2009 | English - Jamaica |
| en-NZ | 0x1409 | English - New Zealand |
| en-PH | 0x3409 | English - Philippines |
| en-ZA | 0x1C09 | English - South Africa |
| en-TT | 0x2C09 | English - Trinidad and Tobago |
| en-GB | 0x0809 | English - United Kingdom |
| en-US | 0x0409 | English - United States |
| en-ZW | 0x3009 | English - Zimbabwe |
| et | 0x0025 | Estonian |
| et-EE | 0x0425 | Estonian - Estonia |
| fo | 0x0038 | Faroese |
| fo-FO | 0x0438 | Faroese - Faroe Islands |
| fa | 0x0029 | Farsi |
| fa-IR | 0x0429 | Farsi - Iran |
| fi | 0x000B | Finnish |
| fi-FI | 0x040B | Finnish - Finland |
| fr | 0x000C | French |
| fr-BE | 0x080C | French - Belgium |
| fr-CA | 0x0C0C | French - Canada |
| fr-FR | 0x040C | French - France |
| fr-LU | 0x140C | French - Luxembourg |
| fr-MC | 0x180C | French - Monaco |
| fr-CH | 0x100C | French - Switzerland |
| gl | 0x0056 | Galician |
| gl-ES | 0x0456 | Galician - Galician |
| ka | 0x0037 | Georgian |
| ka-GE | 0x0437 | Georgian - Georgia |
| de | 0x0007 | German |
| de-AT | 0x0C07 | German - Austria |
| de-DE | 0x0407 | German - Germany |
| de-LI | 0x1407 | German - Liechtenstein |
| de-LU | 0x1007 | German - Luxembourg |
| de-CH | 0x0807 | German - Switzerland |
| el | 0x0008 | Greek |
| el-GR | 0x0408 | Greek - Greece |
| gu | 0x0047 | Gujarati |
| gu-IN | 0x0447 | Gujarati - India |
| he | 0x000D | Hebrew |
| he-IL | 0x040D | Hebrew - Israel |
| hi | 0x0039 | Hindi |
| hi-IN | 0x0439 | Hindi - India |
| hu | 0x000E | Hungarian |
| hu-HU | 0x040E | Hungarian - Hungary |
| is | 0x000F | Icelandic |
| is-IS | 0x040F | Icelandic - Iceland |
| id | 0x0021 | Indonesian |
| id-ID | 0x0421 | Indonesian - Indonesia |
| it | 0x0010 | Italian |
| it-IT | 0x0410 | Italian - Italy |
| it-CH | 0x0810 | Italian - Switzerland |
| ja | 0x0011 | Japanese |
| ja-JP | 0x0411 | Japanese - Japan |
| kn | 0x004B | Kannada |
| kn-IN | 0x044B | Kannada - India |
| kk | 0x003F | Kazakh |
| kk-KZ | 0x043F | Kazakh - Kazakhstan |
| kok | 0x0057 | Konkani |
| kok-IN | 0x0457 | Konkani - India |
| ko | 0x0012 | Korean |
| ko-KR | 0x0412 | Korean - Korea |
| ky | 0x0040 | Kyrgyz |
| ky-KZ | 0x0440 | Kyrgyz - Kazakhstan |
| lv | 0x0026 | Latvian |
| lv-LV | 0x0426 | Latvian - Latvia |
| lt | 0x0027 | Lithuanian |
| lt-LT | 0x0427 | Lithuanian - Lithuania |
| mk | 0x002F | Macedonian |
| mk-MK | 0x042F | Macedonian - FYROM |
| ms | 0x003E | Malay |
| ms-BN | 0x083E | Malay - Brunei |
| ms-MY | 0x043E | Malay - Malaysia |
| mr | 0x004E | Marathi |
| mr-IN | 0x044E | Marathi - India |
| mn | 0x0050 | Mongolian |
| mn-MN | 0x0450 | Mongolian - Mongolia |
| no | 0x0014 | Norwegian |
| nb-NO | 0x0414 | Norwegian (Bokmål) - Norway |
| nn-NO | 0x0814 | Norwegian (Nynorsk) - Norway |
| pl | 0x0015 | Polish |
| pl-PL | 0x0415 | Polish - Poland |
| pt | 0x0016 | Portuguese |
| pt-BR | 0x0416 | Portuguese - Brazil |
| pt-PT | 0x0816 | Portuguese - Portugal |
| pa | 0x0046 | Punjabi |
| pa-IN | 0x0446 | Punjabi - India |
| ro | 0x0018 | Romanian |
| ro-RO | 0x0418 | Romanian - Romania |
| ru | 0x0019 | Russian |
| ru-RU | 0x0419 | Russian - Russia |
| sa | 0x004F | Sanskrit |
| sa-IN | 0x044F | Sanskrit - India |
| sr-SP-Cyrl | 0x0C1A | Serbian (Cyrillic) - Serbia |
| sr-SP-Latn | 0x081A | Serbian (Latin) - Serbia |
| sk | 0x001B | Slovak |
| sk-SK | 0x041B | Slovak - Slovakia |
| sl | 0x0024 | Slovenian |
| sl-SI | 0x0424 | Slovenian - Slovenia |
| es | 0x000A | Spanish |
| es-AR | 0x2C0A | Spanish - Argentina |
| es-BO | 0x400A | Spanish - Bolivia |
| es-CL | 0x340A | Spanish - Chile |
| es-CO | 0x240A | Spanish - Colombia |
| es-CR | 0x140A | Spanish - Costa Rica |
| es-DO | 0x1C0A | Spanish - Dominican Republic |
| es-EC | 0x300A | Spanish - Ecuador |
| es-SV | 0x440A | Spanish - El Salvador |
| es-GT | 0x100A | Spanish - Guatemala |
| es-HN | 0x480A | Spanish - Honduras |
| es-MX | 0x080A | Spanish - Mexico |
| es-NI | 0x4C0A | Spanish - Nicaragua |
| es-PA | 0x180A | Spanish - Panama |
| es-PY | 0x3C0A | Spanish - Paraguay |
| es-PE | 0x280A | Spanish - Peru |
| es-PR | 0x500A | Spanish - Puerto Rico |
| es-ES | 0x0C0A | Spanish - Spain |
| es-UY | 0x380A | Spanish - Uruguay |
| es-VE | 0x200A | Spanish - Venezuela |
| sw | 0x0041 | Swahili |
| sw-KE | 0x0441 | Swahili - Kenya |
| sv | 0x001D | Swedish |
| sv-FI | 0x081D | Swedish - Finland |
| sv-SE | 0x041D | Swedish - Sweden |
| syr | 0x005A | Syriac |
| syr-SY | 0x045A | Syriac - Syria |
| ta | 0x0049 | Tamil |
| ta-IN | 0x0449 | Tamil - India |
| tt | 0x0044 | Tatar |
| tt-RU | 0x0444 | Tatar - Russia |
| te | 0x004A | Telugu |
| te-IN | 0x044A | Telugu - India |
| th | 0x001E | Thai |
| th-TH | 0x041E | Thai - Thailand |
| tr | 0x001F | Turkish |
| tr-TR | 0x041F | Turkish - Turkey |
| uk | 0x0022 | Ukrainian |
| uk-UA | 0x0422 | Ukrainian - Ukraine |
| ur | 0x0020 | Urdu |
| ur-PK | 0x0420 | Urdu - Pakistan |
| uz | 0x0043 | Uzbek |
| uz-UZ-Cyrl | 0x0843 | Uzbek (Cyrillic) - Uzbekistan |
| uz-UZ-Latn | 0x0443 | Uzbek (Latin) - Uzbekistan |
| vi | 0x002A | Vietnamese |
| vi-VN | 0x042A | Vietnamese - Vietnam |
CurrentCalendar
Gets the default System.Globalization.Calendar instance as specified by the default culture.
Declaration
[Browsable(false)]
public Calendar CurrentCalendar { get; }
Property Value
Remarks
A calendar divides time into measures, such as weeks, months, and years. The number, length, and start of the divisions vary in each calendar.
Any moment in time can be represented as a set of numeric values using a particular calendar. For example, the last vernal equinox occurred at (0.0, 0, 46, 8, 20, 3, 1999) in the Gregorian calendar. An implementation of Calendar can map any DateTime value to a similar set of numeric values, and DateTime can map such sets of numeric values to a textual representation using information from Calendar and DateTimeFormatInfo. The textual representation can be culture-sensitive (for example, "8:46 AM March 20th 1999 AD" for the en-US culture) or culture-insensitive (for example, "1999-03-20T08:46:00" in ISO 8601 format).
A Calendar implementation can define one or more eras. The Calendar class identifies the eras as enumerated integers where the current era (CurrentEra) has the value 0.
In order to make up for the difference between the calendar year and the actual time that the earth rotates around the sun or the actual time that the moon rotates around the earth, a leap year has a different number of days than a standard calendar year. Each Calendar implementation defines leap years differently.
For consistency, the first unit in each interval (for example, the first month) is assigned the value 1.
The System.Globalization namespace includes the following Calendar implementations: GregorianCalendar, HebrewCalendar, HijriCalendar, JapaneseCalendar, JulianCalendar, KoreanCalendar, TaiwanCalendar, and ThaiBuddhistCalendar.
CurrentViewColumn
Gets or sets the column position in the multi-view table where the focused date is displayed.
Declaration
public int CurrentViewColumn { get; set; }
Property Value
An integer representing the column index. The default value is 0.
CurrentViewRow
Gets or sets the row position in the multi-view table where the focused date is displayed.
Declaration
public int CurrentViewRow { get; set; }
Property Value
An integer representing the row index. The default value is 0.
DateRangeSeparator
Gets or sets the separator string that will be put between start and end months in a multi view title.
DateTimeFormat
Gets or sets a DateTimeFormatInfo instance that defines the culturally appropriate format of displaying dates and times as specified by the default culture.
Declaration
[Browsable(false)]
public DateTimeFormatInfo DateTimeFormat { get; }
Property Value
Remarks
A DateTimeFormatInfo can be created only for the invariant culture or for specific cultures, not for neutral cultures.
The cultures are generally grouped into three sets: the invariant culture, the neutral cultures, and the specific cultures.
The invariant culture is culture-insensitive. You can specify the invariant culture by name using an empty string ("") or by its culture identifier 0x007F. InvariantCulture retrieves an instance of the invariant culture. It is associated with the English language but not with any country/region. It can be used in almost any method in the Globalization namespace that requires a culture. If a security decision depends on a string comparison or a case-change operation, use the InvariantCulture to ensure that the behavior will be consistent regardless of the culture settings of the system. However, the invariant culture must be used only by processes that require culture-independent results, such as system services; otherwise, it produces results that might be linguistically incorrect or culturally inappropriate.
A neutral culture is a culture that is associated with a language but not with a country/region. A specific culture is a culture that is associated with a language and a country/region. For example, "fr" is a neutral culture and "fr-FR" is a specific culture. Note that "zh-CHS" (Simplified Chinese) and "zh-CHT" (Traditional Chinese) are neutral cultures.
The user might choose to override some of the values associated with the current culture of Windows through Regional and Language Options (or Regional Options or Regional Settings) in Control Panel. For example, the user might choose to display the date in a different format or to use a currency other than the default for the culture.
If UseUserOverride is true and the specified culture
matches the current culture of Windows, the CultureInfo uses those
overrides, including user settings for the properties of the
DateTimeFormatInfo instance returned by the DateTimeFormat property,
the properties of the NumberFormatInfo instance returned by the
NumberFormat property, and the properties of the
CompareInfo instance returned by the CompareInfo
property. If the user settings are incompatible with the culture associated with
the CultureInfo (for example, if the selected calendar is not one of the
OptionalCalendars ), the results of the methods and the values of
the properties are undefined.
Note: In this version of RadCalendar the
NumberFormatInfo instance returned by the
NumberFormat property is not taken into account.
DayCellFormat
Gets or sets the format string that will be applied to the dates presented in the calendar area.
Declaration
public string DayCellFormat { get; set; }
Property Value
Remarks
For additional details see Date Format Pattern topic
DayNameFormat
Specifies the display formats for the days of the week used as selectors by RadCalendar.
Declaration
public DayNameFormat DayNameFormat { get; set; }
Property Value
Remarks
Use the DayNameFormat property to specify the name format for the days of the week. This property is set with one of the DayNameFormat enumeration values. You can specify whether the days of the week are displayed as the full name, short (abbreviated) name, first letter of the day, or first two letters of the day.
The DayNameFormat enumeration represents the display formats for the days of the week used as selectors by RadCalendar.
| Member name | Description |
|---|---|
| FirstLetter | The days of the week displayed with just the first letter. For example, T. |
| FirstTwoLetters | The days of the week displayed with just the first two letters. For example, Tu. |
| Full | The days of the week displayed in full format. For example, Tuesday. |
| Short | The days of the week displayed in abbreviated format. For example, Tues. |
| Shortest | The shortest unique abbreviated day names associated with the current DateTimeFormatInfo object. |
DefaultSize
Gets the default size of the calendar control.
DefaultView
Exposes the top instance of CalendarView or its derived types.
Every CalendarView class handles the real calculation and rendering of RadCalendar's calendric information. The CalendarView has the ChildViews collection which contains all the sub views in case of a multi view setup.
Declaration
[Browsable(false)]
public CalendarView DefaultView { get; }
Property Value
FastNavigationNextImage
Gets or sets the image that is displayed for the next month fast navigation control.
Declaration
public Image FastNavigationNextImage { get; set; }
Property Value
FastNavigationNextText
Gets or sets the text displayed for the fast navigation next month control.
Declaration
public string FastNavigationNextText { get; set; }
Property Value
The text displayed for the CalendarView selection element in the fast navigation next month cell. The default value is ">>".
Remarks
Use the FastNavigationNextText property to provide custom text for the next month navigation element in the title section of RadCalendar.
FastNavigationNextToolTip
Gets or sets the text displayed as a tooltip for the fast navigation previous month control.
Declaration
public string FastNavigationNextToolTip { get; set; }
Property Value
The tooltip text displayed for the CalendarView fast navigation previous month cell. The default value is "<<".
Remarks
Use the FastNavigationPrevToolTip property to provide custom text for the tooltip of the fast navigation previous month element in the title section of RadCalendar.
FastNavigationPrevImage
Gets or sets the image that is displayed for the previous month fast navigation control.
Declaration
public Image FastNavigationPrevImage { get; set; }
Property Value
FastNavigationPrevText
Gets or sets the text displayed for the fast navigation previous month control.
Declaration
public string FastNavigationPrevText { get; set; }
Property Value
The text displayed for the CalendarView selection element in the fast navigation previous month cell. The default value is "<<".
Remarks
Use the FastNavigationPrevText property to provide custom text for the next month navigation element in the title section of RadCalendar.
FastNavigationPrevToolTip
Gets or sets the text displayed as a tooltip for the fast navigation previous month control.
Declaration
public string FastNavigationPrevToolTip { get; set; }
Property Value
The tooltip text displayed for the CalendarView fast navigation previous month cell. The default value is "<<".
Remarks
Use the FastNavigationPrevToolTip property to provide custom text for the tooltip of the fast navigation previous month element in the title section of RadCalendar.
FastNavigationStep
Gets or sets an integer value representing the number of CalendarView views that will be scrolled when the user clicks on a fast navigation button.
FirstDayOfWeek
Specifies the day to display as the first day of the week on the RadCalendar control.
Declaration
public FirstDayOfWeek FirstDayOfWeek { get; set; }
Property Value
Remarks
The FirstDayOfWeek enumeration represents the values that specify which day to display as the first day of the week on the RadCalendar control.
| Member name | Description |
|---|---|
| Default | The first day of the week is specified by the system settings. |
| Friday | The first day of the week is Friday. |
| Monday | The first day of the week is Monday. |
| Saturday | The first day of the week is Saturday. |
| Sunday | The first day of the week is Sunday. |
| Thursday | The first day of the week is Thursday. |
| Tuesday | The first day of the week is Tuesday. |
| Wednesday | The first day of the week is Wednesday. |
FocusedDate
Gets or sets the value that is used by RadCalendar to determine the viewable area displayed .
Declaration
public DateTime FocusedDate { get; set; }
Property Value
Remarks
By default, the FocusedDate property returns the current system date when in runtime, and in design mode defaults to System.DateTime.MinValue. When the FocusedDate is set, from that point, the value returned by the FocusedDate property is the one the user sets.
HeaderHeight
The Height applied to a Header
HeaderNavigationMode
Gets or sets the navigation mode used when the user clicks on the calendar header element.
Declaration
public HeaderNavigationMode HeaderNavigationMode { get; set; }
Property Value
A HeaderNavigationMode value specifying the navigation behavior. The default value is Popup.
Remarks
Zoom navigation mode is not supported in multi-view mode of RadCalendar.
HeaderWidth
The Width applied to a Header
MonthLayout
Gets or sets the predefined pairs of rows and columns, so that the product of the two values is exactly 42, which guarantees valid calendar layout. It is applied on a single view level to every MonthView instance in the calendar.
Declaration
public MonthLayout MonthLayout { get; set; }
Property Value
Remarks
The following values are applicable and defined in the MonthLayout
enumeration:
Layout_7columns_x_6rows - horizontal layout
Layout_14columns_x_3rows - horizontal layout
Layout_21columns_x_2rows - horizontal layout
Layout_7rows_x_6columns - vertical layout, required when AllowColumnHeaderSelectors is true and
Orientation is set to Vertical.
Layout_14rows_x_3columns - vertical layout, required when AllowColumnHeaderSelectors
is true and Orientation is set to Vertical.
Layout_21rows_x_2columns - vertical layout, required when AllowColumnHeaderSelectors is true and Orientation
is set to Vertical.
MultiViewColumns
Gets or sets the the count of columns to be displayed by a multi month CalendarView.
MultiViewRows
Gets or sets the the count of rows to be displayed by a multi month CalendarView.
NavigationNextImage
Gets or sets the image that is displayed for the next month navigation control.
NavigationNextText
Gets or sets the text displayed for the next month navigation control. Will be applied if there is no image set (see NavigationNextImage).
Declaration
public string NavigationNextText { get; set; }
Property Value
The text displayed for the CalendarView next month navigation cell. The default value is ">".
Remarks
Use the NavigationNextText property to provide custom text for the next month navigation element in the title section of RadCalendar.
NavigationNextToolTip
Gets or sets the text displayed as a tooltip for the next month navigation control.
Declaration
public string NavigationNextToolTip { get; set; }
Property Value
The tooltip text displayed for the CalendarView next month navigation cell. The default value is ">".
Remarks
Use the NavigationNextToolTip property to provide custom text for the tooltip of the next month navigation element in the title section of RadCalendar.
NavigationPrevImage
Gets or sets the image that is displayed for the previous month navigation control.
NavigationPrevText
Gets or sets the text displayed for the previous month navigation control. Will be applied only if there is no image set (see NavigationPrevImage).
Declaration
public string NavigationPrevText { get; set; }
Property Value
The text displayed for the CalendarView previous month navigation cell. The default value is "<".
Remarks
Use the NavigationPrevText property to provide custom text for the previous month navigation element in the title section of RadCalendar.
NavigationPrevToolTip
Gets or sets the text displayed as a tooltip for the previous month navigation control.
Declaration
public string NavigationPrevToolTip { get; set; }
Property Value
The tooltip text displayed for the CalendarView previous month navigation cell. The default value is "<".
Remarks
Use the NavigationPrevToolTip property to provide custom text for the tooltip of the previous month navigation element in the title section of RadCalendar.
Orientation
Gets or sets the orientation (rendering direction) of the calendar component. Default value is Horizontal.
Declaration
public Orientation Orientation { get; set; }
Property Value
Remarks
| Member | Description |
|---|---|
| Horizontal | Renders the calendar data row after row. |
| Vertical | Renders the calendar data column after column. |
RangeMaxDate
Gets or sets the maximum date valid for selection by Telerik RadCalendar. Must be interpreted as the higher bound of the valid dates range available for selection. Telerik RadCalendar will not allow navigation or selection past this date.
Declaration
public DateTime RangeMaxDate { get; set; }
Property Value
Remarks
This property has a default value of 12/30/2099 (Gregorian calendar date).
RangeMinDate
Gets or sets the minimal date valid for selection by Telerik RadCalendar. Must be interpreted as the lower bound of the valid dates range available for selection. Telerik RadCalendar will not allow navigation or selection prior to this date.
Declaration
public DateTime RangeMinDate { get; set; }
Property Value
Remarks
This property has a default value of 1/1/1980 (Gregorian calendar date).
ReadOnly
Gets or sets a value indicating whether the calendar is in read-only mode.
RowHeaderImage
Gets or sets the image displayed for all row header elements.
Declaration
public Image RowHeaderImage { get; set; }
Property Value
The image displayed for all CalendarView row header elements. The default value is "".
RowHeaderText
Gets or sets the text displayed for all row header elements.
Declaration
[Bindable(false)]
public string RowHeaderText { get; set; }
Property Value
The text displayed for all CalendarView row header elements. The default value is "".
Remarks
Use the RowHeaderText property to provide custom text for all row header elements.
Rows
Gets or sets the the count of rows to be displayed by a single CalendarView.
Declaration
public int Rows { get; set; }
Property Value
Remarks
If the calendar represents a multi view, this property applies to the child views inside the multi view.
SelectedDate
Sets or returns the currently selected date. The default value is the value of System.DateTime.MinValue.
Declaration
public DateTime SelectedDate { get; set; }
Property Value
Remarks
Use the SelectedDate property to determine the selected date on the >RadCalendar control.
The SelectedDate property and the SelectedDates collection are closely related. When the AllowMultipleSelect property is set to false, a mode that allows only a single date selection, SelectedDate and SelectedDates[0] have the same value and SelectedDates.Count equals 1. When the AllowMultipleSelect property is set to true, mode that allows multiple date selections, SelectedDate and SelectedDates[0] have the same value.
The SelectedDate property is set using a System.DateTime object.
When the user selects a date on the RadCalendar control, the SelectionChanged event is raised. The SelectedDate property is updated to the selected date. The SelectedDates collection is also updated to contain just this date.
Note Both the SelectedDate property and the SelectedDates collection are updated before the SelectionChanged event is raised. You can override the date selection by using the OnSelectionChanged event handler to manually set the SelectedDate property. The SelectionChanged event does not get raised when this property is programmatically set.
SelectedDates
Gets a collection of DateTime objects that represent the selected dates on the RadCalendar control.
Declaration
public DateTimeCollection SelectedDates { get; }
Property Value
A DateTimeCollection that contains a collection of System.DateTime objects representing the selected dates on the RadCalendar control. The default value is an empty DateTimeCollection.
Remarks
Use the SelectedDates collection to determine the currently selected dates on the control.
The SelectedDate property and the SelectedDates collection are closely related. When the AllowMultipleSelect property is set to false, a mode that allows only a single date selection, SelectedDate and SelectedDates[0] have the same value and SelectedDates.Count equals 1. When the AllowMultipleSelect property is set to true, mode that allows multiple date selections, SelectedDate and SelectedDates[0] have the same value.
The SelectedDates property stores a collection of DateTime objects.
When the user selects a date or date range (for example with the column or rows selectors) on the RadCalendar control, the SelectionChanged event is raised. The selected dates are added to the SelectedDates collection, accumulating with previously selected dates. The range of dates are not sorted by default. The SelectedDate property is also updated to contain the first date in the SelectedDates collection.
You can also use the SelectedDates collection to programmatically select dates on the Calendar control. Use the Add, Remove, Clear, and SelectRange methods to programmatically manipulate the selected dates in the SelectedDates collection.
Note Both the SelectedDate property and the SelectedDates collection are updated before the SelectionChanged event is raised.You can override the dates selection by using the OnSelectionChanged event handler to manually set the SelectedDates collection. The SelectionChanged event is not raised when this collection is programmatically set.
ShowColumnHeaders
Gets or sets whether the column headers will appear on the calendar.
ShowFastNavigationButtons
Gets or sets whether the fast navigation buttons should be visible.
Declaration
public virtual bool ShowFastNavigationButtons { get; set; }
Property Value
ShowFooter
Gets or sets whether RadCalendar will display a footer row.
ShowHeader
Gets or sets whether RadCalendar will display a header/navigation row.
ShowNavigationButtons
Gets or sets whether the navigation buttons should be visible.
Declaration
public virtual bool ShowNavigationButtons { get; set; }
Property Value
ShowOtherMonthsDays
Gets or sets whether the month matrix, when rendered will show days from other (previous or next) months or will render only blank cells.
ShowRowHeaders
Gets or sets whether the row headers will appear on the calendar.
ShowViewHeader
Gets or sets whether a single CalendarView object will display a header .
ShowViewSelector
Gets or sets whether a single CalendarView object will display a selector.
SpecialDays
A collection of special days in the calendar to which may be applied specific formatting.
Declaration
public CalendarDayCollection SpecialDays { get; }
Property Value
TitleAlign
Gets or sets the horizontal alignment of the view title.
The ContentAlignment enumeration is defined in System.Windows.Forms.VisualStyles
Declaration
public ContentAlignment TitleAlign { get; set; }
Property Value
Remarks
|
Member name |
Description |
|---|---|
|
Center | The contents of a container are centered. |
| Left | The contents of a container are left justified. |
| Right | The contents of a container are right justified. |
TitleFormat
Gets or sets the format string that is applied to the calendar title.
Declaration
public string TitleFormat { get; set; }
Property Value
Remarks
The property should contain either a format specifier character or a custom format pattern. For more information, see the summary page for System.Globalization.DateTimeFormatInfo.
By default this property uses formatting string of 'MMMM yyyy'. Valid formats are all supported by the .NET Framework.
Example:
- "d" is the standard short date pattern.
- "%d" returns the day of the month; "%d" is a custom pattern.
- "d " returns the day of the month followed by a white-space character; "d " is a custom pattern.
TodayButton
Gets the today button of the footer element
Declaration
public RadButtonElement TodayButton { get; }
Property Value
ViewSelectorImage
Gets or sets the image displayed for the view selector element.
Declaration
[Bindable(false)]
public Image ViewSelectorImage { get; set; }
Property Value
The image displayed for the CalendarView selector element. The default value is null.
ViewSelectorText
Gets or sets the text displayed for the view selector.
Declaration
[Bindable(false)]
public string ViewSelectorText { get; set; }
Property Value
The text displayed for the view selector. The default value is "x".
Remarks
Use the ViewSelectorText property to provide custom text for the CalendarView selector element.
ZoomFactor
Gets or sets the zooming factor of a cell which is handled by the zooming (fish eye) functionality.
Methods
ControlDefinesThemeForElement(RadElement)
Checks whether the element's theme is defined by the control.
Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
element
The element to should be checked.
Returns
true if the control defines theme for this element, false otherwise.
Overrides
Remarks
If true is returned the ThemeResolutionService would not not set any theme to the element to avoid duplicating the style settings of the element.
CreateAccessibilityInstance()
Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Overrides
CreateChildItems(RadElement)
Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
parent
Overrides
EnsureDefaultView()
Ensures that a valid CalendarView object is instantiated and used by RadCalendar as default view.
Declaration
protected virtual CalendarView EnsureDefaultView()
Returns
The CalendarView object to be used as default view.
InvalidateCalendar()
Explicitely invalidates RadCalendar layout. Can be used when batch updates to calendar properties are made outside of the control that require control invalidation.
Declaration
public void InvalidateCalendar()
OnElementRender(LightVisualElement, RadCalendarDay, CalendarView)
Raises the ElementRender event of the RadCalendar control and allows you to provide a custom handler for the ElementRender event.
Declaration
protected virtual void OnElementRender(LightVisualElement cell, RadCalendarDay day, CalendarView view)
Parameters
cell
A LightVisualElement object that contains information about the cell to render.
day
A RadCalendarDay that contains information about the day to render.
view
A CalendarView that contains the day to render.
OnLoad(Size)
Notifies that the control is about to be visualized.
Declaration
protected override void OnLoad(Size desiredSize)
Parameters
desiredSize
Overrides
OnNavigated(CalendarNavigatedEventArgs)
Declaration
protected virtual void OnNavigated(CalendarNavigatedEventArgs args)
Parameters
args
OnNavigating(CalendarNavigatingEventArgs)
Declaration
protected virtual void OnNavigating(CalendarNavigatingEventArgs args)
Parameters
args
OnNotifyPropertyChanged(PropertyChangedEventArgs)
Declaration
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
e
Overrides
OnRightToLeftChanged(EventArgs)
Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
e
Overrides
OnSelectionChanged()
Raises the SelectionChanged event.
Declaration
protected virtual void OnSelectionChanged()
OnSelectionChanging(DateTimeCollection, List<DateTime>)
Raises the SelectionChanging event.
Declaration
protected virtual SelectionEventArgs OnSelectionChanging(DateTimeCollection dates, List<DateTime> newDates)
Parameters
dates
A DateTimeCollection collection used by SelectionEventArgs.
newDates
List<DateTime>
A List with Dates which will be selected
Returns
SelectionEventArgs instance.
OnViewChanged()
Raises the ViewChanged event.
Declaration
protected virtual void OnViewChanged()
OnViewChanging(CalendarView)
Raises the ViewChanging event.
Declaration
protected virtual ViewChangingEventArgs OnViewChanging(CalendarView view)
Parameters
view
A CalendarView collection used by ViewChangingEventArgs.
Returns
ViewChangingEventArgs instance.
OnZoomChanged(CalendarZoomChangedEventArgs)
Declaration
protected virtual void OnZoomChanged(CalendarZoomChangedEventArgs args)
Parameters
args
OnZoomChanging(CalendarZoomChangingEventArgs)
Declaration
protected virtual void OnZoomChanging(CalendarZoomChangingEventArgs args)
Parameters
args
RemoveFocusedDate(bool)
Remove focused date and change the current view to today
Declaration
public virtual void RemoveFocusedDate(bool removeAlsoSelectedDate)
Parameters
removeAlsoSelectedDate
Indicates that all selected dates will be cleared as well.
ScaleControl(SizeF, BoundsSpecified)
Declaration
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
Parameters
factor
specified
Overrides
TruncateTimeComponent(DateTime)
Removes the time component of a DateTime object, thus leaving only the date part.
Events
ElementRender
ElementRender event is fired after the generation of every calendar cell object and just before it gets rendered. It is the last place where changes to the already constructed calendar cells can be made.
Declaration
public event RenderElementEventHandler ElementRender
Event Value
Navigated
Occurs when the view is changed by the navigation elements.
Declaration
public event CalendarNavigatedEventHandler Navigated
Event Value
Navigating
Occurs when the view is about to be changed by the navigation elements.
Declaration
public event CalendarNavigatingEventHandler Navigating
Event Value
SelectionChanged
SlectionChanged event is fired when a new date is added or removed from the SelectedDates collection.
SelectionChanging
SlectionChanged event is fired when a new date is added or removed from the SelectedDates collection.
Declaration
public event SelectionEventHandler SelectionChanging
Event Value
ViewChanged
<em>ViewChanged</em> event is fired when a navigation to a different date
range occurred. Generally this is done by using the normal navigation buttons.
ViewChanging
ViewChanging event is fired when a navigation to a different date range is required.
Declaration
public event ViewChangingEventHandler ViewChanging
Event Value
ZoomChanged
Occurs when the zoom level has changed.
Declaration
public event CalendarZoomChangedEventHandler ZoomChanged
Event Value
ZoomChanging
Occurs when the zoom level is about to change.
Declaration
public event CalendarZoomChangingEventHandler ZoomChanging
Event Value