TimeSpanEdit Class

The editor to display and edit time intervals.

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#
VB.NET

public class TimeSpanEdit :
    TimeEdit

Public Class TimeSpanEdit
    Inherits TimeEdit

The following members return TimeSpanEdit objects:

Remarks

The TimeSpanEdit control is designed to represent data stored in the TimeSpan format.

TimeSpanEdit - Visual Elements

The editor consists of the following visual elements:

Edit box — a text box that displays the textual representation of the current time span. The displayed text is formatted according to the TimeSpanEdit.Properties.DisplayFormat property settings.

If the TimeSpanEdit.Properties.ReadOnly setting is not enabled, users can modify the time span directly in the edit box without invoking the drop-down panel. When the editor is focused, the value is displayed according to the TimeSpanEdit.Properties.Mask property.
Drop-down button — a button that invokes the drop-down panel.
Drop-down panel — a panel that displays the current time span and allows users to modify it. Use the TimeSpanEdit.Properties.AllowEditDays, AllowEditHours, AllowEditMinutes, AllowEditSeconds, and AllowEditMilliseconds properties to specify the time units that can be edited in the drop-down panel.

The TimeSpanEdit.Properties property provides access to a repository item that stores settings specific to the TimeSpanEdit control. See RepositoryItemTimeSpanEdit for more information.

Example

The code below shows how to display the time left until the new year — subtract one DateTime value from another and display the result in the editor.

TimeSpanEdit - New Year Counter

C#
VB.NET

namespace timespan {
    public partial class Form1 : XtraForm {
        DateTime NYDate = new DateTime(2015, 1, 1, 0, 0, 0, 0);
        public Form1() {
            InitializeComponent();
            timeSpanEdit1.Properties.ReadOnly = false;
            timeSpanEdit1.Properties.Mask.EditMask = "dd DD, hh HH, mm MM, ss SS";
            timeSpanEdit1.Properties.UseMaskAsDisplayFormat = true;
            RefreshTimer();
        }

        private void RefreshTimer() {
            DateTime currentDate = DateTime.Now;
            TimeSpan timeToNY = NYDate - currentDate;
            timeSpanEdit1.EditValue = timeToNY;
        }

        private void simpleButton1_Click(object sender, EventArgs e) {
            RefreshTimer();
        }

        private void timeSpanEdit1_EditValueChanged(object sender, EventArgs e) {
            labelControl1.Text = timeSpanEdit1.Properties.GetDisplayText(timeSpanEdit1.EditValue) + " left for the New Year!";
        }
    }
}

Namespace timespan
    Partial Public Class Form1
        Inherits XtraForm

        Private NYDate As New Date(2015, 1, 1, 0, 0, 0, 0)
        Public Sub New()
            InitializeComponent()
            timeSpanEdit1.Properties.ReadOnly = False
            timeSpanEdit1.Properties.Mask.EditMask = "dd DD, hh HH, mm MM, ss SS"
            timeSpanEdit1.Properties.UseMaskAsDisplayFormat = True
            RefreshTimer()
        End Sub

        Private Sub RefreshTimer()
            Dim currentDate As Date = Date.Now
            Dim timeToNY As TimeSpan = NYDate.Subtract(currentDate)
            timeSpanEdit1.EditValue = timeToNY
        End Sub

        Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As EventArgs)
            RefreshTimer()
        End Sub

        Private Sub timeSpanEdit1_EditValueChanged(ByVal sender As Object, ByVal e As EventArgs)
            labelControl1.Text = timeSpanEdit1.Properties.GetDisplayText(timeSpanEdit1.EditValue) & " left for the New Year!"
        End Sub
    End Class
End Namespace