This topic has not yet been rated Rate this topic

DynamicFilterExpression Class

Modifies a database query by using a value from specified filter control.

System.Object
  System.Web.UI.WebControls.Expressions.DataSourceExpression
    System.Web.DynamicData.DynamicFilterExpression

Namespace:  System.Web.DynamicData
Assembly:  System.Web.DynamicData (in System.Web.DynamicData.dll)
public class DynamicFilterExpression : DataSourceExpression

The DynamicFilterExpression type exposes the following members.

  Name Description
Public method DynamicFilterExpression Initializes a new instance of the DynamicFilterExpression class.
Top
  Name Description
Protected property Context Gets the HttpContext instance of the owner control. (Inherited from DataSourceExpression.)
Public property ControlID Gets or sets the filter control identifier.
Public property DataSource Gets the data source object that is associated with the owner control. (Inherited from DataSourceExpression.)
Protected property IsTrackingViewState Gets a value that indicates whether a data source expression object is tracking its view state changes. (Inherited from DataSourceExpression.)
Protected property Owner Gets the owner control. (Inherited from DataSourceExpression.)
Protected property ViewState Gets an instance of the StateBag class that contains the current view state information. (Inherited from DataSourceExpression.)
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetQueryable Gets the modified query using the current filter value. (Overrides DataSourceExpression.GetQueryable(IQueryable).)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method LoadViewState Loads the state of the values in the DataSourceExpression object that must be persisted. (Inherited from DataSourceExpression.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method SaveViewState Saves the current view state of the DataSourceExpression object. (Inherited from DataSourceExpression.)
Public method SetContext Initializes the expression with data source information. (Overrides DataSourceExpression.SetContext(Control, HttpContext, IQueryableDataSource).)
Public method SetDirty Marks the DataSourceExpression object so that its state will be saved in view state. (Inherited from DataSourceExpression.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method TrackViewState Tracks view state changes of the DataSourceExpression object so that the changes can be stored in the StateBag object for the data source expression object. (Inherited from DataSourceExpression.)
Top
  Name Description
Explicit interface implemetation Private property IStateManager.IsTrackingViewState When implemented by a class, gets a value that indicates whether a data source expression object is tracking its view state changes. (Inherited from DataSourceExpression.)
Explicit interface implemetation Private method IStateManager.LoadViewState When implemented by a class, loads the previously saved view state of the data source expression object. (Inherited from DataSourceExpression.)
Explicit interface implemetation Private method IStateManager.SaveViewState When implemented by a class, saves the current view state of the DataSourceExpression object. (Inherited from DataSourceExpression.)
Explicit interface implemetation Private method IStateManager.TrackViewState When implemented by a class, tracks view state changes of the DataSourceExpression object so that the changes can be stored in the StateBag object for the data source expression object. (Inherited from DataSourceExpression.)
Top

The DynamicFilterExpression class enables you to modify a database query using the values that are assigned in a DynamicFilter control. This control delegates the task of building of the IQueryable query to a specialized control such as QueryableFilterRepeater control or DynamicFilter control.

The filter controls in turn delegate the building of the query to the filter template that they reference. The query is then executed by the data source control that is referenced by the QueryExtender control.

To use the DynamicFilterExpression class in a page, you follow these steps:

  • Add a QueryExtender control to the page.

  • Set the TargetControlID property of the QueryExtender control to reference the data source control.

  • Add a DynamicFilterExpression object as a child of the QueryExtender control.

  • Set the ControlID property of the DynamicFilterExpression object to reference the filter control.

In the previous steps it is assumed that the related filter controls, data-bound controls, and data source control are defined in the page.

The following example shows how to use the DynamicFilterExpression control to select a filter template in a page. The filter template is selected by the DynamicFilter control that is identified by DynamicFilterExpression control through its ControID property.

<asp:QueryExtender ID="QueryExtender1" 
    TargetControlID="GridDataSource" runat="server">
    <asp:DynamicFilterExpression ControlID="CategoryFilterID" />
</asp:QueryExtender>

.NET Framework

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