FileDialog.Filter Propriedade

Definição

Namespace:

Microsoft.Win32

Assembly:

PresentationFramework.dll

Obtém ou define a cadeia de caracteres de filtro que determina quais tipos de arquivos são exibidos 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 da propriedade

String

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

Exceções

ArgumentException

A cadeia de caracteres de filtro é inválida.

Exemplos

Os exemplos a seguir demonstram vários tipos de cadeias de caracteres 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()

Comentários

Se Filter for ou nullEmpty, todos os arquivos serão exibidos e as pastas sempre serão exibidas.

Você pode especificar um subconjunto de tipos de arquivo a ser exibido definindo a Filter propriedade. Cada tipo de arquivo pode representar um tipo específico de arquivo, como o seguinte:

• Documentos do Word (*.doc)

• Planilhas do Excel (*.xls)

• Apresentações do PowerPoint (*.ppt)

Como alternativa, um tipo de arquivo pode representar um grupo de tipos de arquivo relacionados, como o seguinte:

• Arquivos do Office (*.doc, *.xls, *.ppt)

• Todos os arquivos (*.*)

Para especificar um subconjunto dos tipos de arquivos exibidos, defina a Filter propriedade com um valor de cadeia de caracteres (a cadeia de caracteres de filtro) que especifica um ou mais tipos de arquivos pelos quais filtrar. O seguinte mostra o formato esperado da cadeia de caracteres de filtro:

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

Use o seguinte formato para descrever cada tipo de arquivo:

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

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

• "Documentos do Word"

• "Planilhas do Excel"

• "Apresentações do PowerPoint"

• "Arquivos do Office"

• "Todos os Arquivos"

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

• "*.doc"

• "*.xls;"

• "*.ppt"

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

• "*.*"

Veja a seguir exemplos completos de valores de cadeia de caracteres 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 arquivo incluído no filtro é adicionado como um item separado aos Arquivos do tipo: lista suspensa no OpenFileDialog ou SaveFileDialog, conforme mostrado na figura a seguir.

O usuário pode escolher um tipo de arquivo nessa lista para filtrar. Por padrão, o primeiro item da lista (por exemplo, o primeiro tipo de arquivo) é selecionado quando o OpenFileDialog item ou SaveFileDialog é exibido. Para especificar que outro tipo de arquivo a ser selecionado, defina a FilterIndex propriedade antes de mostrar o OpenFileDialog ou SaveFileDialog (chamando ShowDialog).

Confira também

• FileName
• FilterIndex