New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

C#
[EmbeddedSkin("Calendar", typeof(RadCalendar))]
[EmbeddedSkin("Calendar", "Default", typeof(RadCalendar))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadCalendar))]
[ToolboxBitmap(typeof(RadCalendar), "Toolbox.Icons.Calendar.png")]
[TelerikToolboxCategory("Calendar, Scheduler and Gantt")]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadCalendar))]
[ControlValueProperty("SelectedDate")]
[ClientScriptResource("Telerik.Web.UI.RadCalendar", "Telerik.Web.UI.Calendar.RadCalendarScript.js")]
[ClientScriptResource("Telerik.Web.UI.RadCalendar", "Telerik.Web.UI.Calendar.RadCalendarCommonScript.js")]
[ClientScriptResource("Telerik.Web.UI.RadCalendar", "Telerik.Web.UI.Common.Navigation.OverlayScript.js")]
[RequiredScript(typeof(MaterialRipple))]
[RequiredScript(typeof(jQuery))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadCalendar))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Lightweight, typeof(RadCalendar))]
public class RadCalendar : PropertiesControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IStateManager, IPostBackEventHandler, INamingContainer

Inheritance: objectControlWebControlRadWebControlPropertiesControlRadCalendar...

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorINamingContainerIParserAccessorIPostBackDataHandlerIPostBackEventHandlerIScriptControlISkinnableControlIStateManagerIUrlResolutionService...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.MergeStyle(Style)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.RenderContents(HtmlTextWriter)WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagKeyWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.OnInit(EventArgs)Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.OnPreRender(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

C#
public RadCalendar()

Properties

Gets or sets a value indicating whether a postback to the server automatically occurs when the user interacts with the control.

C#
[ClientControlProperty]
public virtual bool AutoPostBack { get; set; }
Property Value:

The default value is false.

Setting this property to true will make Telerik RadCalendar postback to the server on date selection or when navigating to a different month.

Gets the default System.Globalization.Calendar instance as specified by the default culture.

C#
[Browsable(false)]
public Calendar Calendar { get; }

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.

Gets or sets a value for RadCalendar caption.

C#
public virtual string CalendarCaption { get; set; }
Property Value:

The default value is "Calendar".

Setting this property to empty string will force Telerik RadCalendar to not render caption tag

Gets or sets a collection of type CalendarDayTemplateCollection which stores the created templates to use with RadCalendar. All of the items are represented by DayTemplate instances.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public CalendarDayTemplateCollection CalendarDayTemplates { get; }

Gets or sets a value for RadCalendar summary.

C#
public virtual string CalendarSummary { get; set; }
Property Value:

The default value is "Calendar control which enables the selection of dates.".

Setting this property to empty string will force Telerik RadCalendar to not render summary attribute

Gets the style properties for the Calendar table container.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle CalendarTableStyle { get; }
Property Value:

A TableItemStyle that contains the style properties for the Calendar table container.

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 multi view setup.

C#
[Browsable(false)]
public CalendarView CalendarView { get; }

Gets or sets the horizontal alignment of the date cells content inside the calendar area.

The HorizontalAlign enumeration is defined in System.Web.UI.WebControls

C#
public HorizontalAlign CellAlign { get; set; }

Member name

Description

Center

The contents of a container are centered.
JustifyThe contents of a container are uniformly spread out and aligned with both the left and right margins.
LeftThe contents of a container are left justified.
NotSetThe horizontal alignment is not set.
RightThe contents of a container are right justified.

Gets or sets the format string that will be applied to the dates presented in the calendar area.

C#
[ClientControlProperty]
public string CellDayFormat { get; set; }

For additional details see Date Format Pattern topic

Gets or sets the vertical alignment of the date cells content inside the calendar area.

The VerticalAlign enumeration is defined in System.Web.UI.WebControls

C#
public VerticalAlign CellVAlign { get; set; }
Member nameDescription
BottomText or object is aligned with the bottom of the enclosing control.
MiddleText or object is aligned with the center of the enclosing control.
NotSetVertical alignment is not set.
TopText or object is aligned with the top of the enclosing control.

Gets the instance of CalendarClientEvents class which defines the JavaScript functions (client-side event handlers) that are invoked when specific client-side events are raised.

C#
[TypeConverter(typeof(ExpandableObjectConverter))]
[PersistenceMode(PersistenceMode.InnerProperty)]
public CalendarClientEvents ClientEvents { get; }

Gets or sets the image displayed for the column header element.

C#
[Bindable(false)]
public string ColumnHeaderImage { get; set; }
Property Value:

The image displayed for the CalendarView column header element in the header cells. The default value is "".

This property applies only if the ShowColumnHeaders property is set to true. If ColumnHeaderText is set too, its value is set as an alternative text to the image of the column header.

When using this property, the whole image URL is generated using also the ImagesBaseDir value.

Example:

ShowColumnHeaders="true"
ImagesBaseDir = "Img/"
ColumnHeaderImage = "selector.gif"
complete image URL : "Img/selector.gif"

Gets or sets the text displayed for the column header element.

C#
[Bindable(false)]
public string ColumnHeaderText { get; set; }
Property Value:

The text displayed for the CalendarView column header element. The default value is "".

Use the ColumnHeaderText property to provide custom text for the CalendarView complete column header element.

This property does not automatically encode to HTML. You need to convert special characters to the appropriate HTML value, unless you want the characters to be treated as HTML. For example, to explicitly display the greater than symbol (>), you must use the value >.

Because this property does not automatically encode to HTML, it is possible to specify an HTML tag for the ColumnHeaderText property. For example, if you want to display an image for the next month navigation control, you can set this property to an expression that contains an <img> element.

This property applies only if the ShowColumnHeaders property is set to true.

Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.

C#
public override string CssClass { get; set; }
Property Value:

The CSS class rendered by the Web server control on the client. The default is calendarWrapper_[skin name].

Overrides: RadWebControl.CssClass

Gets or sets the name of the file containing the CSS definition used by RadCalendar. Use "~/" (tilde) as a substitution of the web-application root directory.

C#
public string CssFile { get; set; }
C#
public CultureInfo Culture { get; set; }

Gets or sets the CultureInfo instance that represents information about the culture of this RadCalendar object.

A CultureInfo class describes information about the culture of this RadCalendar instance including 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.

C#
[TypeConverter(typeof(CultureInfoConverter))]
public CultureInfo CultureInfo { get; set; }

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 NameCulture IdentifierLanguage-Country/Region
"" (empty string)0x007Finvariant culture
af0x0036Afrikaans
af-ZA0x0436Afrikaans - South Africa
sq0x001CAlbanian
sq-AL0x041CAlbanian - Albania
ar0x0001Arabic
ar-DZ0x1401Arabic - Algeria
ar-BH0x3C01Arabic - Bahrain
ar-EG0x0C01Arabic - Egypt
ar-IQ0x0801Arabic - Iraq
ar-JO0x2C01Arabic - Jordan
ar-KW0x3401Arabic - Kuwait
ar-LB0x3001Arabic - Lebanon
ar-LY0x1001Arabic - Libya
ar-MA0x1801Arabic - Morocco
ar-OM0x2001Arabic - Oman
ar-QA0x4001Arabic - Qatar
ar-SA0x0401Arabic - Saudi Arabia
ar-SY0x2801Arabic - Syria
ar-TN0x1C01Arabic - Tunisia
ar-AE0x3801Arabic - United Arab Emirates
ar-YE0x2401Arabic - Yemen
hy0x002BArmenian
hy-AM0x042BArmenian - Armenia
az0x002CAzeri
az-AZ-Cyrl0x082CAzeri (Cyrillic) - Azerbaijan
az-AZ-Latn0x042CAzeri (Latin) - Azerbaijan
eu0x002DBasque
eu-ES0x042DBasque - Basque
be0x0023Belarusian
be-BY0x0423Belarusian - Belarus
bg0x0002Bulgarian
bg-BG0x0402Bulgarian - Bulgaria
ca0x0003Catalan
ca-ES0x0403Catalan - Catalan
zh-HK0x0C04Chinese - Hong Kong SAR
zh-MO0x1404Chinese - Macau SAR
zh-CN0x0804Chinese - China
zh-CHS0x0004Chinese (Simplified)
zh-SG0x1004Chinese - Singapore
zh-TW0x0404Chinese - Taiwan
zh-CHT0x7C04Chinese (Traditional)
hr0x001ACroatian
hr-HR0x041ACroatian - Croatia
cs0x0005Czech
cs-CZ0x0405Czech - Czech Republic
da0x0006Danish
da-DK0x0406Danish - Denmark
div0x0065Dhivehi
div-MV0x0465Dhivehi - Maldives
nl0x0013Dutch
nl-BE0x0813Dutch - Belgium
nl-NL0x0413Dutch - The Netherlands
en0x0009English
en-AU0x0C09English - Australia
en-BZ0x2809English - Belize
en-CA0x1009English - Canada
en-CB0x2409English - Caribbean
en-IE0x1809English - Ireland
en-JM0x2009English - Jamaica
en-NZ0x1409English - New Zealand
en-PH0x3409English - Philippines
en-ZA0x1C09English - South Africa
en-TT0x2C09English - Trinidad and Tobago
en-GB0x0809English - United Kingdom
en-US0x0409English - United States
en-ZW0x3009English - Zimbabwe
et0x0025Estonian
et-EE0x0425Estonian - Estonia
fo0x0038Faroese
fo-FO0x0438Faroese - Faroe Islands
fa0x0029Farsi
fa-IR0x0429Farsi - Iran
fi0x000BFinnish
fi-FI0x040BFinnish - Finland
fr0x000CFrench
fr-BE0x080CFrench - Belgium
fr-CA0x0C0CFrench - Canada
fr-FR0x040CFrench - France
fr-LU0x140CFrench - Luxembourg
fr-MC0x180CFrench - Monaco
fr-CH0x100CFrench - Switzerland
gl0x0056Galician
gl-ES0x0456Galician - Galician
ka0x0037Georgian
ka-GE0x0437Georgian - Georgia
de0x0007German
de-AT0x0C07German - Austria
de-DE0x0407German - Germany
de-LI0x1407German - Liechtenstein
de-LU0x1007German - Luxembourg
de-CH0x0807German - Switzerland
el0x0008Greek
el-GR0x0408Greek - Greece
gu0x0047Gujarati
gu-IN0x0447Gujarati - India
he0x000DHebrew
he-IL0x040DHebrew - Israel
hi0x0039Hindi
hi-IN0x0439Hindi - India
hu0x000EHungarian
hu-HU0x040EHungarian - Hungary
is0x000FIcelandic
is-IS0x040FIcelandic - Iceland
id0x0021Indonesian
id-ID0x0421Indonesian - Indonesia
it0x0010Italian
it-IT0x0410Italian - Italy
it-CH0x0810Italian - Switzerland
ja0x0011Japanese
ja-JP0x0411Japanese - Japan
kn0x004BKannada
kn-IN0x044BKannada - India
kk0x003FKazakh
kk-KZ0x043FKazakh - Kazakhstan
kok0x0057Konkani
kok-IN0x0457Konkani - India
ko0x0012Korean
ko-KR0x0412Korean - Korea
ky0x0040Kyrgyz
ky-KZ0x0440Kyrgyz - Kazakhstan
lv0x0026Latvian
lv-LV0x0426Latvian - Latvia
lt0x0027Lithuanian
lt-LT0x0427Lithuanian - Lithuania
mk0x002FMacedonian
mk-MK0x042FMacedonian - FYROM
ms0x003EMalay
ms-BN0x083EMalay - Brunei
ms-MY0x043EMalay - Malaysia
mr0x004EMarathi
mr-IN0x044EMarathi - India
mn0x0050Mongolian
mn-MN0x0450Mongolian - Mongolia
no0x0014Norwegian
nb-NO0x0414Norwegian (Bokmal) - Norway
nn-NO0x0814Norwegian (Nynorsk) - Norway
pl0x0015Polish
pl-PL0x0415Polish - Poland
pt0x0016Portuguese
pt-BR0x0416Portuguese - Brazil
pt-PT0x0816Portuguese - Portugal
pa0x0046Punjabi
pa-IN0x0446Punjabi - India
ro0x0018Romanian
ro-RO0x0418Romanian - Romania
ru0x0019Russian
ru-RU0x0419Russian - Russia
sa0x004FSanskrit
sa-IN0x044FSanskrit - India
sr-SP-Cyrl0x0C1ASerbian (Cyrillic) - Serbia
sr-SP-Latn0x081ASerbian (Latin) - Serbia
sk0x001BSlovak
sk-SK0x041BSlovak - Slovakia
sl0x0024Slovenian
sl-SI0x0424Slovenian - Slovenia
es0x000ASpanish
es-AR0x2C0ASpanish - Argentina
es-BO0x400ASpanish - Bolivia
es-CL0x340ASpanish - Chile
es-CO0x240ASpanish - Colombia
es-CR0x140ASpanish - Costa Rica
es-DO0x1C0ASpanish - Dominican Republic
es-EC0x300ASpanish - Ecuador
es-SV0x440ASpanish - El Salvador
es-GT0x100ASpanish - Guatemala
es-HN0x480ASpanish - Honduras
es-MX0x080ASpanish - Mexico
es-NI0x4C0ASpanish - Nicaragua
es-PA0x180ASpanish - Panama
es-PY0x3C0ASpanish - Paraguay
es-PE0x280ASpanish - Peru
es-PR0x500ASpanish - Puerto Rico
es-ES0x0C0ASpanish - Spain
es-UY0x380ASpanish - Uruguay
es-VE0x200ASpanish - Venezuela
sw0x0041Swahili
sw-KE0x0441Swahili - Kenya
sv0x001DSwedish
sv-FI0x081DSwedish - Finland
sv-SE0x041DSwedish - Sweden
syr0x005ASyriac
syr-SY0x045ASyriac - Syria
ta0x0049Tamil
ta-IN0x0449Tamil - India
tt0x0044Tatar
tt-RU0x0444Tatar - Russia
te0x004ATelugu
te-IN0x044ATelugu - India
th0x001EThai
th-TH0x041EThai - Thailand
tr0x001FTurkish
tr-TR0x041FTurkish - Turkey
uk0x0022Ukrainian
uk-UA0x0422Ukrainian - Ukraine
ur0x0020Urdu
ur-PK0x0420Urdu - Pakistan
uz0x0043Uzbek
uz-UZ-Cyrl0x0843Uzbek (Cyrillic) - Uzbekistan
uz-UZ-Latn0x0443Uzbek (Latin) - Uzbekistan
vi0x002AVietnamese
vi-VN0x042AVietnamese - Vietnam

Gets or sets the separator string that will be put between start and end months in a multi view title.

C#
[ClientControlProperty]
public string DateRangeSeparator { get; set; }

Gets or sets a DateTimeFormatInfo instance that defines the culturally appropriate format of displaying dates and times as specified by the default culture.

C#
[Browsable(false)]
public DateTimeFormatInfo DateTimeFormat { get; }

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.

Gets or sets the format string that is applied to the days cells tooltip.

C#
[ClientControlProperty]
public string DayCellToolTipFormat { get; set; }

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.

Specifies the display formats for the days of the week used as selectors by RadCalendar.

C#
public DayNameFormat DayNameFormat { get; set; }

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 nameDescription
FirstLetterThe days of the week displayed with just the first letter. For example, T.
FirstTwoLettersThe days of the week displayed with just the first two letters. For example, Tu.
FullThe days of the week displayed in full format. For example, Tuesday.
ShortThe days of the week displayed in abbreviated format. For example, Tues.

Gets the style properties applied when hovering over the Calendar days.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle DayOverStyle { get; }
Property Value:

A TableItemStyle that contains the style properties applied when hovering over the Calendar days.

Gets the style properties for the days in the displayed month.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle DayStyle { get; }
Property Value:

A TableItemStyle that contains the style properties for the days in the displayed month.

Gets or sets a value for DaysView summary.

C#
public virtual string DaysViewSummary { get; set; }
Property Value:

The default value is "Table containing all dates for the currently selected month.".

Setting this property to empty string will force Telerik RadCalendar to not render summary attribute for the DaysView.

Gets or sets the cell padding of the table where are rendered the calendar days.

C#
public int DefaultCellPadding { get; set; }

Gets or sets the cell spacing of the table where are rendered the calendar days.

C#
public int DefaultCellSpacing { get; set; }

Gets the style properties for the disabled dates.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle DisabledDayStyle { get; }
Property Value:

A TableItemStyle that contains the style properties for the disabled dates.

C#
protected bool EmptySkin { get; }

When set to true enables support for WAI-ARIA

C#
public bool EnableAriaSupport { get; set; }

Gets or sets the enable client side navigation with arrow keys.

C#
public bool EnableKeyboardNavigation { get; set; }
Property Value:

The enable client side navigation with arrow keys.

Gets or sets whether the month/year fast navigation controls in the title section will be enabled.

C#
[ClientControlProperty]
[ClientPropertyName("calendarEnableMonthYearFastNavigation")]
public bool EnableMonthYearFastNavigation { get; set; }

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.

C#
[Bindable(false)]
[ClientControlProperty]
public virtual bool EnableMultiSelect { get; set; }

Gets or sets whether the navigation controls in the title section will be displayed.

C#
[ClientControlProperty]
[ClientPropertyName("calendarEnableNavigation")]
public bool EnableNavigation { get; set; }

Enables the animation shown when the calendar navigates to a different view.

C#
[Bindable(false)]
[ClientControlProperty]
public virtual bool EnableNavigationAnimation { get; set; }

Gets or sets whether the repeatable days logic should be supported on the client (effective for client calendar - with set property AutoPostBack="false").

C#
[ClientControlProperty]
public bool EnableRepeatableDaysOnClient { get; set; }
Property Value:

true, if the repeatable days logic should be supported on the client; otherwise, false. The default value is true.

The EnableRepeatableDaysOnClient property has effect over the logic of the recurring events to the calendar. It should be true, if you wants the repeatable days to be supported by a calendar with AutoPostBack="false". If you are not using repeatable days or/and client calendar, you can improve the calendar performance by setting it to false.

Gets or sets whether popup shadows will appear.

C#
[ClientControlProperty]
[ClientPropertyName("_enableShadows")]
public bool EnableShadows { get; set; }

Gets or sets whether a selector for the entire CalendarView ( MonthView ) will appear on the calendar.

C#
public bool EnableViewSelector { get; set; }

Set this property to false if like to disable the selection of weekends. The default value is true.

C#
[Browsable(true)]
[Bindable(true)]
public bool EnableWeekends { get; set; }

Gets or sets the name of the image that is displayed for the next month fast navigation control.

C#
public string FastNavigationNextImage { get; set; }

When using this property, the whole image URL is generated using also the ImagesBaseDir (if no skin is applied) or the SkinPath (if skin is applied) properties values.


Example when skin is NOT defined:
ImagesBaseDir = "Img/"
RowSelectorImage = "nav.gif"
complete image URL : "Img/nav.gif"

Example when skin is defined:
SkinPath = "RadControls/Calendar/Skins/"
RowSelectorImage = "nav.gif"
complete image URL : "RadControls/Calendar/Skins/nav.gif"

Gets or sets the text displayed for the fast navigation next month control. Will be applied if there is no image set (see FastNavigationNextImage).

C#
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 "&gt;&gt;".

Use the FastNavigationNextText property to provide custom text for the next month navigation element in the title section of RadCalendar.

Note that the FastNavigationNextImage has priority and its value should be set to an empty string in order to be applied the FastNavigationNextText value.

This property does not automatically encode to HTML. You need to convert special characters to the appropriate HTML value, unless you want the characters to be treated as HTML. For example, to explicitly display the greater than symbol (>), you must use the value &gt;.

Because this property does not automatically encode to HTML, it is possible to specify an HTML tag for the FastNavigationNextText property. For example, if you want to display an image for the next month navigation control, you can set this property to an expression that contains an <img> element. However note that FastNavigationNextImage property is available for this type of functionality.

This property applies only if the EnableNavigation property is set to true.

Gets or sets the text displayed as a tooltip for the fast navigation next month control.

C#
public string FastNavigationNextToolTip { get; set; }
Property Value:

The tooltip text displayed for the CalendarView fast navigation next month cell. The default value is "&gt;&gt;".

Use the FastNavigationNextToolTip property to provide custom text for the tooltip of the fast navigation next month element in the title section of RadCalendar.

Gets or sets the name of the image that is displayed for the previous month fast navigation control.

C#
public string FastNavigationPrevImage { get; set; }

When using this property, the whole image URL is generated using also the ImagesBaseDir (if no skin is applied) or the SkinPath (if skin is applied) properties values.


Example when skin is NOT defined:
ImagesBaseDir = "Img/"
RowSelectorImage = "nav.gif"
complete image URL : "Img/nav.gif"

Example when skin is defined:
SkinPath = "RadControls/Calendar/Skins/"
RowSelectorImage = "nav.gif"
complete image URL : "RadControls/Calendar/Skins/nav.gif"

Gets or sets the text displayed for the fast navigation previous month control. Will be applied if there is no image set (see FastNavigationPrevImage).

C#
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 "&lt;&lt;".

Use the FastNavigationPrevText property to provide custom text for the next month navigation element in the title section of RadCalendar.

Note that the FastNavigationPrevImage has priority and its value should be set to an empty string in order to be applied the FastNavigationPrevText value.

This property does not automatically encode to HTML. You need to convert special characters to the appropriate HTML value, unless you want the characters to be treated as HTML. For example, to explicitly display the greater than symbol (>), you must use the value &gt;.

Because this property does not automatically encode to HTML, it is possible to specify an HTML tag for the FastNavigationPrevText property. For example, if you want to display an image for the next month navigation control, you can set this property to an expression that contains an <img> element. However note that FastNavigationPrevImage property is available for this type of functionality.

This property applies only if the EnableNavigation property is set to true.

Gets or sets the text displayed as a tooltip for the fast navigation previous month control.

C#
public string FastNavigationPrevToolTip { get; set; }
Property Value:

The tooltip text displayed for the CalendarView fast navigation previous month cell. The default value is "&lt;&lt;".

Use the FastNavigationPrevToolTip property to provide custom text for the tooltip of the fast navigation previous month element in the title section of RadCalendar.

Gets or sets the MonthYearFastNavigationSettings object whose inner properties can be used to modify the fast Month/Year client navigation settings.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public MonthYearFastNavigationSettings FastNavigationSettings { get; }
Property Value:MonthYearFastNavigationSettings

Gets or sets an integer value representing the number of CalendarView views that will be scrolled when the user clicks on a fast navigation link.

C#
[ClientControlProperty]
public int FastNavigationStep { get; set; }

Gets the style properties for the Month/Year fast navigation.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle FastNavigationStyle { get; }
Property Value:

A TableItemStyle that contains the style properties for the the Month/Year fast navigation.

Specifies the day to display as the first day of the week on the RadCalendar control.

The FirstDayOfWeek enumeration can be found in System.Web.UI.WebControls Namespace.

C#
public FirstDayOfWeek FirstDayOfWeek { get; set; }

The FirstDayOfWeek enumeration represents the values that specify which day to display as the first day of the week on the RadCalendar control.

Member nameDescription
DefaultThe first day of the week is specified by the system settings.
FridayThe first day of the week is Friday.
MondayThe first day of the week is Monday.
SaturdayThe first day of the week is Saturday.
SundayThe first day of the week is Sunday.
ThursdayThe first day of the week is Thursday.
TuesdayThe first day of the week is Tuesday.
WednesdayThe first day of the week is Wednesday.

Gets or sets the value that is used by RadCalendar to determine the viewable area displayed .

C#
public DateTime FocusedDate { get; set; }

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.

Gets or sets the column index where the FocusedDate (and the month view it belongs to) will be positioned inside a multi view area.

C#
[Obsolete("This property is obsolete and will be removed.")]
public int FocusedDateColumn { get; set; }

Gets or sets the row index where the FocusedDate (and the month view it belongs to) will be positioned inside a multi view area.

C#
[Obsolete("This property is obsolete and will be removed.")]
public int FocusedDateRow { get; set; }

Gets or sets the System.Web.UI.ITemplate that defines how the footer section of the RadCalendar control is displayed.

C#
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TemplateContainer(typeof(TemplateContainer))]
public ITemplate FooterTemplate { get; set; }
Property Value:

