Back to Devexpress

BrowsePathEdit.CustomPathIcon Event

wpf-devexpress-dot-xpf-dot-editors-dot-browsepathedit-5b8069f0.md

latest5.2 KB
Original Source

BrowsePathEdit.CustomPathIcon Event

Allows you to specify a custom path icon.

Namespace : DevExpress.Xpf.Editors

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

NuGet Package : DevExpress.Wpf.Core

Declaration

csharp
public event EventHandler<PathIconEventArgs> CustomPathIcon
vb
Public Event CustomPathIcon As EventHandler(Of PathIconEventArgs)

Event Data

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

PropertyDescription
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.
IconGets or sets the path icon.
OriginalSourceGets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
PathGets the path displayed in the BrowsePathEdit.
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

The following code sample changes the icon displayed if a user enters an invalid path:

xaml
<dxe:BrowsePathEdit DialogType="Folder" CustomPathIcon="OnCustomPathIcon">
csharp
using DevExpress.Xpf.Editors;
using System.IO;
using System.Windows.Media.Imaging;
// ...

void OnCustomPathIcon(object sender, PathIconEventArgs e) {
    if (!Directory.Exists(e.Path))
        e.Icon = new BitmapImage(new System.Uri("pack://application:,,,/Warning_16x16.png"));
    e.Handled = true;
}
vb
Imports DevExpress.Xpf.Editors
Imports System.IO
Imports System.Windows.Media.Imaging
' ...

Private Sub OnCustomPathIcon(ByVal sender As Object, ByVal e As PathIconEventArgs)
    If Not Directory.Exists(e.Path) Then e.Icon = New BitmapImage(New System.Uri("pack://application:,,,/Warning_16x16.png"))
    e.Handled = True
End Sub

See Also

ShowIcon

PathIcon

BrowsePathEdit Class

BrowsePathEdit Members

DevExpress.Xpf.Editors Namespace