Class
RadCalendar

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:

cs-api-definition
[TelerikToolboxCategory("Editors")]
public class RadCalendar : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadCalendar

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIDisposableIDropTargetILayoutHandlerINotifyPropertyChangedISupportInitializeISupportInitializeNotificationISynchronizeInvokeIWin32Window

Inherited Members RadControl.isResizing2RadControl.isDisposing2RadControl.invalidResizeRectRadControl.isAccessibilityRequestedRadControl.Dispose(bool)RadControl.Construct()RadControl.CreateBehavior()RadControl.CreateRootElement()RadControl.InitializeRootElement(RootRadElement)RadControl.LoadElementTree()RadControl.LoadElementTree(Size)RadControl.SetBackColorThemeOverrides()RadControl.ResetBackColorThemeOverrides()RadControl.SetForeColorThemeOverrides()RadControl.ResetForeColorThemeOverrides()RadControl.OnKeyDown(KeyEventArgs)RadControl.OnKeyUp(KeyEventArgs)RadControl.OnPreviewKeyDown(PreviewKeyDownEventArgs)RadControl.OnKeyPress(KeyPressEventArgs)RadControl.OnClick(EventArgs)RadControl.OnDoubleClick(EventArgs)RadControl.OnMouseDown(MouseEventArgs)RadControl.OnMouseUp(MouseEventArgs)RadControl.OnMouseEnter(EventArgs)RadControl.OnMouseLeave(EventArgs)RadControl.OnMouseMove(MouseEventArgs)RadControl.OnMouseHover(EventArgs)RadControl.OnMouseWheel(MouseEventArgs)RadControl.OnMouseCaptureChanged(EventArgs)RadControl.OnGotFocus(EventArgs)RadControl.OnLostFocus(EventArgs)RadControl.OnCreateControl()RadControl.OnHandleDestroyed(EventArgs)RadControl.OnParentChanged(EventArgs)RadControl.OnVisibleChanged(EventArgs)RadControl.OnFontChanged(EventArgs)RadControl.OnForeColorChanged(EventArgs)RadControl.OnBackColorChanged(EventArgs)RadControl.OnEnabledChanged(EventArgs)RadControl.OnBindingContextChanged(EventArgs)RadControl.OnLocationChanged(EventArgs)RadControl.OnPaddingChanged(EventArgs)RadControl.OnPaint(PaintEventArgs)RadControl.OnLayout(LayoutEventArgs)RadControl.OnAutoSizeChanged(EventArgs)RadControl.WndProc(ref Message)RadControl.OnInvalidated(RadElement)RadControl.OnCaptureLosing()RadControl.OnThemeChanged()RadControl.OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)RadControl.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)RadControl.OnThemeNameChanged(ThemeNameChangedEventArgs)RadControl.ProcessMnemonic(char)RadControl.ProcessFocusRequested(RadElement)RadControl.ProcessCaptureChangeRequested(RadElement, bool)RadControl.ProcessAutoSizeChanged(bool)RadControl.IsInputKey(Keys)RadControl.GetInputElement()RadControl.BeginInit()RadControl.EndInit()RadControl.OnNotifyPropertyChanged(string)RadControl.GetPreferredSize(Size)RadControl.SetBoundsCore(int, int, int, int, BoundsSpecified)RadControl.GetRootElementDesiredSize(int, int, int, int)RadControl.OnZoomGesture(ZoomGestureEventArgs)RadControl.OnRotateGesture(RotateGestureEventArgs)RadControl.OnPanGesture(PanGestureEventArgs)RadControl.OnTwoFingerTapGesture(GestureEventArgs)RadControl.OnPressAndTapGesture(PressAndTapGestureEventArgs)RadControl.OnGesture(GestureEventArgs)RadControl.ProcessGesture(Message)RadControl.EnableGesture(GestureType)RadControl.DisableGesture(GestureType)RadControl.Refresh()RadControl.SuspendUpdate()RadControl.ResumeUpdate()RadControl.ResumeUpdate(bool)RadControl.InvokeLayoutCallback(LayoutCallback)RadControl.RegisterHostedControl(RadHostItem)RadControl.UnregisterHostedControl(RadHostItem, bool)RadControl.ResolveStyleGroupForElement(StyleGroup, RadObject)RadControl.GetPlainText()RadControl.ShouldSerializeProperty(RadProperty)RadControl.ShouldSerializeProperty(RadProperty, RadObject)RadControl.ResetProperty(RadProperty, RadObject)RadControl.CanEditElementAtDesignTime(RadElement)RadControl.ProcessCodedUIMessage(ref IPCMessage)RadControl.FindPropertyInChildren(RadControl, IPCMessage)RadControl.PerformRadAutoScale(BoundsSpecified?)RadControl.GetMonitorDpiScaleFactor(Control)RadControl.SetRadAutoScale(bool)RadControl.EnableDpiScalingRadControl.EnableRadAutoScaleRadControl.EnableRadFormInitialDpiScalingRadControl.EnableImageDpiScalingRadControl.EnableSvgImagesRadControl.IsLoadedRadControl.ElementTreeRadControl.UseCompatibleTextRenderingDefaultValueRadControl.BehaviorRadControl.RootElementRadControl.PaddingRadControl.ThemeNameRadControl.TextRadControl.EnableThemingRadControl.ThemeClassNameRadControl.ImageListRadControl.ImageScalingSizeRadControl.UseCompatibleTextRenderingRadControl.AutoSizeRadControl.MaximumSizeRadControl.MinimumSizeRadControl.FocusableRadControl.SiteRadControl.CausesValidationRadControl.IsInitializingRadControl.SmallImageListRadControl.SmallImageScalingSizeRadControl.IsDesignModeRadControl.IsDisplayedRadControl.FocusedElementRadControl.AllowShowFocusCuesRadControl.ShowItemToolTipsRadControl.CommandBindingsRadControl.EnableKeyMapRadControl.BackColorRadControl.ForeColorRadControl.ValidationCancelRadControl.EnableAnalyticsRadControl.AnalyticsNameRadControl.EnableRadAccessibilityObjectsRadControl.EnableCodedUITestsRadControl.EnableCodedUITestsDefaultValueRadControl.EnableUIAutomationRadControl.EnableUIAutomationDefaultValueRadControl.ElementInvalidatedRadControl.ToolTipTextNeededRadControl.ScreenTipNeededRadControl.ThemeNameChangedRadControl.InitializedRadControl.PropertyChangedRadControl.ZoomGestureRadControl.RotateGestureRadControl.PanGestureRadControl.TwoFingerTapGestureRadControl.PressAndTapGestureScrollableControl.ScrollStateAutoScrollingScrollableControl.ScrollStateHScrollVisibleScrollableControl.ScrollStateVScrollVisibleScrollableControl.ScrollStateUserHasScrolledScrollableControl.ScrollStateFullDragScrollableControl.AdjustFormScrollbars(bool)ScrollableControl.GetScrollState(int)ScrollableControl.OnPaintBackground(PaintEventArgs)ScrollableControl.SetDisplayRectLocation(int, int)ScrollableControl.ScrollControlIntoView(Control)ScrollableControl.ScrollToControl(Control)ScrollableControl.OnScroll(ScrollEventArgs)ScrollableControl.SetAutoScrollMargin(int, int)ScrollableControl.SetScrollState(int, bool)ScrollableControl.AutoScrollScrollableControl.AutoScrollMarginScrollableControl.AutoScrollPositionScrollableControl.AutoScrollMinSizeScrollableControl.CreateParamsScrollableControl.DisplayRectangleScrollableControl.HScrollScrollableControl.HorizontalScrollScrollableControl.VScrollScrollableControl.VerticalScrollScrollableControl.ScrollControl.GetAccessibilityObjectById(int)Control.SetAutoSizeMode(AutoSizeMode)Control.GetAutoSizeMode()Control.AccessibilityNotifyClients(AccessibleEvents, int)Control.AccessibilityNotifyClients(AccessibleEvents, int, int)Control.BeginInvoke(Delegate)Control.BeginInvoke(Delegate, params object[])Control.BringToFront()Control.Contains(Control)Control.CreateControlsInstance()Control.CreateGraphics()Control.CreateHandle()Control.CreateControl()Control.DefWndProc(ref Message)Control.DestroyHandle()Control.DoDragDrop(object, DragDropEffects)Control.DrawToBitmap(Bitmap, Rectangle)Control.EndInvoke(IAsyncResult)Control.FindForm()Control.GetTopLevel()Control.RaiseKeyEvent(object, KeyEventArgs)Control.RaiseMouseEvent(object, MouseEventArgs)Control.Focus()Control.FromChildHandle(IntPtr)Control.FromHandle(IntPtr)Control.GetChildAtPoint(Point, GetChildAtPointSkip)Control.GetChildAtPoint(Point)Control.GetContainerControl()Control.GetScaledBounds(Rectangle, SizeF, BoundsSpecified)Control.GetNextControl(Control, bool)Control.GetStyle(ControlStyles)Control.Hide()Control.InitLayout()Control.Invalidate(Region)Control.Invalidate(Region, bool)Control.Invalidate()Control.Invalidate(bool)Control.Invalidate(Rectangle)Control.Invalidate(Rectangle, bool)Control.Invoke(Delegate)Control.Invoke(Delegate, params object[])Control.InvokePaint(Control, PaintEventArgs)Control.InvokePaintBackground(Control, PaintEventArgs)Control.IsKeyLocked(Keys)Control.IsInputChar(char)Control.IsMnemonic(char, string)Control.LogicalToDeviceUnits(int)Control.LogicalToDeviceUnits(Size)Control.ScaleBitmapLogicalToDevice(ref Bitmap)Control.NotifyInvalidate(Rectangle)Control.InvokeOnClick(Control, EventArgs)Control.OnBackgroundImageChanged(EventArgs)Control.OnBackgroundImageLayoutChanged(EventArgs)Control.OnCausesValidationChanged(EventArgs)Control.OnContextMenuChanged(EventArgs)Control.OnContextMenuStripChanged(EventArgs)Control.OnCursorChanged(EventArgs)Control.OnDockChanged(EventArgs)Control.OnNotifyMessage(Message)Control.OnParentBackColorChanged(EventArgs)Control.OnParentBackgroundImageChanged(EventArgs)Control.OnParentBindingContextChanged(EventArgs)Control.OnParentCursorChanged(EventArgs)Control.OnParentEnabledChanged(EventArgs)Control.OnParentFontChanged(EventArgs)Control.OnParentForeColorChanged(EventArgs)Control.OnParentRightToLeftChanged(EventArgs)Control.OnParentVisibleChanged(EventArgs)Control.OnPrint(PaintEventArgs)Control.OnTabIndexChanged(EventArgs)Control.OnTabStopChanged(EventArgs)Control.OnTextChanged(EventArgs)Control.OnClientSizeChanged(EventArgs)Control.OnControlAdded(ControlEventArgs)Control.OnControlRemoved(ControlEventArgs)Control.OnHandleCreated(EventArgs)Control.OnDragEnter(DragEventArgs)Control.OnDragOver(DragEventArgs)Control.OnDragLeave(EventArgs)Control.OnDragDrop(DragEventArgs)Control.OnGiveFeedback(GiveFeedbackEventArgs)Control.OnEnter(EventArgs)Control.InvokeGotFocus(Control, EventArgs)Control.OnHelpRequested(HelpEventArgs)Control.OnInvalidated(InvalidateEventArgs)Control.OnLeave(EventArgs)Control.InvokeLostFocus(Control, EventArgs)Control.OnMarginChanged(EventArgs)Control.OnMouseDoubleClick(MouseEventArgs)Control.OnMouseClick(MouseEventArgs)Control.OnDpiChangedBeforeParent(EventArgs)Control.OnDpiChangedAfterParent(EventArgs)Control.OnMove(EventArgs)Control.OnQueryContinueDrag(QueryContinueDragEventArgs)Control.OnRegionChanged(EventArgs)Control.OnResize(EventArgs)Control.OnSizeChanged(EventArgs)Control.OnChangeUICues(UICuesEventArgs)Control.OnStyleChanged(EventArgs)Control.OnSystemColorsChanged(EventArgs)Control.OnValidating(CancelEventArgs)Control.OnValidated(EventArgs)Control.RescaleConstantsForDpi(int, int)Control.PerformLayout()Control.PerformLayout(Control, string)Control.PointToClient(Point)Control.PointToScreen(Point)Control.PreProcessMessage(ref Message)Control.PreProcessControlMessage(ref Message)Control.ProcessDialogChar(char)Control.ProcessDialogKey(Keys)Control.ProcessKeyEventArgs(ref Message)Control.ProcessKeyMessage(ref Message)Control.ProcessKeyPreview(ref Message)Control.RaiseDragEvent(object, DragEventArgs)Control.RaisePaintEvent(object, PaintEventArgs)Control.RecreateHandle()Control.RectangleToClient(Rectangle)Control.RectangleToScreen(Rectangle)Control.ReflectMessage(IntPtr, ref Message)Control.ResetMouseEventArgs()Control.ResetText()Control.ResumeLayout()Control.ResumeLayout(bool)Control.Scale(SizeF)Control.Select()Control.Select(bool, bool)Control.SelectNextControl(Control, bool, bool, bool, bool)Control.SendToBack()Control.SetBounds(int, int, int, int)Control.SetBounds(int, int, int, int, BoundsSpecified)Control.SetClientSizeCore(int, int)Control.SizeFromClientSize(Size)Control.SetStyle(ControlStyles, bool)Control.SetTopLevel(bool)Control.SetVisibleCore(bool)Control.RtlTranslateAlignment(HorizontalAlignment)Control.RtlTranslateAlignment(LeftRightAlignment)Control.RtlTranslateAlignment(ContentAlignment)Control.RtlTranslateHorizontal(HorizontalAlignment)Control.RtlTranslateLeftRight(LeftRightAlignment)Control.RtlTranslateContent(ContentAlignment)Control.Show()Control.SuspendLayout()Control.Update()Control.UpdateBounds()Control.UpdateBounds(int, int, int, int)Control.UpdateBounds(int, int, int, int, int, int)Control.UpdateZOrder()Control.UpdateStyles()Control.OnImeModeChanged(EventArgs)Control.AccessibilityObjectControl.AccessibleDefaultActionDescriptionControl.AccessibleDescriptionControl.AccessibleNameControl.AccessibleRoleControl.AllowDropControl.AnchorControl.AutoScrollOffsetControl.LayoutEngineControl.BackgroundImageControl.BackgroundImageLayoutControl.BindingContextControl.BottomControl.BoundsControl.CanFocusControl.CanRaiseEventsControl.CanSelectControl.CaptureControl.CheckForIllegalCrossThreadCallsControl.ClientRectangleControl.ClientSizeControl.CompanyNameControl.ContainsFocusControl.ContextMenuControl.ContextMenuStripControl.ControlsControl.CreatedControl.CursorControl.DataBindingsControl.DefaultBackColorControl.DefaultCursorControl.DefaultFontControl.DefaultForeColorControl.DefaultMarginControl.DefaultMaximumSizeControl.DefaultMinimumSizeControl.DefaultPaddingControl.DeviceDpiControl.IsDisposedControl.DisposingControl.DockControl.DoubleBufferedControl.EnabledControl.FocusedControl.FontHeightControl.HandleControl.HasChildrenControl.HeightControl.IsHandleCreatedControl.InvokeRequiredControl.IsAccessibleControl.IsMirroredControl.LeftControl.LocationControl.MarginControl.ModifierKeysControl.MouseButtonsControl.MousePositionControl.NameControl.ParentControl.ProductNameControl.ProductVersionControl.RecreatingHandleControl.RegionControl.RenderRightToLeftControl.ResizeRedrawControl.RightControl.RightToLeftControl.ScaleChildrenControl.SizeControl.TabIndexControl.TabStopControl.TagControl.TopControl.TopLevelControlControl.ShowKeyboardCuesControl.ShowFocusCuesControl.UseWaitCursorControl.VisibleControl.WidthControl.PreferredSizeControl.CanEnableImeControl.DefaultImeModeControl.ImeModeControl.ImeModeBaseControl.PropagatingImeModeControl.BackColorChangedControl.BackgroundImageChangedControl.BackgroundImageLayoutChangedControl.BindingContextChangedControl.CausesValidationChangedControl.ClientSizeChangedControl.ContextMenuChangedControl.ContextMenuStripChangedControl.CursorChangedControl.DockChangedControl.EnabledChangedControl.FontChangedControl.ForeColorChangedControl.LocationChangedControl.MarginChangedControl.RegionChangedControl.RightToLeftChangedControl.SizeChangedControl.TabIndexChangedControl.TabStopChangedControl.TextChangedControl.VisibleChangedControl.ClickControl.ControlAddedControl.ControlRemovedControl.DragDropControl.DragEnterControl.DragOverControl.DragLeaveControl.GiveFeedbackControl.HandleCreatedControl.HandleDestroyedControl.HelpRequestedControl.InvalidatedControl.PaddingChangedControl.PaintControl.QueryContinueDragControl.QueryAccessibilityHelpControl.DoubleClickControl.EnterControl.GotFocusControl.KeyDownControl.KeyPressControl.KeyUpControl.LayoutControl.LeaveControl.LostFocusControl.MouseClickControl.MouseDoubleClickControl.MouseCaptureChangedControl.MouseDownControl.MouseEnterControl.MouseLeaveControl.DpiChangedBeforeParentControl.DpiChangedAfterParentControl.MouseHoverControl.MouseMoveControl.MouseUpControl.MouseWheelControl.MoveControl.PreviewKeyDownControl.ResizeControl.ChangeUICuesControl.StyleChangedControl.SystemColorsChangedControl.ValidatingControl.ValidatedControl.ParentChangedControl.ImeModeChangedComponent.Dispose()Component.GetService(Type)Component.ToString()Component.EventsComponent.ContainerComponent.DesignModeComponent.DisposedMarshalByRefObject.MemberwiseClone(bool)MarshalByRefObject.GetLifetimeService()MarshalByRefObject.InitializeLifetimeService()MarshalByRefObject.CreateObjRef(Type)