The default value is a null reference (Nothing in Visual Basic).

Footer section of the RadCalendar control is displayed under the main calendar area (the section that displays the dates information).

Use this property to create a template that controls how the footer section of a RadCalendar control is displayed.

CAUTION This control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. ASP.NET provides an input request validation feature to block script and HTML in user input. Validation server controls are also provided to assess user input. For more information, see Validation Server Controls in MSDN.

Gets the style properties for the row and column headers.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle HeaderStyle { get; }
Property Value:

A TableItemStyle that contains the style properties for the row and column headers.

Gets or sets the System.Web.UI.ITemplate that defines how the header section of the RadCalendar control is displayed.

C#
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TemplateContainer(typeof(TemplateContainer))]
public ITemplate HeaderTemplate { get; set; }
Property Value:

The default value is a null reference (Nothing in Visual Basic).

Header section of the RadCalendar control is displayed under the title section and above the main calendar area (the section that displays the dates information).

Use this property to create a template that controls how the header section of a RadCalendar control is displayed.

CAUTION This control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. ASP.NET provides an input request validation feature to block script and HTML in user input. Validation server controls are also provided to assess user input. For more information, see Validation Server Controls in MSDN.

Gets or sets a value indicating whether the navigation control should be visible when disabled.

C#
[ClientControlProperty]
public bool HideNavigationControls { get; set; }
Property Value:

The default value is false.

Setting this property to true will hide the navigation controls when they are disabled

Gets or sets default path for the grid images when EnableEmbeddedSkins is set to false.

C#
public virtual string ImagesPath { get; set; }
Property Value:

A string containing the path for the grid images. The default is string.Empty.

Used to define keyboard shortcut to focus the RadCalendar's main table.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public KeyboardNavigationSettings KeyboardNavigationSettings { get; }

Gets or sets a value indicating where RadCalendar will look for its .resx localization file. By default this file should be in the App_GlobalResources folder. However, if you cannot put the resource file in the default location or .resx files compilation is disabled for some reason (e.g. in a DotNetNuke environment), this property should be set to the location of the resource file.

C#
public string LocalizationPath { get; set; }
Property Value:

A relative path to the dialogs location. For example: "~/controls/RadCalendarResources/".

If specified, the LocalizationPath property will allow you to load the grid localization file from any location in the web application.

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.

C#
public MonthLayout MonthLayout { get; set; }

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 UseDaysAsSelectors is true and Orientation is set to RenderInColumns.

Layout_14rows_x_3columns - vertical layout, required when UseDaysAsSelectors is true and Orientation is set to RenderInColumns.

Layout_21rows_x_2columns - vertical layout, required when UseDaysAsSelectors is true and Orientation is set to RenderInColumns.

