DateEdit.DateTime Property

Gets or sets the current date/time value.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v25.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[Bindable(false)]
[DXCategory("Appearance")]
public DateTime DateTime { get; set; }

VB.NET

<Bindable(False)>
<DXCategory("Appearance")>
Public Property DateTime As Date

Property Value

Type	Description
DateTime	The current date/time value.

Remarks

The following code snippet sets the current date when a user presses Ctrl+N:

C#

using DevExpress.XtraEditors;

dateEdit.KeyDown += DateEdit_KeyDown;

void DateEdit_KeyDown(object sender, KeyEventArgs e) {
    DateEdit control = sender as DateEdit;
    if (e.KeyCode == Keys.N && e.Control)
        control.DateTime = DateTime.Now;
}

VB.NET

Imports DevExpress.XtraEditors
Imports System.Windows.Forms

AddHandler dateEdit.KeyDown, AddressOf DateEdit_KeyDown

Sub DateEdit_KeyDown(sender As Object, e As KeyEventArgs)
    Dim control As DateEdit = TryCast(sender, DateEdit)
    If e.KeyCode = Keys.N AndAlso e.Control Then
        control.DateTime = DateTime.Now
    End If
End Sub

The DateEdit exposes a set of related properties that define the edit value and the displayed text.

EditValue

The DateEdit.EditValue property stores the current value. The DateEdit control displays this value as text in the edit box.

EditValue updates only when a user selects a single date. EditValue does not change in multi-selection mode.

The DateEdit control fires the following events in response to EditValue changes:

• EditValueChanging
• EditValueChanged

Typing triggers multiple change cycles. Each date segment update raises the event pair:

Set the DateEdit.Properties.EditValueChangedFiringMode property to Buffered to delay events until input completion.

DateTime

The DateEdit.DateTime property specifies a strongly typed DateTime value. It mirrors EditValue and ignores multiple date selection.

Do not bind the DateTime property. Bind EditValue to a data source instead.

DateOnly

The DateEdit.DateOnly property specifies a strongly typed DateOnly value. It mirrors EditValue and ignores multiple date selection.

Do not bind the DateTime property. Bind EditValue to a data source instead.

Text

The DateEdit.Text property gets the text displayed in the edit box. The control converts its EditValue to text with ToString().

Use Format Specifiers, Masks, or handle the FormatEditValue event to modify default formatting settings.

The following code snippet formats the display text as “dd MMMM, yyyy“ (for example, “22 March, 2019“):

C#

using DevExpress.Utils;
using DevExpress.XtraEditors.Controls;

// #1 - Use format specifiers.
dateEdit1.Properties.DisplayFormat.FormatType = FormatType.DateTime;
dateEdit1.Properties.DisplayFormat.FormatString = "dd' 'MMMM', 'yyyy";

// #2 - Use event-based formatting.
dateEdit1.FormatEditValue += DateEdit1_FormatEditValue;

void DateEdit1_FormatEditValue(object sender, ConvertEditValueEventArgs e) {
    try {
        string day = ((DateTime)e.Value).Day.ToString();
        string month = ((DateTime)e.Value).ToString("MMMM");
        string year = ((DateTime)e.Value).Year.ToString();
        e.Value = day + " " + month + ", " + year;
        e.Handled = true;
    }
    catch (Exception) {
    }
}

VB.NET

Imports DevExpress.Utils
Imports DevExpress.XtraEditors.Controls

' #1 - Use format specifiers.
dateEdit1.Properties.DisplayFormat.FormatType = FormatType.DateTime
dateEdit1.Properties.DisplayFormat.FormatString = "dd' 'MMMM', 'yyyy"

' #2 - Use event-based formatting.
AddHandler dateEdit1.FormatEditValue, AddressOf DateEdit1_FormatEditValue