Constructors

RadCalendar()

Initializes a new instance of the RadCalendar class.

Declaration

cs-api-definition
public RadCalendar()

Properties

AllowColumnHeaderSelectors

Gets or sets whether column headers ( if displayed by a MonthView object) will act as column selectors.

Declaration

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

Property Value

bool

AllowFastNavigation

Gets or sets whether the fast navigation in RadCalendar is allowed.

Declaration

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

Property Value

bool

AllowFishEye

Gets or sets whether the zooming functionality is enabled.

Declaration

cs-api-definition
public virtual bool AllowFishEye { get; set; }

Property Value

bool

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

cs-api-definition
[Bindable(false)]
public bool AllowMultipleSelect { get; set; }

Property Value

bool

AllowMultipleView

Allows RadCalendar to render multiple months in a single view.

Declaration

cs-api-definition
[Bindable(false)]
public bool AllowMultipleView { get; set; }

Property Value

bool

AllowNavigation

Gets or sets whether navigating RadCalendar is allowed.

Declaration

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

Property Value

bool

AllowRowHeaderSelectors

Gets or sets whether row headers ( if displayed by a MonthView object) will act as row selectors.

Declaration

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

Property Value

bool

AllowSelect

Allows the selection of dates. If not set, selection is forbidden, and if any dates are all ready selected, they are cleared.

