FileDialog.Filter Właściwość

Definicja

Pobiera lub ustawia bieżący ciąg filtru nazwy pliku, który określa opcje, które pojawiają się w polu "Zapisz jako typ pliku" lub "Pliki typu" w oknie dialogowym.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

Wartość właściwości

String

Opcje filtrowania plików dostępne w oknie dialogowym.The file filtering options available in the dialog box.

Wyjątki

Filter Format jest nieprawidłowy.Filter format is invalid.

Przykłady

Poniższy przykład kodu używa OpenFileDialog implementacji FileDialog i ilustruje tworzenie, Ustawianie właściwości i wyświetlanie okna dialogowego.The following code example uses the OpenFileDialog implementation of FileDialog and illustrates creating, setting of properties, and showing the dialog box. W przykładzie zastosowano Filter właściwości i, FilterIndex Aby podać listę filtrów dla użytkownika.The example uses the Filter and FilterIndex properties to provide a list of filters for the user. Przykład wymaga formularza z Button umieszczonym na nim i System.IO przestrzenią nazw dodanego do niego.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

Uwagi

Dla każdej opcji filtrowania ciąg filtru zawiera opis filtru, a po nim pionowy pasek (|) i wzorzec filtru.For each filtering option, the filter string contains a description of the filter, followed by the vertical bar (|) and the filter pattern. Ciągi dla różnych opcji filtrowania są oddzielone pionowym paskiem.The strings for different filtering options are separated by the vertical bar.

Poniżej znajduje się przykład ciągu filtru:The following is an example of a filter string:

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

Można dodać kilka wzorców filtrów do filtru, rozdzielając typy plików średnikami, na przykład: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 (*.*)|*.*

Użyj FilterIndex właściwości, aby ustawić, która opcja filtrowania jest pokazywana najpierw użytkownikowi.Use the FilterIndex property to set which filtering option is shown first to the user.

Dotyczy

Zobacz też