void DateEdit1_FormatEditValue(Object sender, ConvertEditValueEventArgs e)
    Try
        Dim day As String = CDate(e.Value).Day.ToString()
        Dim month As String = CDate(e.Value).ToString("MMMM")
        Dim year As String = CDate(e.Value).Year.ToString()
        e.Value = day & " " & month & ", " & year
        e.Handled = True
    Catch e1 As Exception
    End Try

Synchronization

EditValue, DateTime, and DateOnly properties are synchronized. A change in one property updates other properties.

SelectedRanges

The DateEdit.SelectedRanges property stores selected date intervals. Use this property in multi-selection mode.

EditValue, DateTime, and DateOnly properties support single-date selection only. Use SelectedRanges to obtain selected dates when the SelectionMode property is set to Multiple.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DateTime property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-scheduler-create-appointments-on-reminder-alert/CS/ReminderCustomActions/Forms/MyAppointmentEditForm.cs#L114

dtStart.DateTime = controller.Start.Date;
dtEnd.DateTime = controller.End.Date;

winforms-pivot-grid-add-custom-field-values-rows-column-not-present-in-datasource/CS/CustomDatesPivot/Form1.cs#L42

{
    dateEdit1.DateTime = DateTime.Now;
    dateEdit2.DateTime = DateTime.Now.AddMonths(12);

winforms-scheduler-print-appointments-using-reports/CS/PrintingViaReports/MyAppointmentEditForm.cs#L148

bool IsIntervalValid() {
    DateTime start = dtStart.DateTime + timeStart.Time.TimeOfDay;
    DateTime end = dtEnd.DateTime + timeEnd.Time.TimeOfDay;

report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application/CS/ScheduledTasksAPIClientDemo/SchedulerJobViewerForm.cs#L53

scheduledJobEnabled.Checked = scheduledJob.Enabled;
scheduledJobStartDate.DateTime = scheduledJob.StartDate.ToLocalTime();
reportId.Text = string.Format("{0}", scheduledJob.ReportId);

winforms-calendar-dateedit-cell-appearance-customization/CS/Calendar_CellStyleProvider/Form1.cs#L21

private void Form1_Load(object sender, EventArgs e) {
    dateEdit1.DateTime = calendarControl1.DateTime = new DateTime(2016, 12, 31);
    dateEdit1.Properties.CellStyleProvider = calendarControl1.CellStyleProvider = new CustomCellStyleProvider();

VB.NET

winforms-scheduler-create-appointments-on-reminder-alert/VB/ReminderCustomActions/Forms/MyAppointmentEditForm.vb#L127

dtStart.DateTime = controller.Start.Date
dtEnd.DateTime = controller.End.Date

winforms-pivot-grid-add-custom-field-values-rows-column-not-present-in-datasource/VB/CustomDatesPivot/Form1.vb#L38

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    dateEdit1.DateTime = DateTime.Now
    dateEdit2.DateTime = DateTime.Now.AddMonths(12)

winforms-scheduler-print-appointments-using-reports/VB/PrintingViaReports/MyAppointmentEditForm.vb#L166

Private Function IsIntervalValid() As Boolean
    Dim start As Date = dtStart.DateTime + timeStart.Time.TimeOfDay
    Dim [end] As Date = dtEnd.DateTime + timeEnd.Time.TimeOfDay

report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application/VB/ScheduledTasksAPIClientDemo/SchedulerJobViewerForm.vb#L53

scheduledJobEnabled.Checked = scheduledJob.Enabled
scheduledJobStartDate.DateTime = scheduledJob.StartDate.ToLocalTime()
reportId.Text = String.Format("{0}", scheduledJob.ReportId)

winforms-calendar-dateedit-cell-appearance-customization/VB/Calendar_CellStyleProvider/Form1.vb#L24

calendarControl1.DateTime = New Date(2016, 12, 31)
dateEdit1.DateTime = calendarControl1.DateTime
calendarControl1.CellStyleProvider = New CustomCellStyleProvider()