Declaration

cs-api-definition
[Bindable(false)]
public bool AllowSelect { get; set; }

Property Value

bool

AllowViewSelector

Gets or sets whether the view selector will be allowed to select all dates presented by the CalendarView.

Declaration

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

Property Value

bool

CalendarElement

Gets the main RadCalendarElement that encapsulates the core functionality of the calendar control.

Declaration

cs-api-definition
[Browsable(false)]
public RadCalendarElement CalendarElement { get; }

Property Value

RadCalendarElement

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

cs-api-definition
public ContentAlignment CellAlign { get; set; }

Property Value

ContentAlignment

Remarks

Member name

Description

Center

The contents of a container are centered.
LeftThe contents of a container are left justified.
RightThe contents of a container are right justified.

CellHorizontalSpacing

Gets or sets the horizontal spacing between the calendar cells.

Declaration

cs-api-definition
public int CellHorizontalSpacing { get; set; }

Property Value

int

CellMargin

Gets or sets the margin of the calendar cells.

Declaration

cs-api-definition
public Padding CellMargin { get; set; }

Property Value

Padding

CellPadding

Gets or sets the padding of the calendar cells.

Declaration

cs-api-definition
public Padding CellPadding { get; set; }

Property Value

Padding

CellToolTipFormat

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

Declaration

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

