FileDialog.Filter Eigenschaft

  • Referenz

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Ruft die aktuelle Filterzeichenfolge für Dateinamen ab, die die im Dialogfeld im Feld „Speichern unter“ oder „Dateityp“ angezeigte Auswahl bestimmt, oder legt diese fest.

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

Eigenschaftswert

String

Die im Dialogfeld verfügbaren Optionen zum Filtern von Dateien.

Ausnahmen

ArgumentException

Das Filter-Format ist ungültig.

Beispiele

Das folgende Codebeispiel verwendet die Implementierung von FileDialog und veranschaulicht das OpenFileDialog Erstellen, Festlegen von Eigenschaften und das Anzeigen des Dialogfelds. Im Beispiel werden die Filter Eigenschaften und FilterIndex verwendet, um eine Liste von Filtern für den Benutzer bereitzustellen. Das Beispiel erfordert ein Formular mit einem Button platzierten und dem System.IO hinzugefügten Namespace.

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

Hinweise

Für jede Filteroption enthält die Filterzeichenfolge eine Beschreibung des Filters, gefolgt von der vertikalen Leiste (|) und dem Filtermuster. Die Zeichenfolgen für verschiedene Filteroptionen werden durch den vertikalen Balken getrennt.

Es folgt ein Beispiel für eine Filterzeichenfolge:

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

Sie können einem Filter mehrere Filtermuster hinzufügen, indem Sie die Dateitypen durch Semikolons trennen, z. B.:

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

Verwenden Sie die FilterIndex -Eigenschaft, um festzulegen, welche Filteroption dem Benutzer zuerst angezeigt wird.

Gilt für:

Weitere Informationen