FileDialog.Filter Propiedad

Definición

Espacio de nombres:

Microsoft.Win32

Ensamblado:

PresentationFramework.dll

Obtiene o establece la cadena de filtro que determina qué tipos de archivo se muestran desde OpenFileDialog o SaveFileDialog.

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

Un objeto String que contiene el filtro. El valor predeterminado es Empty, que indica que no se aplica ningún filtro y que se muestran todos los tipos de archivo.

Excepciones

ArgumentException

La cadena del filtro no es válida.

Ejemplos

En los ejemplos siguientes se muestran varios tipos de cadenas de filtro que se pueden establecer mediante la Filter propiedad .

OpenFileDialog dlg = new OpenFileDialog();

// Show all files
dlg.Filter = string.Empty;

dlg.ShowDialog();

Dim dlg As New OpenFileDialog()

' Show all files
dlg.Filter = String.Empty

dlg.ShowDialog()

OpenFileDialog dlg = new OpenFileDialog();

// Show all files
dlg.Filter = null;

dlg.ShowDialog();

Dim dlg As New OpenFileDialog()

' Show all files
dlg.Filter = Nothing

dlg.ShowDialog()

OpenFileDialog dlg = new OpenFileDialog();

// Filter by Word Documents
dlg.Filter = "Word Documents|*.doc";

dlg.ShowDialog();

Dim dlg As New OpenFileDialog()

' Filter by Word Documents
dlg.Filter = "Word Documents|*.doc"

dlg.ShowDialog()

OpenFileDialog dlg = new OpenFileDialog();

// Filter by Excel Worksheets
dlg.Filter = "Excel Worksheets|*.xls";

dlg.ShowDialog();

Dim dlg As New OpenFileDialog()

' Filter by Excel Worksheets
dlg.Filter = "Excel Worksheets|*.xls"

dlg.ShowDialog()

OpenFileDialog dlg = new OpenFileDialog();

// Filter by PowerPoint Presentations
dlg.Filter = "PowerPoint Presentations|*.ppt";

dlg.ShowDialog();

Dim dlg As New OpenFileDialog()

' Filter by PowerPoint Presentations
dlg.Filter = "PowerPoint Presentations|*.ppt"

dlg.ShowDialog()

OpenFileDialog dlg = new OpenFileDialog();

// Filter by Office Files
dlg.Filter = "Office Files|*.doc;*.xls;*.ppt";

dlg.ShowDialog();

Dim dlg As New OpenFileDialog()

' Filter by Office Files
dlg.Filter = "Office Files|*.doc;*.xls;*.ppt"

dlg.ShowDialog()

OpenFileDialog dlg = new OpenFileDialog();

// Filter by All Files
dlg.Filter = "All Files|*.*";

dlg.ShowDialog();

Dim dlg As New OpenFileDialog()

' Filter by All Files
dlg.Filter = "All Files|*.*"

dlg.ShowDialog()

OpenFileDialog dlg = new OpenFileDialog();

// Filter by Word Documents OR Excel Worksheets OR PowerPoint Presentations 
//           OR Office Files 
//           OR All Files
dlg.Filter = "Word Documents|*.doc|Excel Worksheets|*.xls|PowerPoint Presentations|*.ppt" +
             "|Office Files|*.doc;*.xls;*.ppt" +
             "|All Files|*.*";

dlg.ShowDialog();

Dim dlg As New OpenFileDialog()

' Filter by Word Documents OR Excel Worksheets OR PowerPoint Presentations 
'           OR Office Files 
'           OR All Files
dlg.Filter = "Word Documents|*.doc|Excel Worksheets|*.xls|PowerPoint Presentations|*.ppt" & "|Office Files|*.doc;*.xls;*.ppt" & "|All Files|*.*"

dlg.ShowDialog()

Comentarios

Si Filter es o nullEmpty, se muestran todos los archivos y las carpetas siempre se muestran.

Puede especificar un subconjunto de tipos de archivo que se van a mostrar estableciendo la Filter propiedad . Cada tipo de archivo puede representar un tipo específico de archivo, como el siguiente:

• documentos de Word (*.doc)

• Hojas de cálculo de Excel (*.xls)

• Presentaciones de PowerPoint (*.ppt)

Como alternativa, un tipo de archivo puede representar un grupo de tipos de archivo relacionados, como los siguientes:

• Archivos de Office (*.doc, *.xls, *.ppt)

• Todos los archivos (*.*)

Para especificar un subconjunto de los tipos de archivos que se muestran, establezca la Filter propiedad con un valor de cadena (la cadena de filtro) que especifique uno o varios tipos de archivos por los que filtrar. A continuación se muestra el formato esperado de la cadena de filtro:

FileType1[[|FileType2]...[|FileTypeN]]

Use el siguiente formato para describir cada tipo de archivo:

Label|Extension1[[;Extension2]...[;ExtensionN]]

El elemento Label es un valor de cadena legible que describe el tipo de archivo, como el siguiente:

• "documentos de Word"

• "Hojas de cálculo de Excel"

• "Presentaciones de PowerPoint"

• "Archivos de Office"

• "Todos los archivos"

Cada tipo de archivo debe describirse por al menos una extensión. Si se usa más de una extensión , cada extensión debe estar separada por un punto y coma (";"). Por ejemplo:

• "*.doc"

• "*.xls;"

• "*.ppt"

• "*.doc;*.xls;*.ppt"

• "*.*"

A continuación se muestran ejemplos completos de valores de cadena válidos Filter :

• Word Documents|*.doc

• Excel Worksheets|*.xls

• PowerPoint Presentations|*.ppt

• Office Files|*.doc;*.xls;*.ppt

• All Files|*.*

• Word Documents|*.doc|Excel Worksheets|*.xls|PowerPoint Presentations|*.ppt|Office Files|*.doc;*.xls;*.ppt|All Files|*.*

Cada tipo de archivo que se incluye en el filtro se agrega como un elemento independiente a la lista desplegable Archivos de tipo : en o OpenFileDialogSaveFileDialog, como se muestra en la ilustración siguiente.

El usuario puede elegir un tipo de archivo de esta lista por el que filtrar. De forma predeterminada, el primer elemento de la lista (por ejemplo, el primer tipo de archivo) se selecciona cuando se muestra o OpenFileDialogSaveFileDialog . Para especificar que se seleccione otro tipo de archivo, establezca la FilterIndex propiedad antes de mostrar o OpenFileDialogSaveFileDialog (llamando a ShowDialog).

Consulte también

• FileName
• FilterIndex