ASPxCalendar Class

Represents the calendar control.

Assembly: DevExpress.Web.v24.2.dll

Declaration

C#
VB.NET

public class ASPxCalendar :
    ASPxEdit,
    ICalendarSharedPropertiesOwner

Public Class ASPxCalendar
    Inherits ASPxEdit
    Implements ICalendarSharedPropertiesOwner

The following members return ASPxCalendar objects:

Remarks

The ASPxCalendar class represents a calendar control that allows end-users to select dates, and navigate through months and years.

Create a Calendar Control

Design Time

The ASPxCalendar control is available on the DX.24.2: Common Controls toolbox tab in the Microsoft Visual Studio IDE.

Drag the control onto a form and customize the control’s settings, or paste the control’s markup in the page’s source code.

ASPX

<dx:ASPxCalendar ID="calendar" runat="server" EnableMultiSelect="true">
    <FastNavProperties DisplayMode="Popup" />
</dx:ASPxCalendar>

using DevExpress.Web;
...
protected void Page_Load(object sender, EventArgs e)
{
    ASPxCalendar calendar = new ASPxCalendar();
    calendar.ID = "calendar";
    Page.Form.Controls.Add(calendar);

    calendar.EnableMultiSelect = true;
    calendar.FastNavProperties.DisplayMode = FastNavigationDisplayMode.Popup;
}

Imports DevExpress.Web

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim calendar As ASPxCalendar = New ASPxCalendar()
    calendar.ID = "calendar"
    Page.Form.Controls.Add(calendar)

    calendar.EnableMultiSelect = True
    calendar.FastNavProperties.DisplayMode = FastNavigationDisplayMode.Popup
End Sub

Note

DevExpress controls require that you register special modules, handlers, and options in the Web.config file. You can change this file or switch to the Design tab in the Microsoft Visual Studio IDE to automatically update the Web.config file. Note that this information is automatically registered if you use the DevExpress Template Gallery to create a project.

By default, the calendar control displays the days of the month, day headings for the days of the week, week numbers, a header (with the month name and year and links for moving to the next or previous month and year) and a footer (with buttons for setting the selected date to today or a null value). The appearance of the calendar control can be customized by setting the properties that control the style for different parts of the control. The following table lists the properties that specify the style for the different parts of the control.

Property	Description
ASPxCalendar.ButtonStyle	Defines the style for the calendar’s button elements.
ASPxCalendar.DayHeaderStyle	Defines the style for the calendar’s section that displays the day of the week.
ASPxCalendar.DayOtherMonthStyle	Defines the style for the days that don’t belong to the displayed month.
ASPxCalendar.DaySelectedStyle	Defines the style for the calendar’s selected day.
ASPxCalendar.DayStyle	Defines the style for the days displayed in the calendar.
ASPxCalendar.DayWeekendStyle	Defines the style for the weekend dates in the calendar.
ASPxCalendar.FooterStyle	Defines the style for the calendar’s footer section.
ASPxCalendar.HeaderStyle	Defines the style for the calendar’s title heading.
ASPxCalendar.WeekNumberStyle	Defines the style for the week number markers in the calendar.

Links, which reside within the calendar’s header and provide the month and year navigation capabilities, can be represented by custom images using the properties listed below.

Property	Description
ASPxCalendar.NextPeriodImage	Defines the image for the link navigating to the next month.
ASPxCalendar.NextLargePeriodImage	Defines the image for the link navigating to the next year.
ASPxCalendar.PrevPeriodImage	Defines the image for the link navigating to the previous month.
ASPxCalendar.PrevLargePeriodImage	Defines the image for the link navigating to the previous year.

Different parts of the calendar control can be shown or hidden. The following table lists the properties that control the visibility of the calendar’s elements.

Property	Description
ASPxCalendar.ShowClearButton	Specifies whether the Clear button is displayed within the calendar’s footer.
ASPxCalendar.ShowDayHeaders	Specifies whether the heading for the days of the week is displayed.
ASPxCalendar.ShowHeader	Specifies whether the calendar’s title heading is displayed.
ASPxCalendar.ShowTodayButton	Specifies whether the Today button is displayed within the calendar’s footer.
ASPxCalendar.ShowWeekNumbers	Specifies whether the week number section is displayed within the calendar. (The calendar’s week numbers are represented as ISO week numbers.)

You can disable end-user navigation through months or years by hiding the corresponding navigation buttons using the ASPxCalendar.EnablePeriodNavigation or ASPxCalendar.EnableLargePeriodNavigation property.

The currently selected date within the calendar is specified by the ASPxCalendar.SelectedDate property. Changing this property raises the ASPxCalendar.SelectionChanged event. The ASPxCalendar.VisibleDate property specifies the calendar’s currently displayed month. The property being changed due to navigation through months and years causes the ASPxCalendar.VisibleMonthChanged to be fired.

Selection of multiple dates can be available for end-users via the ASPxCalendar.EnableMultiSelect property. Selected dates are contained within the ASPxCalendar.SelectedDates collection.

The ASPxCalendar editor is able to display multiple months simultaneously, organized in several rows and columns. This feature is controlled by a combination of the ASPxCalendar.Rows and ASPxCalendar.Columns property values.

Note

The client-side equivalent of this editor control is represented by the ASPxClientCalendar object. The editor’s client-side API is enabled if the ASPxEditBase.EnableClientSideAPI property is set to true, or any client event is handled. Available client events can be accessed via the ASPxCalendar.ClientSideEvents property.