FileDialog.Filter Propriedade

Definição

Obtém ou define a cadeia de filtro que determina que tipos de ficheiros são exibidos a partir do OpenFileDialog ou 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 Propriedade

A String que contém o filtro. O padrão é Empty, o que significa que não é aplicado nenhum filtro e todos os tipos de ficheiros são exibidos.

Exceções

A cadeia de filtro é inválida.

Exemplos

Os exemplos seguintes demonstram vários tipos de cadeias de filtro que podem ser definidas usando a Filter propriedade.

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()

Observações

Se Filter for ou null ou Empty, todos os ficheiros são exibidos, e as pastas são sempre apresentadas.

Pode especificar um subconjunto de tipos de ficheiros a serem exibidos definindo a Filter propriedade. Cada tipo de ficheiro pode representar um tipo específico de ficheiro, como o seguinte:

  • Word Documentos (*.doc)

  • Excel Fichas de Exercícios (*.xls)

  • PowerPoint Apresentações (*.ppt)

Em alternativa, um tipo de ficheiro pode representar um grupo de tipos de ficheiros relacionados, tais como os seguintes:

  • Ficheiros de Escritório (*.doc, *.xls, *.ppt)

  • Todos os ficheiros (*.*)

Para especificar um subconjunto dos tipos de ficheiros que são exibidos, define a Filter propriedade com um valor de cadeia (a cadeia de filtro) que especifica um ou mais tipos de ficheiros a filtrar. O seguinte mostra o formato esperado da cadeia de filtros:

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

Utiliza o seguinte formato para descrever cada tipo de ficheiro:

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

A parte Rótulo é um valor de cadeia legível por humanos que descreve o tipo de ficheiro, como segue:

  • "Documentos Word"

  • "Fichas de Excel"

  • "Apresentações em PowerPoint"

  • "Ficheiros de Escritório"

  • "Todos os Ficheiros"

Cada tipo de ficheiro deve ser descrito por pelo menos uma Extensão. Se for usada mais do que uma extensão , cada extensão deve ser separada por um ponto e vírgula (";"). Por exemplo:

  • "*.doc"

  • "*.xls;"

  • "*.ppt"

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

  • "*.*"

Seguem-se exemplos completos de valores de cadeia 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 ficheiro incluído no filtro é adicionado como um item separado à lista suspensa Ficheiros do tipo: na OpenFileDialog ou SaveFileDialog, como mostrado na figura seguinte.

Usando o FileDialog.Filter na caixa de diálogo Open usando

O utilizador pode escolher um tipo de ficheiro desta lista para filtrar. Por defeito, o primeiro item da lista (por exemplo, o primeiro tipo de ficheiro) é selecionado quando o OpenFileDialog ou SaveFileDialog é exibido. Para especificar que outro tipo de ficheiro a ser selecionado, define a FilterIndex propriedade antes de mostrar o OpenFileDialog ou SaveFileDialog (chamando ShowDialog).

Aplica-se a

Ver também