FileDialog.Filter Propriété

Définition

Obtient ou définit la chaîne de filtrage qui détermine les types de fichiers affichés dans OpenFileDialog ou SaveFileDialog.Gets or sets the filter string that determines what types of files are displayed from either the OpenFileDialog or SaveFileDialog.

public:
 property System::String ^ Filter { System::String ^ get(); void set(System::String ^ value); };
public string Filter { get; set; }
member this.Filter : string with get, set
Public Property Filter As String

Valeur de propriété

String qui contient le filtre.A String that contains the filter. La valeur par défaut est Empty, ce qui signifie qu'aucun filtre n'est appliqué et que tous les types de fichiers sont affichés.The default is Empty, which means that no filter is applied and all file types are displayed.

Exceptions

La chaîne de filtrage n'est pas valide.The filter string is invalid.

Exemples

Les exemples suivants illustrent plusieurs types de chaînes de filtre qui peuvent être définis à l’aide de la propriété Filter.The following examples demonstrate several types of filter strings that can be set by using the Filter property.

OpenFileDialog dlg = new OpenFileDialog();

// Show all files
dlg.Filter = string.Empty;

dlg.ShowDialog();
Dim dlg As New OpenFileDialog()

' Show all files
dlg.Filter = String.Empty

dlg.ShowDialog()
OpenFileDialog dlg = new OpenFileDialog();

// Show all files
dlg.Filter = null;

dlg.ShowDialog();
Dim dlg As New OpenFileDialog()

' Show all files
dlg.Filter = Nothing

dlg.ShowDialog()
OpenFileDialog dlg = new OpenFileDialog();

// Filter by Word Documents
dlg.Filter = "Word Documents|*.doc";

dlg.ShowDialog();
Dim dlg As New OpenFileDialog()

' Filter by Word Documents
dlg.Filter = "Word Documents|*.doc"

dlg.ShowDialog()
OpenFileDialog dlg = new OpenFileDialog();

// Filter by Excel Worksheets
dlg.Filter = "Excel Worksheets|*.xls";

dlg.ShowDialog();
Dim dlg As New OpenFileDialog()

' Filter by Excel Worksheets
dlg.Filter = "Excel Worksheets|*.xls"

dlg.ShowDialog()
OpenFileDialog dlg = new OpenFileDialog();

// Filter by PowerPoint Presentations
dlg.Filter = "PowerPoint Presentations|*.ppt";

dlg.ShowDialog();
Dim dlg As New OpenFileDialog()

' Filter by PowerPoint Presentations
dlg.Filter = "PowerPoint Presentations|*.ppt"

dlg.ShowDialog()
OpenFileDialog dlg = new OpenFileDialog();

// Filter by Office Files
dlg.Filter = "Office Files|*.doc;*.xls;*.ppt";

dlg.ShowDialog();
Dim dlg As New OpenFileDialog()

' Filter by Office Files
dlg.Filter = "Office Files|*.doc;*.xls;*.ppt"

dlg.ShowDialog()
OpenFileDialog dlg = new OpenFileDialog();

// Filter by All Files
dlg.Filter = "All Files|*.*";

dlg.ShowDialog();
Dim dlg As New OpenFileDialog()

' Filter by All Files
dlg.Filter = "All Files|*.*"

dlg.ShowDialog()
OpenFileDialog dlg = new OpenFileDialog();

// Filter by Word Documents OR Excel Worksheets OR PowerPoint Presentations 
//           OR Office Files 
//           OR All Files
dlg.Filter = "Word Documents|*.doc|Excel Worksheets|*.xls|PowerPoint Presentations|*.ppt" +
             "|Office Files|*.doc;*.xls;*.ppt" +
             "|All Files|*.*";

dlg.ShowDialog();
Dim dlg As New OpenFileDialog()

' Filter by Word Documents OR Excel Worksheets OR PowerPoint Presentations 
'           OR Office Files 
'           OR All Files
dlg.Filter = "Word Documents|*.doc|Excel Worksheets|*.xls|PowerPoint Presentations|*.ppt" & "|Office Files|*.doc;*.xls;*.ppt" & "|All Files|*.*"

dlg.ShowDialog()

Remarques

Si Filter est null ou Empty, tous les fichiers sont affichés et les dossiers sont toujours affichés.If Filter is either null or Empty, all files are displayed, and folders are always displayed.