Gets or sets the the count of columns to be displayed by a multi month CalendarView.

C#
[ClientControlProperty]
public int MultiViewColumns { get; set; }

Gets or sets the the count of rows to be displayed by a multi month CalendarView.

C#
[ClientControlProperty]
public int MultiViewRows { get; set; }

Gets or sets a value for navigation controls caption.

C#
public virtual string NavigationCaption { get; set; }
Property Value:

The default value is "Title and navigation".

Setting this property to empty string will force Telerik RadCalendar to not render caption tag

Gets or sets the cell padding that is applied to the title table.

C#
public int NavigationCellPadding { get; set; }

Gets or sets the cell spacing that is applied to the title table.

C#
public int NavigationCellSpacing { get; set; }

Gets or sets the name of the image that is displayed for the next month navigation control.

C#
public string NavigationNextImage { get; set; }

When using this property, the whole image URL is generated using also the ImagesBaseDir (if no skin is applied) or the SkinPath (if skin is applied) properties values.


Example when skin is NOT defined:
ImagesBaseDir = "Img/"
RowSelectorImage = "nav.gif"
complete image URL : "Img/nav.gif"

Example when skin is defined:
SkinPath = "RadControls/Calendar/Skins/"
RowSelectorImage = "nav.gif"
complete image URL : "RadControls/Calendar/Skins/nav.gif"