Property Value

string

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.

Declaration

cs-api-definition
public int CellVerticalSpacing { get; set; }

Property Value

int

ClearButton

Gets the clear button of the footer element

Declaration

cs-api-definition
public RadButtonElement ClearButton { get; }

Property Value

RadButtonElement

ColumnHeaderImage

Gets or sets the image displayed for all column header elements.

Declaration

cs-api-definition
[Bindable(false)]
public Image ColumnHeaderImage { get; set; }

Property Value

Image

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

cs-api-definition
[Bindable(false)]
public string ColumnHeaderText { get; set; }

Property Value

string

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

cs-api-definition
public int Columns { get; set; }

Property Value

int

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

cs-api-definition
[TypeConverter(typeof(CultureInfoConverter))]
public CultureInfo Culture { get; set; }

Property Value

CultureInfo

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 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 (Bokmål) - 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

CurrentCalendar

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

Declaration

cs-api-definition
[Browsable(false)]
public Calendar CurrentCalendar { get; }

Property Value

Calendar

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

cs-api-definition
public int CurrentViewColumn { get; set; }

Property Value

int

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

cs-api-definition
public int CurrentViewRow { get; set; }

Property Value

int

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.

Declaration

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

Property Value

string

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

cs-api-definition
[Browsable(false)]
public DateTimeFormatInfo DateTimeFormat { get; }

