ASPxGridBase.FilterExpression Property

Gets or sets the filter criterion which is applied to the grid.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v22.1.dll

Declaration

C#

[DefaultValue("")]
public string FilterExpression { get; set; }

VB.NET

<DefaultValue("")>
Public Property FilterExpression As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the filter criterion.

Remarks

Concept

• ASPxGridView - Filtering
• Criteria Language Syntax
• Criteria Operators

Examples

The following examples illustrate different scenarios on how to filter the grid data.

• Filter data by dates.

  C#

  DateTime date1 = new DateTime(1995, 1, 1);
  DateTime date2 = new DateTime(1995, 7, 1);
  string filter = String.Format("[OrderDate] > #{0}# And [OrderDate] < #{1}#",
                      date1.ToShortDateString(), date2.ToShortDateString());
  ASPxGridView1.FilterExpression = filter;
  

  VB.NET

  Dim date1 As DateTime = New DateTime(1995, 1, 1)
  Dim date2 As DateTime = New DateTime(1995, 7, 1)
  Dim filter As String = String.Format("[OrderDate] > #{0}# And [OrderDate] < #{1}#", date1..ToString("yyyy-MM-dd"), date2..ToString("yyyy-MM-dd"))
  ASPxGridView1.FilterExpression = filter
  

• Applying a filter that selects departments whose budget is greater than 100,000 and that are located in Monterey. The filter criteria are displayed within the ASPxGridView’s Title Panel.

  C#

  ASPxGridView1.FilterExpression = "[Budget] > 100000  AND [Location] = 'Monterey'";
  ASPxGridView1.SettingsText.Title = ASPxGridView1.FilterExpression;
  

  VB.NET

  ASPxGridView1.FilterExpression = "[Budget] > 100000  AND [Location] = 'Monterey'"
  ASPxGridView1.SettingsText.Title = ASPxGridView1.FilterExpression
  

  Result:

  

• Select data rows whose product name starts with “ch”.

  C#

  ASPxGridView1.FilterExpression = "StartsWith([ProductName], 'ch')";
  

  VB.NET

  ASPxGridView1.FilterExpression = "StartsWith([ProductName], 'ch')"
  

• Get field names from the filter expression value.

  C#

  int start = -1;
  List<string> fields = new List<string>();
  for (int i = 0; i < ASPxGridView1.FilterExpression.Length; i++) {
      if (ASPxGridView1.FilterExpression[i] == '[')
          start = i;
      if (ASPxGridView1.FilterExpression[i] == ']') {
          fields.Add(ASPxGridView1.FilterExpression.Substring(start + 1, i - start - 1));
          start = -1;
      }
  }
  

  VB.NET

      Dim start As Integer = -1
      Dim fields As List(Of String) = New List(Of String)()
  
      For i As Integer = 0 To ASPxGridView1.FilterExpression.Length - 1
          If ASPxGridView1.FilterExpression(i) = "["c Then start = i
  
          If ASPxGridView1.FilterExpression(i) = "]"c Then
              fields.Add(ASPxGridView1.FilterExpression.Substring(start + 1, i - start - 1))
              start = -1
          End If
      Next
  

Online Demos

• ASPxGridView - Filter Control
• ASPxCardView - Filter Control
• ASPxVerticalGrid - Filter Control