Gets or sets the text displayed for the next month navigation control. Will be applied if there is no image set (see NavigationNextImage).

C#
public string NavigationNextText { get; set; }
Property Value:

The text displayed for the CalendarView next month navigation cell. The default value is "&gt;".

Use the NavigationNextText property to provide custom text for the next month navigation element in the title section of RadCalendar.

Note that the NavigationNextImage has priority and its value should be set to an empty string in order to be applied the NavigationNextText value.

This property does not automatically encode to HTML. You need to convert special characters to the appropriate HTML value, unless you want the characters to be treated as HTML. For example, to explicitly display the greater than symbol (>), you must use the value &gt;.

Because this property does not automatically encode to HTML, it is possible to specify an HTML tag for the NavigationNextText property. For example, if you want to display an image for the next month navigation control, you can set this property to an expression that contains an <img> element. However note that NavigationNextImage property is available for this type of functionality.

This property applies only if the EnableNavigation property is set to true.

Gets or sets the text displayed as a tooltip for the next month navigation control.

C#
public string NavigationNextToolTip { get; set; }
Property Value:

The tooltip text displayed for the CalendarView next month navigation cell. The default value is "&gt;".

Use the NavigationNextToolTip property to provide custom text for the tooltip of the next month navigation element in the title section of RadCalendar.

Gets or sets name of the image that is displayed for the previous month navigation control.

C#
public string NavigationPrevImage { get; set; }

When using this property, the whole image URL is generated using also the ImagesBaseDir (if no skin is applied) or the SkinPath (if skin is applied) properties values.


Example when skin is NOT defined:
ImagesBaseDir = "Img/"
RowSelectorImage = "nav.gif"
complete image URL : "Img/nav.gif"

Example when skin is defined:
SkinPath = "RadControls/Calendar/Skins/"
RowSelectorImage = "nav.gif"
complete image URL : "RadControls/Calendar/Skins/nav.gif"

