RepositoryItem.CustomDisplayText Event

Enables custom display text to be provided for an editor.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DXCategory("Events")]
public event CustomDisplayTextEventHandler CustomDisplayText

VB.NET

<DXCategory("Events")>
Public Event CustomDisplayText As CustomDisplayTextEventHandler

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

Important

This event fires only when an editor has no focus.

The CustomDisplayText event can be used to provide custom display text for an editor. To provide custom text, assign it to the event’s DisplayText parameter. Initially, this property contains the current display text, which is a formatted representation of the editor’s edit value. To access the editor’s edit value, use the Value parameter.

For ImageComboBoxEdit editors, the CustomDisplayText event only fires when no value is selected in the editor (the ComboBoxEdit.SelectedIndex is set to -1). When a value is selected, the CustomDisplayText event doesn’t fire. In this instance, the display text is specified by the selected item’s ImageComboBoxItem.Description property.

The CustomDisplayText event also fires for cells in a container control (e.g GridControl, etc) if a repository item object is assigned to the control’s column/cell for in-place editing. In display mode (when an in-place editor is not active), the CustomDisplayText event fires with the sender parameter, specifying a corresponding repository item object (the RepositoryItem class’ descendant). When an in-place editor is activated, the CustomDisplayText event doesn’t fire. However, it’s possible to disable the text editing feature via the RepositoryItemButtonEdit.TextEditStyle property. In this instance, when the editor is activated, the CustomDisplayText event fires with the sender parameter specifying a corresponding editor object (the BaseEdit class’ descendant).

After your CustomDisplayText event handler is complete, the display text may be modified according to the RepositoryItemTextEdit.CharacterCasing option.

The BaseEdit.CustomDisplayText event is equivalent to the current event.

Example

The code below shows how to provide custom display text for a ProgressBarControl by handling the BaseEdit.CustomDisplayText event.

In the example, the ProgressBarControl displays a countdown timer.

C#

using DevExpress.XtraEditors;

System.Windows.Forms.Timer timer = new System.Windows.Forms.Timer();

private void Form1_Load(object sender, EventArgs e) {
    progressBarControl1.Properties.ShowTitle = true;
    progressBarControl1.Properties.PercentView = false;
    progressBarControl1.CustomDisplayText += ProgressBarControl1_CustomDisplayText;
    timer.Tick += timer1_Tick;
}

private void btnStartTimer_Click(object sender, EventArgs e) {
    timer.Enabled = false;
    int totalSeconds = 5;
    DateTime startTime = DateTime.Now;
    progressBarControl1.Tag = startTime;
    progressBarControl1.Properties.Minimum = 0;
    progressBarControl1.Properties.Maximum = totalSeconds;
    progressBarControl1.Position = progressBarControl1.Properties.Minimum;
    timer.Enabled = true;
}

private void ProgressBarControl1_CustomDisplayText(object sender, DevExpress.XtraEditors.Controls.CustomDisplayTextEventArgs e) {
    ProgressBarControl pb = sender as ProgressBarControl;
    if (pb.Tag == null) { e.DisplayText = "Stopped"; return; }
    int currentPosition = Convert.ToInt32(e.Value);
    int maximum = pb.Properties.Maximum;
    int secondsLeft = maximum - currentPosition;
    TimeSpan timeLeft = new TimeSpan(0, 0, secondsLeft);
    string s = string.Format("{0:dd} days {0:hh} hours {0:mm} minutes {0:ss} seconds", timeLeft);
    e.DisplayText = s;
}

private void timer1_Tick(object sender, EventArgs e) {
    ProgressBarControl pb = progressBarControl1;
    if (pb.Tag == null || !(pb.Tag is DateTime)) return;
    DateTime startTime = (DateTime)pb.Tag;
    DateTime currentTime = DateTime.Now;
    int elapsedSeconds = Convert.ToInt32((currentTime - startTime).TotalSeconds);
    int totalSeconds = pb.Properties.Maximum;
    if (elapsedSeconds >= totalSeconds) {
        (sender as System.Windows.Forms.Timer).Enabled = false;
        pb.Tag = null;
        BeginInvoke(new MethodInvoker(delegate
        {
            MessageBox.Show("Stop");
        }));
    }
    pb.Position = elapsedSeconds;
}

VB.NET

Imports DevExpress.XtraEditors

Public Sub New()
    InitializeComponent()

    ProgressBarControl1.Properties.ShowTitle = True
    ProgressBarControl1.Properties.PercentView = False
    AddHandler ProgressBarControl1.CustomDisplayText, AddressOf ProgressBarControl1_CustomDisplayText
    AddHandler timer.Tick, AddressOf timer1_Tick
End Sub

