CustomDisplayTextEventArgs Class

Provides data for the RepositoryItem.CustomDisplayText event.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

public class CustomDisplayTextEventArgs :
    EventArgs

VB.NET

Public Class CustomDisplayTextEventArgs
    Inherits EventArgs

Related API Members

CustomDisplayTextEventArgs is the data class for the following events:

• BaseEdit.CustomDisplayText
• RepositoryItem.CustomDisplayText

Remarks

Use the RepositoryItem.CustomDisplayText event to provide custom display text for an editor when it’s not focused. This event takes a CustomDisplayTextEventArgs object as a parameter containing data for the event.

Related GitHub Examples

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

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-provide-functionality-for-the-designerverbs-context-links-e3528/CS/Verbs/PropertyVerbsControl.cs#L85

void editor_CustomDisplayText(object sender, DevExpress.XtraEditors.Controls.CustomDisplayTextEventArgs e) {
    e.DisplayText = (e.Value as DesignerVerb).Text + ",";

how-to-use-typeconverter-for-converting-values-displayed-in-a-gridcontrol-e4492/CS/GridControlTypeConverter/Form1.cs#L47

}
void comboBoxEdit1_CustomDisplayText(object sender, DevExpress.XtraEditors.Controls.CustomDisplayTextEventArgs e)
{

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

void rePopupContainer_CustomDisplayText(object sender, DevExpress.XtraEditors.Controls.CustomDisplayTextEventArgs e) {
    e.DisplayText = "(table data)";

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

private void RepositoryItemLookUpEdit_CustomDisplayText(object sender, CustomDisplayTextEventArgs e) {
    RepositoryItemLookUpEdit props;

how-to-implement-an-ifilteredcomponent-interface-e1350/CS/Q200298/Form1.cs#L27

private void OnhProductsCustomDisplayText(object sender, CustomDisplayTextEventArgs e) {
    if (e.DisplayText == string.Empty) {

VB.NET

how-to-provide-functionality-for-the-designerverbs-context-links-e3528/VB/Verbs/PropertyVerbsControl.vb#L94

Private Sub editor_CustomDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.CustomDisplayTextEventArgs)
    e.DisplayText = (TryCast(e.Value, DesignerVerb)).Text & ","

how-to-use-typeconverter-for-converting-values-displayed-in-a-gridcontrol-e4492/VB/GridControlTypeConverter/Form1.vb#L43

End Sub
Private Sub comboBoxEdit1_CustomDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.CustomDisplayTextEventArgs)
    e.DisplayText = (CType(e.Value, CultureInfo)).DisplayName

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

Private Sub rePopupContainer_CustomDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.CustomDisplayTextEventArgs)
    e.DisplayText = "(table data)"

how-to-display-custom-text-when-lookupedits-value-is-not-found-in-the-lookup-list-e781/VB/Form1.vb#L50

Private Sub RepositoryItemLookUpEdit_CustomDisplayText(ByVal sender As Object, ByVal e As CustomDisplayTextEventArgs)
    Dim props As RepositoryItemLookUpEdit

how-to-implement-an-ifilteredcomponent-interface-e1350/VB/Q200298/Form1.vb#L29

Private Sub OnhProductsCustomDisplayText(ByVal sender As Object, ByVal e As CustomDisplayTextEventArgs)
    If e.DisplayText = String.Empty Then

Inheritance

Object

EventArgs

CustomDisplayTextEventArgs