Gets or sets the text displayed for the previous month navigation control. Will be applied only if there is no image set (see NavigationPrevImage).

C#
public string NavigationPrevText { get; set; }
Property Value:

The text displayed for the CalendarView previous month navigation cell. The default value is "&lt;".

Use the NavigationPrevText property to provide custom text for the previous month navigation element in the title section of RadCalendar.

Note that the NavigationPrevImage has priority and its value should be set to an empty string in order to be applied the NavigationPrevText value.

This property does not automatically encode to HTML. You need to convert special characters to the appropriate HTML value, unless you want the characters to be treated as HTML. For example, to explicitly display the greater than symbol (>), you must use the value &gt;.

Because this property does not automatically encode to HTML, it is possible to specify an HTML tag for the NavigationPrevText property. For example, if you want to display an image for the next month navigation control, you can set this property to an expression that contains an <img> element. However note that NavigationPrevImage property is available for this type of functionality.

This property applies only if the EnableNavigation property is set to true.

Gets or sets the text displayed as a tooltip for the previous month navigation control.

C#
public string NavigationPrevToolTip { get; set; }
Property Value:

The tooltip text displayed for the CalendarView previous month navigation cell. The default value is "&lt;".

Use the NavigationPrevToolTip property to provide custom text for the tooltip of the previous month navigation element in the title section of RadCalendar.

Gets or sets a value for navigation controls summary.

C#
public virtual string NavigationSummary { get; set; }
Property Value:

The default value is "title and navigation".

Setting this property to empty string will force Telerik RadCalendar to not render summary attribute

Gets or sets the orientation (rendering direction) of the calendar component. Default value is RenderInRows.

C#
[ClientControlProperty]
public Orientation Orientation { get; set; }
MemberDescription
RenderInRowsRenders the calendar data row after row.
RenderInColumnsRenderInColumns - Renders the calendar data column after column.
NoneEnforces fallback to the default Orientation for Telerik RadCalendar.

Gets the style properties for the days on the Calendar control that are not in the displayed month.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle OtherMonthDayStyle { get; }
Property Value:

A TableItemStyle that contains the style properties for the days on the Calendar control that are not in the displayed month.

Gets the style properties for the days on the Calendar control that are out of the valid range for selection.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle OutOfRangeDayStyle { get; }
Property Value:

A TableItemStyle that contains the style properties for the days on the Calendar control that are out of the valid range for selection.

Gets or sets a value indicating whether the calendar will create an overlay element to ensure popups are over a flash element or Java applet.

C#
[Browsable(true)]
[Bindable(true)]
public bool Overlay { get; set; }
Property Value:

The default value is false.

Gets or sets the default type used by RadCalendar to handle its layout, and how will react to user interaction.

C#
[ClientControlProperty]
public PresentationType PresentationType { get; set; }
MemberDescription
InteractiveInteractive - user is allowed to select dates, navigate, etc.
PreviewPreview - does not allow user interaction, for presentation purposes only.

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.

C#
public DateTime RangeMaxDate { get; set; }

This property has a default value of 12/30/2099 (Gregorian calendar date).

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.

C#
public DateTime RangeMinDate { get; set; }

This property has a default value of 1/1/1980 (Gregorian calendar date).

Gets or sets the end date when calendar range selection is enabled.

C#
public DateTime RangeSelectionEndDate { get; set; }
Property Value:

The end date when calendar range selection is enabled.

Gets or sets the RadCalendar range selection mode. Default value is None.

C#
public RangeSelectionMode RangeSelectionMode { get; set; }
MemberDescription
NoneDoes not allow range selection.
OnKeyHoldAllow range selection by pressing [Shift] key and clicking on the date.
NoneAllow range selection by clicking consecutively two dates.

Gets or sets the start date when calendar range selection is enabled.

C#
public DateTime RangeSelectionStartDate { get; set; }
Property Value:

The start date when calendar range selection is enabled.

Gets or sets the image displayed for the row header element.

C#
public string RowHeaderImage { get; set; }
Property Value:

The image displayed for the CalendarView row header element. The default value is "".

This property applies only if the ShowRowHeaders property is set to true. If RowHeaderText is set too, its value is set as an alternative text to the image of the row header.

When using this property, the whole image URL is generated using also the ImagesBaseDir value.

Example:
ShowRowHeaders = "true"
ImagesBaseDir = "Img/"
RowHeaderImage = "selector.gif"
complete image URL : "Img/selector.gif"

Gets or sets the text displayed for the row header element.

C#
[Bindable(false)]
public string RowHeaderText { get; set; }
Property Value:

The text displayed for the CalendarView header element. The default value is "".

Use the RowHeaderText property to provide custom text for the CalendarView complete row header element.

This property does not automatically encode to HTML. You need to convert special characters to the appropriate HTML value, unless you want the characters to be treated as HTML. For example, to explicitly display the greater than symbol (>), you must use the value &gt;.

Because this property does not automatically encode to HTML, it is possible to specify an HTML tag for the RowHeaderText property. For example, if you want to display an image for the next month navigation control, you can set this property to an expression that contains an <img> element.

This property applies only if the ShowRowsHeaders property is set to true.

Sets or returns the currently selected date. The default value is the value of System.DateTime.MinValue.

C#
public DateTime SelectedDate { get; set; }

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 EnableMultiSelect 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 EnableMultiSelect 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.

Gets a collection of RadDate objects (that encapsulate values of type System.DateTime) that represent the selected dates on the RadCalendar control.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public DateTimeCollection SelectedDates { get; }
Property Value:

A DateTimeCollection that contains a collection of RadDate objects (that encapsulate values of type System.DateTime) representing the selected dates on the RadCalendar control. The default value is an empty DateTimeCollection.

Use the SelectedDates collection to determine the currently selected dates on the RadCalendar control.

The SelectedDate property and the SelectedDates collection are closely related. When the EnableMultiSelect 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 EnableMultiSelect 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 RadDate objects (that encapsulate values of type System.DateTime).

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.

Gets the style properties for the selected dates.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle SelectedDayStyle { get; }
Property Value:

A TableItemStyle that contains the style properties for the selected dates.

Gets or sets whether the column headers will appear on the calendar.

