SqlDataSource::FilterExpression Property
Updated: October 2009
Gets or sets a filtering expression that is applied when the Select method is called.
Assembly: System.Web (in System.Web.dll)
| Exception | Condition |
|---|---|
| NotSupportedException | The FilterExpression property was set and the SqlDataSource is in DataReader mode. |
The FilterExpression property value is a format string expression (a string that is processed by the StringFormat method) that uses the values in the FilterExpression collection for any substitution parameters that are included in the string. The filter expression syntax is the same syntax that is accepted by the RowFilter property, because the filter expression is applied to the RowFilter property of the DataView object that is returned by the Select method. For more information, see Expression.
If you add parameters to the FilterParameters collection, you can also include format string placeholders (for example, "{0}") in the expression to substitute for parameter values. The placeholders are replaced according to the index of the parameter in the FilterParameters collection. If an object in the FilterParameters collection is nullptr, the object will be replaced by an empty string.
You can include parameters in the FilterExpression property. If the parameter is a string or character type, enclose the parameter in single quotation marks. Quotation marks are not required, if the parameter is a numeric type.The FilterParameters collection contains the parameters that are evaluated for the placeholders that are found in the FilterExpression property.
The SqlDataSource control supports filtering data only when in the DataSet mode.
The FilterExpression property delegates to the FilterExpression property of the SqlDataSourceView object that is associated with the SqlDataSource control.
The following code example demonstrates how to retrieve data from the Northwind database and filter it using a FilterExpression string and the FilterParameters collection. The FilterExpression property is applied any time the Select method is executed to retrieve data. In this example, the FilterExpression contains a placeholder for a filter parameter, which is contained in the FilterParameters collection. In addition, the filter parameter is a ControlParameter object that is bound to the SelectedValue property of the DropDownList control. Because the DropDownList control has its AutoPostBack property set to true, any change in the selection for the DropDownList control causes the page to post information back to the server and the GridView control to rebind to the data source control with the new filter.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.