FileDialog.Filter Właściwość

  • Odwołanie

Definicja

Przestrzeń nazw:
System.Windows.Forms
Zestaw:
System.Windows.Forms.dll

Pobiera lub ustawia bieżący ciąg filtru nazwy pliku, który określa opcje wyświetlane w oknie dialogowym "Zapisz jako typ pliku" lub "Pliki typu".

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.

Wyjątki

ArgumentException

Filter format jest nieprawidłowy.

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. W przykładzie użyto Filter właściwości i FilterIndex w celu udostępnienia listy filtrów dla użytkownika. Przykład wymaga formularza z umieszczonym Button na nim i dodanym System.IO do niego obszarem nazw.

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 następnie pionowy pasek (|) i wzorzec filtru. Ciągi dla różnych opcji filtrowania są oddzielone pionowym paskiem.

Oto przykład ciągu filtru:

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

Do filtru można dodać kilka wzorców filtru, oddzielając typy plików średnikami, na przykład:

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

FilterIndex Użyj właściwości , aby ustawić, która opcja filtrowania jest wyświetlana jako pierwsza dla użytkownika.

Dotyczy

Zobacz też