C#
public bool ShowColumnHeaders { get; set; }

Gets or sets a value indicating whether a tooltips for day cells should be rendered.

C#
[ClientControlProperty]
public virtual bool ShowDayCellToolTips { get; set; }
Property Value:

The default value is true.

Setting this property to false will force Telerik RadCalendar to not render day cell tooltips

Gets or sets whether the fast navigation buttons in the title section will be displayed.

C#
public bool ShowFastNavigationButtons { get; set; }

Gets or sets whether the navigation buttons in the title section will be displayed.

C#
public bool ShowNavigationButtons { get; set; }

Gets or sets whether the month matrix, when rendered will show days from other (previous or next) months or will render only blank cells.

C#
[ClientControlProperty]
public bool ShowOtherMonthsDays { get; set; }

Gets or sets whether the row headers will appear on the calendar.

C#
public bool ShowRowHeaders { get; set; }

Gets or sets the the count of columns to be displayed by a single CalendarView.

C#
[ClientControlProperty]
public int SingleViewColumns { get; set; }

If the calendar represents a multi view, this property applies to the child views inside the multi view.

Gets or sets the Height applied to a single CalendarView.

C#
public Unit SingleViewHeight { get; set; }

If the calendar represents a multi view, this property applies to the child views inside the multi view.

Gets or sets the the count of rows to be displayed by a single CalendarView.

C#
[ClientControlProperty]
public int SingleViewRows { get; set; }

If the calendar represents a multi view, this property applies to the child views inside the multi view.

Gets or sets the Width applied to a single CalendarView.

C#
public Unit SingleViewWidth { get; set; }

If the calendar represents a multi view, this property applies to the child views inside the multi view.

Gets or sets the name of the skin used. All skins reside in the location set by the SkinsPath Property.

C#
public override string Skin { get; set; }

Overrides: RadWebControl.Skin

For additional information please refer to the Visual Settings topic in this manual.

A collection of special days in the calendar to which may be applied specific formatting.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public CalendarDayCollection SpecialDays { get; }
C#
protected override bool SupportsRenderingMode { get; }

Overrides: RadWebControl.SupportsRenderingMode

Gets or sets the horizontal alignment of the calendar title.

The HorizontalAlign enumeration is defined in System.Web.UI.WebControls

C#
public HorizontalAlign TitleAlign { get; set; }

Member name

Description

Center

The contents of a container are centered.
JustifyThe contents of a container are uniformly spread out and aligned with both the left and right margins.
LeftThe contents of a container are left justified.
NotSetThe horizontal alignment is not set.
RightThe contents of a container are right justified.

Gets or sets the format string that is applied to the calendar title.

C#
[ClientControlProperty]
public string TitleFormat { get; set; }

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.

Gets the style properties of the title heading for the Calendar control.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle TitleStyle { get; }
Property Value:

A TableItemStyle that contains the style properties of the title heading for the Calendar.

When the ShowColumnHeaders and/or ShowRowHeaders properties are set to true, the UseColumnHeadersAsSelectors property specifies whether to use the days of the week, which overrides the used text/image header if any.

C#
[ClientControlProperty]
public virtual bool UseColumnHeadersAsSelectors { get; set; }

When the ShowColumnHeaders and/or ShowRowHeaders properties are set to true, the UseRowHeadersAsSelectors property specifies whether to use the number of the week, which overrides the used text/image selector if any.

C#
[ClientControlProperty]
public virtual bool UseRowHeadersAsSelectors { get; set; }

Gets or sets the image displayed for the complete CalendarView selection element in the view selector cell.

C#
[Bindable(false)]
public string ViewSelectorImage { get; set; }
Property Value:

The image displayed for the CalendarView selection element in the selector cell. The default value is "".

When using this property, the whole image URL is generated using also the ImagesBaseDir value.

Example:
ImagesBaseDir = "Img/"
ViewSelectorImage = "selector.gif"
complete image URL : "Img/selector.gif"

Gets the style properties for the view selector cell.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle ViewSelectorStyle { get; }
Property Value:

A TableItemStyle that contains the style properties for the view selector cell.

Gets or sets the text displayed for the complete CalendarView selection element in the view selector cell.

C#
[Bindable(false)]
public string ViewSelectorText { get; set; }
Property Value:

The text displayed for the CalendarView selection element in the selector cell. The default value is "".

Use the ViewSelectorText property to provide custom text for the CalendarView complete selection element in the selector cell.

This property does not automatically encode to HTML. You need to convert special characters to the appropriate HTML value, unless you want the characters to be treated as HTML. For example, to explicitly display the greater than symbol (>), you must use the value &gt;.

Because this property does not automatically encode to HTML, it is possible to specify an HTML tag for the ViewSelectorText property. For example, if you want to display an image for the next month navigation control, you can set this property to an expression that contains an <img> element.

This property applies only if the EnableViewSelector property is set to true.

Gets or sets the visibility of the control.

C#
public override bool Visible { get; set; }
Property Value:

The visibility of the control.

Overrides: RadWebControl.Visible

Gets the style properties for the weekend dates on the Calendar control.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle WeekendDayStyle { get; }
Property Value:

A TableItemStyle that contains the style properties for the weekend dates on the Calendar.

Methods

Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason

C#
protected override void ControlPreRender()

Overrides: RadWebControl.ControlPreRender()

Create controls from template, fill ContentPanes and add them to Controls collection.

C#
protected override void CreateChildControls()

Overrides: Control.CreateChildControls()

C#
protected override IRenderer CreateControlRenderer()
Returns:

IRenderer

Overrides: RadWebControl.CreateControlRenderer()

