FileDialog.Filter-Eigenschaft

Artikel
08/20/2007

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.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

Syntax

'Declaration
<LocalizableAttribute(True)> _
Public Property Filter As String
'Usage
Dim instance As FileDialog
Dim value As String

value = instance.Filter

instance.Filter = value

[LocalizableAttribute(true)] 
public string Filter { get; set; }

[LocalizableAttribute(true)] 
public:
property String^ Filter {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_Filter ()

/** @property */
public void set_Filter (String value)

public function get Filter () : String

public function set Filter (value : String)

Eigenschaftenwert

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

Ausnahmen

Ausnahmetyp	Bedingung
ArgumentException	Das Filter-Format ist ungültig.

Hinweise

Die Filterzeichenfolge enthält für jede Filteroption eine Beschreibung des Filters, gefolgt vom senkrechten Strich (|) und dem Filtermuster. Die Zeichenfolgen für unterschiedliche Filteroptionen sind ebenfalls durch den senkrechten Strich getrennt.

Folgendes ist ein Beispiel einer Filterzeichenfolge: "Text files (*.txt)|*.txt|All files (*.*)|*.*"

Sie können mehrere Filtermuster zu einem Filter hinzufügen, indem Sie je zwei Dateitypen durch ein Semikolon voneinander trennen, z. B. "Image Files(*.BMP;*.JPG;*.GIF)|*.BMP;*.JPG;*.GIF|All files (*.*)|*.*".

Mit der FilterIndex-Eigenschaft können Sie festlegen, welche Filteroption den Benutzern zuerst angezeigt wird.

Beispiel

Im folgenden Codebeispiel wird die OpenFileDialog-Implementierung von FileDialog verwendet und veranschaulicht, wie ein Dialogfeld erstellt und nach Festlegen der Eigenschaften angezeigt wird. Im Beispiel wird mithilfe der Filter-Eigenschaft und der FilterIndex-Eigenschaft eine Liste von Filtern für den Benutzer bereitgestellt. Voraussetzung für dieses Beispiel ist ein Formular, auf dem Button platziert und dem der System.IO-Namespace hinzugefügt wurde.

Private Sub button1_Click(sender As Object, e As System.EventArgs)
    Dim myStream As Stream
    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() = DialogResult.OK Then
        myStream = openFileDialog1.OpenFile()
        If Not (myStream Is Nothing) Then
            ' Insert code to read the stream here.
            myStream.Close()
        End If
    End If
End Sub

private void button1_Click(object sender, System.EventArgs e)
{
    Stream myStream;
    OpenFileDialog openFileDialog1 = new OpenFileDialog();

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

    if(openFileDialog1.ShowDialog() == DialogResult.OK)
    {
        if((myStream = openFileDialog1.OpenFile())!= null)
        {
            // Insert code to read the stream here.
            myStream.Close();
        }
    }
}

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() == ::DialogResult::OK )
      {
         if ( (myStream = openFileDialog1->OpenFile()) != nullptr )
         {
            // Insert code to read the stream here.
            myStream->Close();
         }
      }
   }

protected void button1_Click(Object sender, System.EventArgs e)
{
    Stream myStream;
    OpenFileDialog openFileDialog1 = new OpenFileDialog();
    openFileDialog1.set_InitialDirectory("c:\\");
    openFileDialog1.set_Filter(
        "txt files (*.txt)|*.txt|All files (*.*)|*.*");
    openFileDialog1.set_FilterIndex(2);
    openFileDialog1.set_RestoreDirectory(true);
    if (openFileDialog1.ShowDialog().Equals(get_DialogResult().OK)) {
        if ((myStream = openFileDialog1.OpenFile()) != null) {
            // Insert code to read the stream here.
            myStream.Close();
        }
    }
} //button1_Click

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0, 1.0

Siehe auch

Referenz

FileDialog-Klasse
FileDialog-Member
System.Windows.Forms-Namespace
FileDialog.CheckFileExists-Eigenschaft
FilterIndex

Freigeben über