DXFileDialog.Filter Property

Gets or sets the current file name filter string, which determines the choices that appear in a file dialog.

Namespace: DevExpress.Xpf.Dialogs

Assembly: DevExpress.Xpf.Dialogs.v19.1.dll

Declaration

C#

public string Filter { get; set; }

VB.NET

Public Property Filter As String

Property Value

Type	Description
String	The file filtering options available in the file dialog.

Remarks

For each filtering option, the filter string contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar.

The following is an example of a filter string:

Text files (*.txt)|*.txt|All files (*.*)|*.*

You can add several filter patterns to a filter by separating the file types with semicolons, for example:

Image Files(*.BMP;*.JPG;*.GIF)|*.BMP;*.JPG;*.GIF|All files (*.*)|*.*

Use the DXFileDialog.FilterIndex property to set which filtering option is shown first to the user.

The code sample below demonstrates how to define filters that allow end-users to see images or all files.

C#

private void button_Click(object sender, RoutedEventArgs e) {
    var fileDialog = new DXOpenFileDialog();
    fileDialog.Filter = "Image Files|*.BMP;*.JPG;*.GIF|All files|*.*";
    fileDialog.ShowDialog();
}

VB.NET

Private Sub button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Dim fileDialog = New DXOpenFileDialog()
    fileDialog.Filter = "Image Files|*.BMP;*.JPG;*.GIF|All files|*.*"
    fileDialog.ShowDialog()
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Filter property.

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#

wpf-dashboard-how-to-handle-dashboardloaded-event-to-change-data-source/CS/WpfDashboardLoadedExample/MainWindow.xaml.cs#L26

fileDialog.InitialDirectory = System.Environment.CurrentDirectory + @"\Data";
fileDialog.Filter = "Excel File | *.xlsx";
fileDialog.Title = "Select XLSX File";

VB.NET

wpf-dashboard-how-to-handle-dashboardloaded-event-to-change-data-source/VB/WpfDashboardLoadedExample/MainWindow.xaml.vb#L24

fileDialog.InitialDirectory = System.Environment.CurrentDirectory & "\Data"
fileDialog.Filter = "Excel File | *.xlsx"
fileDialog.Title = "Select XLSX File"