XpoDataSource.Criteria Property

Gets or sets the string representation of criteria used to filter persistent objects to be retrieved by the data source control.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

Declaration

C#

[DefaultValue(null)]
public string Criteria { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property Criteria As String

Property Value

Type	Default	Description
String	null	A String value that represents the filter criteria.

Remarks

The string format is the same as in the CriteriaOperator.Parse method’s stringCriteria parameter. You can add question marks to the string to indicate the position of parameter values. When the expression is evaluated, the question marks are replaced with parameter values. To provide parameter values, use the XpoDataSource.CriteriaParameters property.

The following code snippet demonstrates two equivalent criteria applied to the XpoDataSource1 and XpoDataSource2 data source controls.

C#

XpoDataSource1.Criteria = "[Category] = 'Saloon' AND [Price] < 100000";
XpoDataSource2.Criteria = "[Category] = ? AND [Price] < ?";
XpoDataSource2.CriteriaParameters.Add("Category", "Saloon");
XpoDataSource2.CriteriaParameters.Add("Price", "100000");

VB.NET

XpoDataSource1.Criteria = "[Category] = 'Saloon' AND [Price] < 100000"
XpoDataSource2.Criteria = "[Category] = ? AND [Price] < ?"
XpoDataSource2.CriteriaParameters.Add("Category", "Saloon")
XpoDataSource2.CriteriaParameters.Add("Price", "100000")

The following criteria are identical because they refer to the same parameter values.

C#

XpoDataSource2.Criteria = "[Category] = ? AND [Price] < ?";
XpoDataSource2.Criteria = "[Category] = ?Category AND [Price] < ?Price";

VB.NET

XpoDataSource2.Criteria = "[Category] = ? AND [Price] < ?"
XpoDataSource2.Criteria = "[Category] = ?Category AND [Price] < ?Price"

Note

Criteria can only be built on persistent properties. If you change the Criteria property’s value or change any of the criteria parameters available via the XpoDataSource.CriteriaParameters property, the data source is refreshed immediately.