Property Value

DateTimeFormatInfo

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

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

Property Value

string

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

cs-api-definition
public DayNameFormat DayNameFormat { get; set; }

Property Value

DayNameFormat

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 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.
ShortestThe shortest unique abbreviated day names associated with the current DateTimeFormatInfo object.

DefaultSize

Gets the default size of the calendar control.

Declaration

cs-api-definition
protected override Size DefaultSize { get; }

Property Value

Size

A Size representing the default dimensions (257x227 pixels).

Overrides Control.DefaultSize

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

cs-api-definition
[Browsable(false)]
public CalendarView DefaultView { get; }

Property Value

CalendarView

FastNavigationNextImage

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

Declaration

cs-api-definition
public Image FastNavigationNextImage { get; set; }

Property Value

Image

FastNavigationNextText

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

Declaration

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

Property Value

string

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

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

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

Property Value

string

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

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

cs-api-definition
public Image FastNavigationPrevImage { get; set; }

Property Value

Image

FastNavigationPrevText

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

Declaration

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

Property Value

string

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

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

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

Property Value

string

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

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.

Declaration

cs-api-definition
public int FastNavigationStep { get; set; }

Property Value

int

FirstDayOfWeek

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

Declaration

cs-api-definition
public FirstDayOfWeek FirstDayOfWeek { get; set; }