Dim timer As System.Windows.Forms.Timer = New Timer()

Private Sub buttonStartTimer_Click(sender As Object, e As EventArgs) Handles buttonStartTimer.Click
    timer.Enabled = False
    Dim totalSeconds As Integer = 5
    Dim startTime As DateTime = DateTime.Now
    ProgressBarControl1.Tag = startTime
    ProgressBarControl1.Properties.Minimum = 0
    ProgressBarControl1.Properties.Maximum = totalSeconds
    ProgressBarControl1.Position = ProgressBarControl1.Properties.Minimum
    timer.Enabled = True
End Sub

Private Sub ProgressBarControl1_CustomDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.CustomDisplayTextEventArgs)
    Dim pb As ProgressBarControl = TryCast(sender, ProgressBarControl)
    If pb.Tag Is Nothing Then
        e.DisplayText = "Stopped"
        Return
    End If
    Dim currentPosition As Integer = Convert.ToInt32(e.Value)
    Dim maximum As Integer = pb.Properties.Maximum
    Dim secondsLeft As Integer = maximum - currentPosition
    Dim timeLeft As TimeSpan = New TimeSpan(0, 0, secondsLeft)
    Dim s As String = String.Format("{0:dd} days {0:hh} hours {0:mm} minutes {0:ss} seconds", timeLeft)
    e.DisplayText = s
End Sub

Private Sub timer1_Tick(ByVal sender As Object, ByVal e As EventArgs)
    Dim pb As ProgressBarControl = ProgressBarControl1
    If pb.Tag Is Nothing OrElse Not (TypeOf pb.Tag Is DateTime) Then Return
    Dim startTime As DateTime = CType(pb.Tag, DateTime)
    Dim currentTime As DateTime = DateTime.Now
    Dim elapsedSeconds As Integer = Convert.ToInt32((currentTime - startTime).TotalSeconds)
    Dim totalSeconds As Integer = pb.Properties.Maximum
    If elapsedSeconds >= totalSeconds Then
        CType(sender, System.Windows.Forms.Timer).Enabled = False
        pb.Tag = Nothing
        BeginInvoke(New MethodInvoker(Sub()
                                            MessageBox.Show("Stop")
                                        End Sub))
    End If
    pb.Position = elapsedSeconds
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

how-to-use-a-spreadsheet-control-as-an-in-place-editor-gridcontrol-propertygridcontrol-e4777/CS/WindowsFormsApplication1/Form1.cs#L29

propertyGridControl1.DefaultEditors.Add(typeof(DataTable), rePopupContainer);
rePopupContainer.CustomDisplayText += new DevExpress.XtraEditors.Controls.CustomDisplayTextEventHandler(rePopupContainer_CustomDisplayText);

how-to-display-custom-text-when-lookupedits-value-is-not-found-in-the-lookup-list-e781/CS/Form1.cs#L35

editor.DisplayMember = "Name";
editor.CustomDisplayText += new CustomDisplayTextEventHandler(RepositoryItemLookUpEdit_CustomDisplayText);

how-to-create-a-complex-filter-that-uses-mathematic-calculations-for-gridview-e2800/CS/WindowsApplication1/ComplexFilterHelper.cs#L54

RepositoryItemButtonEdit riBE = new RepositoryItemButtonEdit();
riBE.CustomDisplayText += riBE_CustomDisplayText;
riBE.Buttons[0].Kind = ButtonPredefines.Glyph;

how-to-configure-rating-control-t190685/CS/dxSample/MainForm.cs#L79

    riTextEdit.Mask.UseMaskAsDisplayFormat = true;
    riTextEdit.CustomDisplayText += riTextEdit_CustomDisplayText;
}

VB.NET

how-to-use-a-spreadsheet-control-as-an-in-place-editor-gridcontrol-propertygridcontrol-e4777/VB/WindowsFormsApplication1/Form1.vb#L31

propertyGridControl1.DefaultEditors.Add(GetType(DataTable), rePopupContainer)
AddHandler rePopupContainer.CustomDisplayText, AddressOf rePopupContainer_CustomDisplayText

how-to-create-a-complex-filter-that-uses-mathematic-calculations-for-gridview-e2800/VB/ComplexFilterHelper.vb#L56

Dim riBE As New RepositoryItemButtonEdit()
AddHandler riBE.CustomDisplayText, AddressOf riBE_CustomDisplayText
riBE.Buttons(0).Kind = ButtonPredefines.Glyph

how-to-configure-rating-control-t190685/VB/dxSample/MainForm.vb#L81

    riTextEdit.Mask.UseMaskAsDisplayFormat = True
    AddHandler riTextEdit.CustomDisplayText, AddressOf riTextEdit_CustomDisplayText
End Sub