FileDialog.Filter Propiedad

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

Obtiene o establece la cadena actual de filtro de nombres de archivo, que determina las opciones que aparecen en los cuadros "Guardar como archivo de tipo" o "Archivos de tipo" del cuadro 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 de propiedad

String

Opciones de filtrado de archivo disponibles en el cuadro de diálogo de archivo.

Excepciones

ArgumentException

El formato de Filter no es válido.

Ejemplos

En el ejemplo de código siguiente se usa la implementación de FileDialog e ilustra la OpenFileDialog creación, el establecimiento de propiedades y la visualización del cuadro de diálogo. En el ejemplo se usan las Filter propiedades y FilterIndex para proporcionar una lista de filtros para el usuario. En el ejemplo se requiere un formulario con un Button colocado en él y el System.IO espacio de nombres agregado a él.

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

Comentarios

Para cada opción de filtrado, la cadena de filtro contiene una descripción del filtro, seguida de la barra vertical (|) y el patrón de filtro. Las cadenas de diferentes opciones de filtrado están separadas por la barra vertical.

A continuación se muestra un ejemplo de una cadena de filtro:

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

Puede agregar varios patrones de filtro a un filtro separando los tipos de archivo con punto y coma, por ejemplo:

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

Utilice la propiedad para establecer la FilterIndex opción de filtrado que se muestra primero al usuario.

Consulte también

• CheckFileExists
• FilterIndex