Property Value

FirstDayOfWeek

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

FocusedDate

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

Declaration

cs-api-definition
public DateTime FocusedDate { get; set; }

Property Value

DateTime

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.

Font

Declaration

cs-api-definition
[Browsable(false)]
public Font Font { get; set; }

Property Value

Font

HeaderHeight

The Height applied to a Header

Declaration

cs-api-definition
public int HeaderHeight { get; set; }

Property Value

int

HeaderNavigationMode

Gets or sets the navigation mode used when the user clicks on the calendar header element.

Declaration

cs-api-definition
public HeaderNavigationMode HeaderNavigationMode { get; set; }

Property Value

HeaderNavigationMode

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

Declaration

cs-api-definition
public int HeaderWidth { get; set; }

Property Value

int

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

cs-api-definition
public MonthLayout MonthLayout { get; set; }

Property Value

MonthLayout

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.

Declaration

cs-api-definition
public int MultiViewColumns { get; set; }

Property Value

int

MultiViewRows

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

Declaration

cs-api-definition
public int MultiViewRows { get; set; }

Property Value

int

NavigationNextImage

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

Declaration

cs-api-definition
public Image NavigationNextImage { get; set; }

Property Value

Image

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

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

Property Value

string

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

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

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

Property Value

string

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

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.

Declaration

cs-api-definition
public Image NavigationPrevImage { get; set; }

Property Value

Image

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

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

Property Value

string

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

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

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

Property Value

string

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

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

cs-api-definition
public Orientation Orientation { get; set; }

Property Value

Orientation

Remarks

MemberDescription
HorizontalRenders the calendar data row after row.
VerticalRenders 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

cs-api-definition
public DateTime RangeMaxDate { get; set; }

Property Value

DateTime

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

cs-api-definition
public DateTime RangeMinDate { get; set; }

Property Value

DateTime

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.

Declaration

cs-api-definition
public virtual bool ReadOnly { get; set; }

Property Value

bool

RowHeaderImage

Gets or sets the image displayed for all row header elements.

Declaration

cs-api-definition
public Image RowHeaderImage { get; set; }

Property Value

Image

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

cs-api-definition
[Bindable(false)]
public string RowHeaderText { get; set; }

Property Value

string

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

cs-api-definition
public int Rows { get; set; }

Property Value

int

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

cs-api-definition
public DateTime SelectedDate { get; set; }

Property Value

DateTime

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

cs-api-definition
public DateTimeCollection SelectedDates { get; }

Property Value

DateTimeCollection

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.

Declaration

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

Property Value

bool

ShowFastNavigationButtons

Gets or sets whether the fast navigation buttons should be visible.

Declaration

cs-api-definition
public virtual bool ShowFastNavigationButtons { get; set; }

Property Value

bool

ShowFooter

Gets or sets whether RadCalendar will display a footer row.

Declaration

cs-api-definition
public virtual bool ShowFooter { get; set; }

Property Value

bool

ShowHeader

Gets or sets whether RadCalendar will display a header/navigation row.

Declaration

cs-api-definition
public virtual bool ShowHeader { get; set; }

Property Value

bool

ShowNavigationButtons

Gets or sets whether the navigation buttons should be visible.

Declaration

cs-api-definition
public virtual bool ShowNavigationButtons { get; set; }

Property Value

bool

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.

Declaration

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

Property Value

bool

ShowRowHeaders

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

Declaration

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

Property Value

bool

ShowViewHeader

Gets or sets whether a single CalendarView object will display a header .

Declaration

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

Property Value

bool

ShowViewSelector

Gets or sets whether a single CalendarView object will display a selector.

Declaration

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

Property Value

bool

SpecialDays

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

Declaration

cs-api-definition
public CalendarDayCollection SpecialDays { get; }

Property Value

CalendarDayCollection

TitleAlign

Gets or sets the horizontal alignment of the view title.

The ContentAlignment enumeration is defined in System.Windows.Forms.VisualStyles

Declaration

cs-api-definition
public ContentAlignment TitleAlign { get; set; }

Property Value

ContentAlignment

Remarks

Member name

Description

Center

The contents of a container are centered.
LeftThe contents of a container are left justified.
RightThe contents of a container are right justified.

TitleFormat

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

Declaration

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

Property Value

string

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

cs-api-definition
public RadButtonElement TodayButton { get; }

Property Value

RadButtonElement

ViewSelectorImage

Gets or sets the image displayed for the view selector element.

Declaration

cs-api-definition
[Bindable(false)]
public Image ViewSelectorImage { get; set; }

Property Value

Image

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

cs-api-definition
[Bindable(false)]
public string ViewSelectorText { get; set; }

Property Value

string

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.

Declaration

cs-api-definition
public virtual float ZoomFactor { get; set; }

Property Value

