TableQuery.FilterString Property

Gets or sets the criteria used to filter data returned by the current TableQuery.

Namespace: DevExpress.DataAccess.Sql

Assembly: DevExpress.DataAccess.v24.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 that specifies the criteria used to filter data returned by the current TableQuery.

Remarks

The FilterString property allows you to filter the result set returned by TableQuery by specifying the required filter criteria. Note that if you want to filter a TableQuery by specified column values, you should 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#

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

VB.NET

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

To pass the existing query parameter (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"

To learn more about building filter criteria, see Simplified Criteria Syntax.