FileDialog.Filter Свойство

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

Значение свойства

Значение типа String, содержащее фильтр. Значением по умолчанию является Empty, означающее, что фильтр не применяется и отображаются все типы файлов.

Исключения

Примеры

В следующих примерах показано несколько типов строк фильтра, которые можно задать с помощью Filter свойства .

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

Комментарии

Если Filter имеет значение null или Empty, отображаются все файлы, а папки отображаются всегда.

Можно указать подмножество типов файлов для отображения, задав Filter свойство . Каждый тип файла может представлять определенный тип файла, например:

• Документы Word (*.doc)

• Листы Excel (*.xls)

• Презентации PowerPoint (*.ppt)

Кроме того, тип файла может представлять группу связанных типов файлов, например:

• Файлы Office (*.doc, *.xls, *.ppt)

• Все файлы (*.*)

Чтобы указать подмножество типов отображаемых файлов, необходимо задать Filter свойство со строковым значением ( строкой фильтра), которое указывает один или несколько типов файлов для фильтрации. Ниже показан ожидаемый формат строки фильтра.

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

Для описания каждого типа файлов используется следующий формат:

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

Элемент Метка — это понятное для человека строковое значение, описывающее тип файла, например следующее:

• "документы Word"

• "Листы Excel"

• "Презентации PowerPoint"

• "Файлы Office"

• "Все файлы"

Каждый тип файла должен быть описан по крайней мере одним расширением. Если используется несколько расширений , каждое расширение должно быть разделено точкой с запятой (";"). Пример:

• "*.doc"

• "*.xls;"

• "*.ppt"

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

• "*.*"

Ниже приведены полные примеры допустимых 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|*.*

Каждый тип файла, включенный в фильтр, добавляется как отдельный элемент в раскрывающийся список Файлы типа: в OpenFileDialog или SaveFileDialog, как показано на следующем рисунке.

Пользователь может выбрать тип файла из этого списка для фильтрации. По умолчанию первый элемент в списке (например, первый тип файла) выбирается при отображении OpenFileDialog или SaveFileDialog . Чтобы указать другой тип файла, необходимо задать FilterIndex свойство перед отображением OpenFileDialog или SaveFileDialog (путем вызова ShowDialog).

Применяется к

См. также раздел

• FileName
• FilterIndex