ASPxGridHeaderFilterEventArgs.AddValue(String, String, String) Method

Adds a new filter item with the specified filter criteria to the header filter.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

Declaration

C#

public void AddValue(
    string displayText,
    string value,
    string query
)

VB.NET

Public Sub AddValue(
    displayText As String,
    value As String,
    query As String
)

Parameters

Name	Type	Description
displayText	String	A String value that specifies the filter item’s display text.
value	String	A String value that specifies the filter item’s value.
query	String	A String value that represents the filter criteria.

Remarks

Note that the ASPxGridView header filter allows the use of HTML tags in the displayText parameter.

Example

This example shows how to create custom filter items and display them within the Units On Order column’s filter dropdown.

The image below shows the result:

C#

protected void ASPxGridView1_HeaderFilterFillItems(object sender, DevExpress.Web.ASPxGridViewHeaderFilterEventArgs e) {
     if (e.Column.FieldName != "UnitsOnOrder") return;
     e.AddValue("nonzero", string.Empty, "[UnitsOnOrder] != 0");
     e.AddValue(String.Format("from {0} to {1}", 0, 50), string.Empty, String.Format("[UnitsOnOrder] > {0} and [UnitsOnOrder] < {1}", 0, 50));
     e.AddValue(String.Format(">= {0}", 50), string.Empty, String.Format("[UnitsOnOrder] >= {0}", 50));
}

VB.NET

Protected Sub ASPxGridView1_HeaderFilterFillItems(ByVal sender As Object, ByVal e As DevExpress.Web.ASPxGridViewHeaderFilterEventArgs)
    If e.Column.FieldName <> "UnitsOnOrder" Then Return
    e.AddValue("nonzero", String.Empty, "[UnitsOnOrder] != 0")
    e.AddValue(String.Format("from {0} to {1}", 0, 50), String.Empty, String.Format("[UnitsOnOrder] > {0} and [UnitsOnOrder] < {1}", 0, 50))
    e.AddValue(String.Format(">= {0}", 50), String.Empty, String.Format("[UnitsOnOrder] >= {0}", 50))
End Sub