FileDialog.filter Property

Description

Gets or sets the current file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box.

For each filtering option, the filter string contains a description of the filter and the filter pattern as specified in parentheses and separated by semi-colons. Multiple filters are separated by a double semi-colon. These are illustrated below.

The following is an example of a filter string:

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

You can add several filter patterns to a filter by separating the file types with semicolons, for example:

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

Syntax

# Get the value of the property.
propertyValue = fileDialog_var.filter

# Set the value of the property.
fileDialog_var.filter = propertyValue

#include <Core/UserInterface/FileDialog.h>

// Get the value of the property.
string propertyValue = fileDialog_var->filter();

// Set the value of the property, where value_var is a string.
bool returnValue = fileDialog_var->filter(value_var);

Property Value

Samples

Version