BaseEdit.CustomDisplayText Event

Enables you to display a custom text within the editor.

Namespace: DevExpress.Xpf.Editors

Assembly: DevExpress.Xpf.Core.v14.2.dll

Declaration

C#

public event CustomDisplayTextEventHandler CustomDisplayText

VB.NET

Public Event CustomDisplayText As CustomDisplayTextEventHandler

Event Data

The CustomDisplayText event's handler receives an argument of the CustomDisplayTextEventArgs type. The following properties provide information specific to this event:

Property	Description
DisplayText	Gets or sets the text displayed within the editor.
EditValue	Gets or sets the editor's value.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

Remarks

To display a custom text within the editor, assign it to the event parameter's CustomDisplayTextEventArgs.DisplayText property and set the CustomDisplayTextEventArgs.Handled property to true. Note that this doesn't change the editor's BaseEdit.EditValue property.