CalendarControl Class

Displays a monthly calendar and allows an end-user to select a date or date range(s).

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

public class CalendarControl :
    CalendarControlBase,
    IDateTouchCalendarControl,
    ITouchCalendarControl,
    IPickItemsContainer,
    IMouseWheelSupport
Public Class CalendarControl
    Inherits CalendarControlBase
    Implements IDateTouchCalendarControl,
               ITouchCalendarControl,
               IPickItemsContainer,
               IMouseWheelSupport

Related API Members

The following members accept/return CalendarControl objects:

Remarks

The calendar control displays one or multiple months simultaneously. An end-user can select a certain date, a date range or multiple dates/date ranges.

CalendarControl.png

To access selected dates, use the following properties:

The control's main features include:

Feature

Members

Any number of months can be visible simultaneously.

CalendarControlBase.RowCount, CalendarControlBase.ColumnCount, CalendarControlBase.CalendarVerticalIndent, CalendarControlBase.CalendarHorizontalIndent

Ability to customize the appearance of the calendar's various elements (cells corresponding to regular and special dates, headers, etc.)

CalendarControlBase.CalendarAppearance

CalendarControlBase.CellStyleProvider

CalendarControlBase.SpecialDateProvider

Ability to enter the time portion of a date

CalendarControlBase.CalendarTimeEditing, CalendarControlBase.CalendarTimeProperties, CalendarControlBase.CalendarDateEditing

Multiple views of the calendar control, including a touch-aware UI.

CalendarControlBase.CalendarView

Touch UI:

CalendarControl-TouchUI.png

Custom cell size

CalendarControlBase.CellSize

Ability to display context buttons in calendar cells. This allows you to mark certain date cells with custom text and images.

CalendarControlBase.ContextButtons and CalendarControlBase.ContextButtonOptions properties.

CalendarControlBase.ContextButtonCustomize, CalendarControlBase.ContextButtonClick, CalendarControlBase.CustomContextButtonToolTip and CalendarControlBase.ContextButtonValueChanged events.

Draw lines between cells

CalendarControlBase.DrawCellLines

Specify the first day of the week

CalendarControlBase.FirstDayOfWeek

The minimum and maximum dates shown

CalendarControlBase.MinValue and CalendarControlBase.MaxValue

Single or multiple date selection

CalendarControlBase.SelectionMode, CalendarControlBase.SelectionBehavior, CalendarControlBase.DateTime, CalendarControlBase.SyncSelectionWithEditValue, CalendarControlBase.SelectedRanges

Displaying week numbers

CalendarControlBase.ShowWeekNumbers, CalendarControlBase.WeekNumberRule CalendarControlBase.CustomWeekNumber

Disabling certain dates

CalendarControlBase.DisableCalendarDate

CalendarControlBase.DisabledDateProvider

Custom date painting

CalendarControl.CustomDrawDayNumberCell

See Also