FileDialog.Filter Propriété

Définition

Obtient ou définit la chaîne de filtrage des noms de fichiers en cours, qui détermine les choix disponibles dans les zones « Enregistrer sous » ou « Types de fichiers » de la boîte de dialogue.Gets or sets the current file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box.

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é

Options de filtrage des fichiers disponibles dans la boîte de dialogue.The file filtering options available in the dialog box.

Exceptions

Le format Filter n'est pas valide.Filter format is invalid.

Exemples

L’exemple de code suivant utilise OpenFileDialog l’implémentation FileDialog de et illustre la création, la définition de propriétés et l’indication de la boîte de dialogue.The following code example uses the OpenFileDialog implementation of FileDialog and illustrates creating, setting of properties, and showing the dialog box. L’exemple utilise les Filter propriétés FilterIndex et pour fournir une liste de filtres pour l’utilisateur.The example uses the Filter and FilterIndex properties to provide a list of filters for the user. L’exemple requiert un formulaire avec un Button placé sur celui-ci System.IO et l’espace de noms qui lui est ajouté.The example requires a form with a Button placed on it and the System.IO namespace added to it.

private:
   void button1_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      Stream^ myStream;
      OpenFileDialog^ openFileDialog1 = gcnew OpenFileDialog;

      openFileDialog1->InitialDirectory = "c:\\";
      openFileDialog1->Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*";
      openFileDialog1->FilterIndex = 2;
      openFileDialog1->RestoreDirectory = true;

      if ( openFileDialog1->ShowDialog() == System::Windows::Forms::DialogResult::OK )
      {
         if ( (myStream = openFileDialog1->OpenFile()) != nullptr )
         {
            // Insert code to read the stream here.
            myStream->Close();
         }
      }
   }
var fileContent = string.Empty;
var filePath = string.Empty;

using (OpenFileDialog openFileDialog = new OpenFileDialog())
{
    openFileDialog.InitialDirectory = "c:\\";
    openFileDialog.Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*";
    openFileDialog.FilterIndex = 2;
    openFileDialog.RestoreDirectory = true;

    if (openFileDialog.ShowDialog() == DialogResult.OK)
    {
        //Get the path of specified file
        filePath = openFileDialog.FileName;

        //Read the contents of the file into a stream
        var fileStream = openFileDialog.OpenFile();

        using (StreamReader reader = new StreamReader(fileStream))
        {
            fileContent = reader.ReadToEnd();
        }
    }
}

MessageBox.Show(fileContent, "File Content at path: " + filePath, MessageBoxButtons.OK);
Private Sub button1_Click(ByVal sender As Object, ByVal e As System.EventArgs)
    Dim myStream As Stream = Nothing
    Dim openFileDialog1 As New OpenFileDialog()

    openFileDialog1.InitialDirectory = "c:\"
    openFileDialog1.Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*"
    openFileDialog1.FilterIndex = 2
    openFileDialog1.RestoreDirectory = True

    If openFileDialog1.ShowDialog() = System.Windows.Forms.DialogResult.OK Then
        Try
            myStream = openFileDialog1.OpenFile()
            If (myStream IsNot Nothing) Then
                ' Insert code to read the stream here.
            End If
        Catch Ex As Exception
            MessageBox.Show("Cannot read file from disk. Original error: " & Ex.Message)
        Finally
            ' Check this again, since we need to make sure we didn't throw an exception on open.
            If (myStream IsNot Nothing) Then
                myStream.Close()
            End If
        End Try
    End If
End Sub

Remarques

Pour chaque option de filtrage, la chaîne de filtrage contient une description du filtre, suivie de la barre verticale|() et du modèle de filtre.For each filtering option, the filter string contains a description of the filter, followed by the vertical bar (|) and the filter pattern. Les chaînes pour les différentes options de filtrage sont séparées par la barre verticale.The strings for different filtering options are separated by the vertical bar.

Voici un exemple de chaîne de filtrage:The following is an example of a filter string:

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

Vous pouvez ajouter plusieurs modèles de filtre à un filtre en séparant les types de fichiers par des points-virgules, par exemple: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 (*.*)|*.*

Utilisez la FilterIndex propriété pour définir l’option de filtrage qui est présentée en premier à l’utilisateur.Use the FilterIndex property to set which filtering option is shown first to the user.

S’applique à

Voir aussi