FileDialog.Filter Propriedade

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Obtém ou define a cadeia de caracteres do filtro de nome de arquivo atual, que determina as opções que aparecem na caixa “Salvar como tipo de arquivo” ou “Arquivos do tipo” caixa na caixa de diálogo.

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

Valor da propriedade

String

As opções de filtragem de arquivo disponíveis na caixa de diálogo.

Exceções

ArgumentException

O formato de Filter é inválido.

Exemplos

O exemplo de código a seguir usa a OpenFileDialog implementação de FileDialog e ilustra a criação, a configuração de propriedades e a exibição da caixa de diálogo. O exemplo usa as Filter propriedades e FilterIndex para fornecer uma lista de filtros para o usuário. O exemplo requer um formulário com um Button colocado nele e o System.IO namespace adicionado a ele.

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

Comentários

Para cada opção de filtragem, a cadeia de caracteres de filtro contém uma descrição do filtro, seguida pela barra vertical (|) e pelo padrão de filtro. As cadeias de caracteres para diferentes opções de filtragem são separadas pela barra vertical.

Veja a seguir um exemplo de uma cadeia de caracteres de filtro:

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

Você pode adicionar vários padrões de filtro a um filtro separando os tipos de arquivo com ponto e vírgula, por exemplo:

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

Use a FilterIndex propriedade para definir qual opção de filtragem é mostrada primeiro para o usuário.

Confira também

• CheckFileExists
• FilterIndex