float

ZoomLevel

Gets or sets the zoom level of the calendar view.

Declaration

cs-api-definition
[Browsable(false)]
public ZoomLevel ZoomLevel { get; set; }

Property Value

ZoomLevel

Methods

ControlDefinesThemeForElement(RadElement)

Checks whether the element's theme is defined by the control.

Declaration

cs-api-definition
public override bool ControlDefinesThemeForElement(RadElement element)

Parameters

element

RadElement

The element to should be checked.

Returns

bool

true if the control defines theme for this element, false otherwise.

Overrides RadControl.ControlDefinesThemeForElement(RadElement)

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

cs-api-definition
protected override AccessibleObject CreateAccessibilityInstance()

Returns

AccessibleObject

Overrides Control.CreateAccessibilityInstance()

CreateChildItems(RadElement)

Declaration

cs-api-definition
protected override void CreateChildItems(RadElement parent)

Parameters

parent

RadElement

Overrides RadControl.CreateChildItems(RadElement)

EnsureDefaultView()

Ensures that a valid CalendarView object is instantiated and used by RadCalendar as default view.

Declaration

cs-api-definition
protected virtual CalendarView EnsureDefaultView()

Returns

CalendarView

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

cs-api-definition
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

cs-api-definition
protected virtual void OnElementRender(LightVisualElement cell, RadCalendarDay day, CalendarView view)

Parameters

cell

LightVisualElement

A LightVisualElement object that contains information about the cell to render.

day

RadCalendarDay

A RadCalendarDay that contains information about the day to render.

view

CalendarView

A CalendarView that contains the day to render.

OnLoad(Size)

Notifies that the control is about to be visualized.

Declaration

cs-api-definition
protected override void OnLoad(Size desiredSize)

Parameters

desiredSize

Size

Overrides RadControl.OnLoad(Size)

OnNavigated(CalendarNavigatedEventArgs)

Declaration

cs-api-definition
protected virtual void OnNavigated(CalendarNavigatedEventArgs args)

Parameters

args

CalendarNavigatedEventArgs

OnNavigating(CalendarNavigatingEventArgs)

Declaration

cs-api-definition
protected virtual void OnNavigating(CalendarNavigatingEventArgs args)

Parameters

args

CalendarNavigatingEventArgs

OnNotifyPropertyChanged(PropertyChangedEventArgs)

Declaration

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

Parameters

e

PropertyChangedEventArgs

Overrides RadControl.OnNotifyPropertyChanged(PropertyChangedEventArgs)

OnRightToLeftChanged(EventArgs)

Declaration

cs-api-definition
protected override void OnRightToLeftChanged(EventArgs e)

Parameters

e

EventArgs

Overrides RadControl.OnRightToLeftChanged(EventArgs)

OnSelectionChanged()

Raises the SelectionChanged event.

Declaration

cs-api-definition
protected virtual void OnSelectionChanged()

OnSelectionChanging(DateTimeCollection, List<DateTime>)

Raises the SelectionChanging event.

Declaration

cs-api-definition
protected virtual SelectionEventArgs OnSelectionChanging(DateTimeCollection dates, List<DateTime> newDates)

Parameters

dates

DateTimeCollection

A DateTimeCollection collection used by SelectionEventArgs.

newDates

List<DateTime>

A List with Dates which will be selected

Returns

SelectionEventArgs

SelectionEventArgs instance.

OnViewChanged()

Raises the ViewChanged event.

Declaration

cs-api-definition
protected virtual void OnViewChanged()

OnViewChanging(CalendarView)

Raises the ViewChanging event.

Declaration

cs-api-definition
protected virtual ViewChangingEventArgs OnViewChanging(CalendarView view)

Parameters

view

CalendarView

A CalendarView collection used by ViewChangingEventArgs.

Returns

ViewChangingEventArgs

ViewChangingEventArgs instance.

OnZoomChanged(CalendarZoomChangedEventArgs)

Declaration

cs-api-definition
protected virtual void OnZoomChanged(CalendarZoomChangedEventArgs args)

Parameters

args

CalendarZoomChangedEventArgs

OnZoomChanging(CalendarZoomChangingEventArgs)

Declaration

cs-api-definition
protected virtual void OnZoomChanging(CalendarZoomChangingEventArgs args)

Parameters

args

CalendarZoomChangingEventArgs

ProcessCmdKey(ref Message, Keys)

Declaration

cs-api-definition
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)

Parameters

msg

Message

keyData

Keys

Returns

bool

Overrides Control.ProcessCmdKey(ref Message, Keys)

RemoveFocusedDate(bool)

Remove focused date and change the current view to today

Declaration

cs-api-definition
public virtual void RemoveFocusedDate(bool removeAlsoSelectedDate)

Parameters

removeAlsoSelectedDate

