Back to Devexpress

BaseEdit.CustomDisplayText Event

wpf-devexpress-dot-xpf-dot-editors-dot-baseedit-8e1abde9.md

latest4.5 KB
Original Source

BaseEdit.CustomDisplayText Event

Enables you to display a custom text within the editor.

Namespace : DevExpress.Xpf.Editors

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

NuGet Package : DevExpress.Wpf.Core

Declaration

csharp
public event CustomDisplayTextEventHandler CustomDisplayText
vb
Public Event CustomDisplayText As CustomDisplayTextEventHandler

Event Data

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

PropertyDescription
DisplayTextGets or sets the text displayed within the editor.
EditValueGets or sets the editor’s value.
HandledGets 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.
OriginalSourceGets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEventGets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
SourceGets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

MethodDescription
InvokeEventHandler(Delegate, Object)When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. 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 Handled property to true. Note that this doesn’t change the editor’s BaseEdit.EditValue property.

See Also

BaseEdit Class

BaseEdit Members

DevExpress.Xpf.Editors Namespace