Vous pouvez spécifier un sous-ensemble de types de fichiers à afficher en définissant la propriété Filter.You can specify a subset of file types to be displayed by setting the Filter property. Chaque type de fichier peut représenter un type de fichier spécifique, comme suit :Each file type can represent a specific type of file, such as the following:

  • Documents Word (*. doc)Word Documents (*.doc)

  • Feuilles de calcul Excel (*. xls)Excel Worksheets (*.xls)

  • Présentations PowerPoint (*. ppt)PowerPoint Presentations (*.ppt)

Un type de fichier peut également représenter un groupe de types de fichiers associés, tels que les suivants :Alternatively, a file type can represent a group of related file types, such as the following:

  • Fichiers Office (*. doc, *. xls, *. ppt)Office Files (*.doc, *.xls, *.ppt)

  • Tous les fichiers (*.*)All Files (*.*)

Pour spécifier un sous-ensemble des types de fichiers affichés, vous devez définir la propriété Filter avec une valeur de chaîne (la chaîne de filtrage) qui spécifie un ou plusieurs types de fichiers à filtrer.To specify a subset of the types of files that are displayed, you set the Filter property with a string value (the filter string) that specifies one or more types of files to filter by. L’exemple suivant montre le format attendu de la chaîne de filtrage :The following shows the expected format of the filter string:

FileType1[[|FileType2]...[|FileTypeN]]

Vous utilisez le format suivant pour décrire chaque type de fichier :You use the following format to describe each file type:

Label|Extension1[[;Extension2]...[;ExtensionN]]

La partie étiquette est une valeur de chaîne explicite qui décrit le type de fichier, par exemple :The Label part is a human-readable string value that describes the file type, such as the following:

  • « Documents Word »"Word Documents"

  • "Feuilles de calcul Excel""Excel Worksheets"

  • « Présentations PowerPoint »"PowerPoint Presentations"

  • « Fichiers Office »"Office Files"

  • « Tous les fichiers »"All Files"

Chaque type de fichier doit être décrit par au moins une extension.Each file type must be described by at least one Extension. Si plusieurs Extensions sont utilisées, chaque extension doit être séparée par un point-virgule (« ; »).If more than one Extension is used, each Extension must be separated by a semicolon (";"). Par exemple :For example:

  • "*. doc""*.doc"

  • « *. xls ; »"*.xls;"

  • « *. ppt »"*.ppt"

  • "*. doc ;*. xls ;*. ppt»"*.doc;*.xls;*.ppt"

  • "*.*»"*.*"

Voici des exemples complets de valeurs de chaîne Filter valides :The following are complete examples of valid Filter string values:

  • Word Documents|*.doc

  • Excel Worksheets|*.xls

  • PowerPoint Presentations|*.ppt

  • Office Files|*.doc;*.xls;*.ppt

  • All Files|*.*

  • Word Documents|*.doc|Excel Worksheets|*.xls|PowerPoint Presentations|*.ppt|Office Files|*.doc;*.xls;*.ppt|All Files|*.*

Chaque type de fichier inclus dans le filtre est ajouté en tant qu’élément distinct dans la liste déroulante types de fichiers du OpenFileDialog ou SaveFileDialog, comme illustré dans la figure suivante.Each file type that is included in the filter is added as a separate item to the Files of type: drop-down list in the OpenFileDialog or SaveFileDialog, as shown in the following figure.

Utilisation de FileDialog. Filter dans la boîte de dialogue OuvrirUsing the FileDialog.Filter in the Open Dialog Box

L’utilisateur peut choisir un type de fichier dans cette liste pour le filtrage.The user can choose a file type from this list to filter by. Par défaut, le premier élément de la liste (par exemple, le premier type de fichier) est sélectionné lors de l’affichage de la OpenFileDialog ou SaveFileDialog.By default, the first item in the list (for example, the first file type) is selected when the OpenFileDialog or SaveFileDialog is displayed. Pour spécifier qu’un autre type de fichier doit être sélectionné, vous devez définir la propriété FilterIndex avant d’avoir affiché le OpenFileDialog ou le SaveFileDialog (en appelant ShowDialog).To specify that another file type to be selected, you set the FilterIndex property before showing the OpenFileDialog or SaveFileDialog (by calling ShowDialog).

S’applique à

Voir aussi