DateFilterControl.CustomDisplayText Event

Allows you to specify the date picker text.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v19.2.Win.dll

Declaration

C#

public event EventHandler<CustomDisplayTextEventArgs> CustomDisplayText

VB.NET

Public Event CustomDisplayText As EventHandler(Of CustomDisplayTextEventArgs)

Event Data

The CustomDisplayText event's data class is CustomDisplayTextEventArgs. The following properties provide information specific to this event:

Property	Description
DisplayText	Gets or sets an editor’s display text.
Value	Gets an editor’s current value.

Remarks

The CustomDisplayText event fires before a date picker caption is displayed and allows you to change it.

Example

This code snippet specifies the date picker button’s caption.

Note

The complete sample project How to Customize the Date Filter Dashboard Item is available in the DevExpress Examples repository.

C#

using DevExpress.DashboardWin;
using DevExpress.XtraEditors.Controls;
using System;
// ...
    dashboardViewer1.DashboardItemControlCreated += DashboardViewer1_DashboardItemControlCreated;
// ...
    private void DashboardViewer1_DashboardItemControlCreated(object sender, DashboardItemControlEventArgs e)
    {
        if (e.DateFilterControl != null)
        {
            dateFilter.CustomDisplayText += DateFilter_CustomDisplayText;
        }
    }

    private void DateFilter_CustomDisplayText(object sender, CustomDisplayTextEventArgs e)
    {
        e.DisplayText = (e.Value is DateTime) ? string.Format("{0:d}", e.Value) : "Click for the Date Picker";
    }

VB.NET

Imports DevExpress.DashboardWin
Imports DevExpress.XtraEditors.Controls
Imports System
' ...
    AddHandler dashboardViewer1.DashboardItemControlCreated, AddressOf DashboardViewer1_DashboardItemControlCreated
' ...
    Private Sub DashboardViewer1_DashboardItemControlCreated(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.DashboardItemControlEventArgs)
        If e.DateFilterControl IsNot Nothing Then
            AddHandler dateFilter.CustomDisplayText, AddressOf DateFilter_CustomDisplayText
        End If
    End Sub

    Private Sub DateFilter_CustomDisplayText(ByVal sender As Object, ByVal e As CustomDisplayTextEventArgs)
        e.DisplayText = If(TypeOf e.Value Is Date, String.Format("{0:d}", e.Value), "Click for the Date Picker")
    End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomDisplayText event.

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-dashboard-customize-date-filter/CS/DateFilter_Customization/Form1.cs#L44

    dateFilter.CalendarTo.CustomDrawDayNumberCell += Calendar_CustomDrawDayNumberCell;
    dateFilter.CustomDisplayText += DateFilter_CustomDisplayText;
}

VB.NET

winforms-dashboard-customize-date-filter/VB/DateFilter_Customization/Form1.vb#L39

    AddHandler dateFilter.CalendarTo.CustomDrawDayNumberCell, AddressOf Calendar_CustomDrawDayNumberCell
    AddHandler dateFilter.CustomDisplayText, AddressOf DateFilter_CustomDisplayText
End Sub