C#
protected override void DescribeClientEvents(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientEvents(IScriptDescriptor)

C#
protected override void DescribeClientProperties(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientProperties(IScriptDescriptor)

C#
protected override void DescribeComponent(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

When using templates, their content is instantiated and "lives" inside the Controls collection of RadCalendar class. To access the controls instantiated from the templates they must be found using this method (RadCalendar implements INamingContainer interface).

C#
public override Control FindControl(string id)
Parameters:idstring

The ID of the searched control.

Returns:

Control

Reference to the found control or null if no control was found.

Overrides: Control.FindControl(string)

C#
protected string GetImage(string fileName)
Parameters:fileNamestringReturns:

string

Executed when post data is loaded from the request

C#
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)
Parameters:postDataKeystringpostCollectionNameValueCollectionReturns:

bool

Overrides: RadWebControl.LoadPostData(string, NameValueCollection)

Restores view-state information from a previous page request that was saved by the SaveViewState() method.

C#
protected override void LoadViewState(object savedState)
Parameters:savedStateobject

The saved view state.

Overrides: PropertiesControl.LoadViewState(object)

C#
protected virtual void NavigateWithStep(int navigationStep)
Parameters:navigationStepint
C#
protected virtual void OnChildViewRender(CalendarView calView)
Parameters:calViewCalendarView
C#
protected virtual void OnDayRender(TableCell cell, RadCalendarDay day, MonthView currentView)
Parameters:cellTableCelldayRadCalendarDaycurrentViewMonthView
C#
protected virtual void OnDefaultViewChanged(DateTime newDate, DateTime previousDate)
Parameters:newDateDateTimepreviousDateDateTime
C#
protected virtual void OnHeaderCellRender(TableCell cell, HeaderType type)
Parameters:cellTableCelltypeHeaderType
C#
protected virtual void OnSelectionChanged()
C#
protected virtual void RaisePostBackEvent(string eventArgument)
Parameters:eventArgumentstring
C#
protected override void Render(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.Render(HtmlTextWriter)

C#
protected void RenderDefaultView(TableCell inputCell)
Parameters:inputCellTableCell

This method supports the Telerik RadCalendar infrastructure and is not intended to be used directly from your code.

C#
public void ResetTemplates()

Saves any server control view-state changes that have occurred since the time the page was posted back to the server.

C#
protected override object SaveViewState()
Returns:

object

The saved view state.

Overrides: PropertiesControl.SaveViewState()

C#
protected override void TrackViewState()

Overrides: PropertiesControl.TrackViewState()

Events

The ChildViewRender event is fired before the matrix for a child calendar view has been rendered/created.

C#
public event EventHandler<ChildViewRenderEventArgs> ChildViewRender

DayRender event is fired after the generation of every calendar cell object and just before it gets rendered to the client. It is the last place where changes to the already constructed calendar cells can be made.

C#
public event DayRenderEventHandler DayRender

DefaultViewChanged event is fired a a navigation to a different date range occurred. Generally this is done by using the normal navigation buttons or the fast date navigation popup that allows "jumping" to a specified date.

C#
public event DefaultViewChangedEventHandler DefaultViewChanged

HeadeCellRender event is fired after the generation of every calendar header cell object and just before it gets rendered to the client. It is the preferred place where changes to the constructed calendar header cells can be made.

C#
public event HeaderCellRenderEventHandler HeaderCellRender

SelectionChanged event is fired when a new date is added or removed from the SelectedDates collection.

C#
public event SelectedDatesEventHandler SelectionChanged
In this article
DefinitionConstructorsRadCalendar()PropertiesAutoPostBackCalendarCalendarCaptionCalendarDayTemplatesCalendarSummaryCalendarTableStyleCalendarViewCellAlignCellDayFormatCellVAlignClientEventsColumnHeaderImageColumnHeaderTextCssClassCssFileCultureCultureInfoDateRangeSeparatorDateTimeFormatDayCellToolTipFormatDayNameFormatDayOverStyleDayStyleDaysViewSummaryDefaultCellPaddingDefaultCellSpacingDisabledDayStyleEmptySkinEnableAriaSupportEnableKeyboardNavigationEnableMonthYearFastNavigationEnableMultiSelectEnableNavigationEnableNavigationAnimationEnableRepeatableDaysOnClientEnableShadowsEnableViewSelectorEnableWeekendsFastNavigationNextImageFastNavigationNextTextFastNavigationNextToolTipFastNavigationPrevImageFastNavigationPrevTextFastNavigationPrevToolTipFastNavigationSettingsFastNavigationStepFastNavigationStyleFirstDayOfWeekFocusedDateFocusedDateColumnFocusedDateRowFooterTemplateHeaderStyleHeaderTemplateHideNavigationControlsImagesPathKeyboardNavigationSettingsLocalizationPathMonthLayoutMultiViewColumnsMultiViewRowsNavigationCaptionNavigationCellPaddingNavigationCellSpacingNavigationNextImageNavigationNextTextNavigationNextToolTipNavigationPrevImageNavigationPrevTextNavigationPrevToolTipNavigationSummaryOrientationOtherMonthDayStyleOutOfRangeDayStyleOverlayPresentationTypeRangeMaxDateRangeMinDateRangeSelectionEndDateRangeSelectionModeRangeSelectionStartDateRowHeaderImageRowHeaderTextSelectedDateSelectedDatesSelectedDayStyleShowColumnHeadersShowDayCellToolTipsShowFastNavigationButtonsShowNavigationButtonsShowOtherMonthsDaysShowRowHeadersSingleViewColumnsSingleViewHeightSingleViewRowsSingleViewWidthSkinSpecialDaysSupportsRenderingModeTitleAlignTitleFormatTitleStyleUseColumnHeadersAsSelectorsUseRowHeadersAsSelectorsViewSelectorImageViewSelectorStyleViewSelectorTextVisibleWeekendDayStyleMethodsControlPreRender()CreateChildControls()CreateControlRenderer()DescribeClientEvents(IScriptDescriptor)DescribeClientProperties(IScriptDescriptor)DescribeComponent(IScriptDescriptor)FindControl(string)GetImage(string)LoadPostData(string, NameValueCollection)LoadViewState(object)NavigateWithStep(int)OnChildViewRender(CalendarView)OnDayRender(TableCell, RadCalendarDay, MonthView)OnDefaultViewChanged(DateTime, DateTime)OnHeaderCellRender(TableCell, HeaderType)OnSelectionChanged()RaisePostBackEvent(string)Render(HtmlTextWriter)RenderDefaultView(TableCell)ResetTemplates()SaveViewState()TrackViewState()EventsChildViewRenderDayRenderDefaultViewChangedHeaderCellRenderSelectionChanged
Not finding the help you need?
Contact Support