SelectQuery.FilterString Property

Specifies the criteria used to filter data returned by the current SelectQuery.

Namespace: DevExpress.DataAccess.Sql

Assembly: DevExpress.DataAccess.v19.2.dll

Declaration

C#

[DefaultValue(null)]
[LocalizableCategory(DataAccessStringId.QueryPropertyGridTableSelectionCategoryName)]
public string FilterString { get; set; }

VB.NET

<DefaultValue(Nothing)>
<LocalizableCategory(DataAccessStringId.QueryPropertyGridTableSelectionCategoryName)>
Public Property FilterString As String

Property Value

Type	Default	Description
String	*null*	A String value, specifying the filter criteria.

Remarks

The FilterString property allows you to filter the result set returned by SelectQuery by specifying the required filter criteria. To filter a SelectQuery by specified column values, precede a column name with a corresponding table name. For instance, you can filter the SalesPerson table by the Beverages category in the following way.

C#

SelectQuery query = new SelectQuery("Query 1");
query.AddTable("SalesPerson").SelectColumns("CategoryName", "Extended Price");
query.FilterString = "[SalesPerson].[CategoryName] = 'Beverages'";

VB.NET

Dim query As New SelectQuery("Query 1")
query.AddTable("SalesPerson").SelectColumns("CategoryName", "Extended Price")
query.FilterString = "[SalesPerson].[CategoryName] = 'Beverages'"

To pass a QueryParameter (which can be accessed using the SqlQuery.Parameters property) to the filter string, precede the parameter name with the ? sign.

C#

//...
QueryParameter queryParam1 = new QueryParameter("Parameter1", typeof(string), "Beverages");
query.Parameters.Add(queryParam1);
query.FilterString = "[SalesPerson].[CategoryName] = ?Parameter1";

VB.NET

'...
Dim queryParam1 As New QueryParameter("Parameter1", GetType(String), "Beverages")
query.Parameters.Add(queryParam1)
query.FilterString = "[SalesPerson].[CategoryName] = ?Parameter1"

Note

If a table or column name includes dots, enclose the table/column name in square brackets.

For example, if you have a table with the “table.name” name and a column with the “column.name” name, refer to the column in the following manner: [[table.name\].[column.name\]]. If you have only the column name with a dot, refer to it as follows: [tablename.[column.name\]]. As you can see, you should use \ to avoid closing the expression beforehand.

To learn more about building filter criteria, see Creating Criteria.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FilterString property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-create-data-access-library-data-sources-at-runtime-t424210/CS/SqlDataSourceSnippets/Code.cs#L56

    query.Parameters.Add(parameter);
    query.FilterString = "CategoryID = ?catID";
}

Reporting_how-to-dynamically-pass-xtrareport-parameters-into-the-underlying-sqldatasource-to-t158360/CS/WindowsFormsApplication1/Form1.cs#L28

sq.Parameters.Add(queryParameter1);
sq.FilterString = "CategoryID = ?p1";

VB.NET

how-to-create-data-access-library-data-sources-at-runtime-t424210/VB/SqlDataSourceSnippets/Code.vb#L37

    query.Parameters.Add(parameter)
    query.FilterString = "CategoryID = ?catID"
End Sub

Reporting_how-to-dynamically-pass-xtrareport-parameters-into-the-underlying-sqldatasource-to-t158360/VB/WindowsFormsApplication1/Form1.vb#L26

sq.Parameters.Add(queryParameter1)
sq.FilterString = "CategoryID = ?p1"