bool

Indicates that all selected dates will be cleared as well.

ScaleControl(SizeF, BoundsSpecified)

Declaration

cs-api-definition
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)

Parameters

factor

SizeF

specified

BoundsSpecified

Overrides RadControl.ScaleControl(SizeF, BoundsSpecified)

TruncateTimeComponent(DateTime)

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

Declaration

cs-api-definition
protected static DateTime TruncateTimeComponent(DateTime date)

Parameters

date

DateTime

the DateTime object to be processed.

Returns

DateTime

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

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

cs-api-definition
public event RenderElementEventHandler ElementRender

Event Value

RenderElementEventHandler

Navigated

Occurs when the view is changed by the navigation elements.

Declaration

cs-api-definition
public event CalendarNavigatedEventHandler Navigated

Event Value

CalendarNavigatedEventHandler

Navigating

Occurs when the view is about to be changed by the navigation elements.

Declaration

cs-api-definition
public event CalendarNavigatingEventHandler Navigating

Event Value

CalendarNavigatingEventHandler

SelectionChanged

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

Declaration

cs-api-definition
public event EventHandler SelectionChanged

Event Value

EventHandler

SelectionChanging

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

Declaration

cs-api-definition
public event SelectionEventHandler SelectionChanging

Event Value

SelectionEventHandler

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.

Declaration

cs-api-definition
public event EventHandler ViewChanged

Event Value

EventHandler

ViewChanging

ViewChanging event is fired when a navigation to a different date range is required.

Declaration

cs-api-definition
public event ViewChangingEventHandler ViewChanging

Event Value

ViewChangingEventHandler

ZoomChanged

Occurs when the zoom level has changed.

Declaration

cs-api-definition
public event CalendarZoomChangedEventHandler ZoomChanged

Event Value

CalendarZoomChangedEventHandler

ZoomChanging

Occurs when the zoom level is about to change.

Declaration

cs-api-definition
public event CalendarZoomChangingEventHandler ZoomChanging

Event Value

CalendarZoomChangingEventHandler

In this article
DefinitionConstructorsRadCalendar()PropertiesAllowColumnHeaderSelectorsAllowFastNavigationAllowFishEyeAllowMultipleSelectAllowMultipleViewAllowNavigationAllowRowHeaderSelectorsAllowSelectAllowViewSelectorCalendarElementCellAlignCellHorizontalSpacingCellMarginCellPaddingCellToolTipFormatCellVerticalSpacingClearButtonColumnHeaderImageColumnHeaderTextColumnsCultureCurrentCalendarCurrentViewColumnCurrentViewRowDateRangeSeparatorDateTimeFormatDayCellFormatDayNameFormatDefaultSizeDefaultViewFastNavigationNextImageFastNavigationNextTextFastNavigationNextToolTipFastNavigationPrevImageFastNavigationPrevTextFastNavigationPrevToolTipFastNavigationStepFirstDayOfWeekFocusedDateFontHeaderHeightHeaderNavigationModeHeaderWidthMonthLayoutMultiViewColumnsMultiViewRowsNavigationNextImageNavigationNextTextNavigationNextToolTipNavigationPrevImageNavigationPrevTextNavigationPrevToolTipOrientationRangeMaxDateRangeMinDateReadOnlyRowHeaderImageRowHeaderTextRowsSelectedDateSelectedDatesShowColumnHeadersShowFastNavigationButtonsShowFooterShowHeaderShowNavigationButtonsShowOtherMonthsDaysShowRowHeadersShowViewHeaderShowViewSelectorSpecialDaysTitleAlignTitleFormatTodayButtonViewSelectorImageViewSelectorTextZoomFactorZoomLevelMethodsControlDefinesThemeForElement(RadElement)CreateAccessibilityInstance()CreateChildItems(RadElement)EnsureDefaultView()InvalidateCalendar()OnElementRender(LightVisualElement, RadCalendarDay, CalendarView)OnLoad(Size)OnNavigated(CalendarNavigatedEventArgs)OnNavigating(CalendarNavigatingEventArgs)OnNotifyPropertyChanged(PropertyChangedEventArgs)OnRightToLeftChanged(EventArgs)OnSelectionChanged()OnSelectionChanging(DateTimeCollection, List<DateTime>)OnViewChanged()OnViewChanging(CalendarView)OnZoomChanged(CalendarZoomChangedEventArgs)OnZoomChanging(CalendarZoomChangingEventArgs)ProcessCmdKey(ref Message, Keys)RemoveFocusedDate(bool)ScaleControl(SizeF, BoundsSpecified)TruncateTimeComponent(DateTime)EventsElementRenderNavigatedNavigatingSelectionChangedSelectionChangingViewChangedViewChangingZoomChangedZoomChanging
Not finding the help you need?
Contact Support