FilterRepeater Class

Definition

Namespace:

System.Web.DynamicData

Assembly:

System.Web.DynamicData.dll

Represents a control that enumerates table columns that can be filtered.

public ref class FilterRepeater : System::Web::UI::WebControls::Repeater, System::Web::DynamicData::IWhereParametersProvider

public class FilterRepeater : System.Web.UI.WebControls.Repeater, System.Web.DynamicData.IWhereParametersProvider

type FilterRepeater = class
    inherit Repeater
    interface IWhereParametersProvider

Public Class FilterRepeater
Inherits Repeater
Implements IWhereParametersProvider

Inheritance

Object

Control

Repeater

FilterRepeater

Implements

IWhereParametersProvider

Remarks

This type is obsolete. Use QueryableFilterRepeater, instead.

In this topic:

• Introduction

• Declarative Syntax

Introduction

The FilterRepeater control is a control in the ASP.NET Dynamic Data framework. It automatically renders controls that can be used to filter data rows that are displayed for a table. The filters work by providing a list of Where parameters to the data source for each supported column type. By default, Dynamic Data filters foreign-key and Boolean columns and renders them by using a DropDownList list control.

The FilterRepeater control is a specialized Repeater control that automatically binds to a collection of filterable columns for the table that is displayed in the current page. For example, if a request is made for /Products/List.aspx, the FilterRepeater control binds to the columns in the Products table. The table is chosen based on the route that matches the request. It can also be overridden by setting the TableName and ContextTypeName properties of the FilterRepeater control.

To display the filter UI, the ItemTemplate template of the FilterRepeater control must contain a control with a known ID. By default, the known ID is "DynamicFilter". The control in the item template must derive from FilterUserControlBase. When data binding occurs, the FilterRepeater control initializes an instance of the filter control with information about the column to filter.

Declarative Syntax

<asp:FilterRepeater  
    ContextTypeName="string"  
    DataMember="string"  
    DataSource="string"  
    DataSourceID="string"  
    DynamicFilterContainerId="string"  
    EnableTheming="True|False"  
    EnableViewState="True|False"  
    ID="string"  
    OnDataBinding="DataBinding event handler"  
    OnDisposed="Disposed event handler"  
    OnInit="Init event handler"  
    OnItemCommand="ItemCommand event handler"  
    OnItemCreated="ItemCreated event handler"  
    OnItemDataBound="ItemDataBound event handler"  
    OnLoad="Load event handler"  
    OnPreRender="PreRender event handler"  
    OnUnload="Unload event handler"  
    runat="server"  
    TableName="string"  
    Visible="True|False"  
>  
        <AlternatingItemTemplate>  
            <!-- child controls -->  
        </AlternatingItemTemplate>  
        <FooterTemplate>  
            <!-- child controls -->  
        </FooterTemplate>  
        <HeaderTemplate>  
            <!-- child controls -->  
        </HeaderTemplate>  
        <ItemTemplate>  
            <!-- child controls -->  
        </ItemTemplate>  
        <SeparatorTemplate>  
            <!-- child controls -->  
        </SeparatorTemplate>  
</asp:FilterRepeater>  

Constructors

FilterRepeater()

Initializes a new instance of the FilterRepeater class.

Properties

Adapter	Gets the browser-specific adapter for the control. (Inherited from Control)
AlternatingItemTemplate	Gets or sets the object implementing ITemplate that defines how alternating items in the control are displayed. (Inherited from Repeater)
AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control)
BindingContainer	Gets the control that contains this control's data binding. (Inherited from Control)
ChildControlsCreated	Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control)
ClientID	Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control)
ClientIDMode	Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control)
ClientIDSeparator	Gets a character value representing the separator character used in the ClientID property. (Inherited from Control)
Context	Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control)
ContextTypeName	Gets or sets the name of the data-source object to use to retrieve the data.
Controls	Gets a ControlCollection that contains the child controls of the Repeater control. (Inherited from Repeater)
DataItemContainer	Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control)
DataKeysContainer	Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control)
DataMember	Gets or sets the specific table in the DataSource to bind to the control. (Inherited from Repeater)
DataSource	Gets or sets the data source that provides data for populating the list. (Inherited from Repeater)
DataSourceID	Gets or sets the ID property of the data source control that the Repeater control should use to retrieve its data source. (Inherited from Repeater)
DesignMode	Gets a value indicating whether a control is being used on a design surface. (Inherited from Control)
DynamicFilterContainerId	Gets or sets the ID of the FilterRepeater control in an ItemTemplate instance.
EnableTheming	Gets or sets a value indicating whether themes are applied to this control. (Inherited from Repeater)
EnableViewState	Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control)
Events	Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control)
FooterTemplate	Gets or sets the ITemplate that defines how the footer section of the Repeater control is displayed. (Inherited from Repeater)
HasChildViewState	Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control)
HeaderTemplate	Gets or sets the ITemplate that defines how the header section of the Repeater control is displayed. (Inherited from Repeater)
ID	Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control)
IdSeparator	Gets the character used to separate control identifiers. (Inherited from Control)
Initialized	Returns a value indicating whether the control has been initialized. (Inherited from Repeater)
IsBoundUsingDataSourceID	Gets a value indicating whether the DataSourceID property is set. (Inherited from Repeater)
IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state. (Inherited from Control)
IsDataBindingAutomatic	Gets a value that indicates whether data binding is automatic. (Inherited from Repeater)
IsTrackingViewState	Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control)
IsViewStateEnabled	Gets a value indicating whether view state is enabled for this control. (Inherited from Control)
Items	Gets a collection of RepeaterItem objects in the Repeater control. (Inherited from Repeater)
ItemTemplate	Gets or sets the ITemplate that defines how items in the Repeater control are displayed. (Inherited from Repeater)
ItemType	The name of the model type for strongly typed data binding. (Inherited from Repeater)
LoadViewStateByID	Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control)
NamingContainer	Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control)
Page	Gets a reference to the Page instance that contains the server control. (Inherited from Control)
Parent	Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control)
RenderingCompatibility	Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control)
RequiresDataBinding	Gets or sets a value indicating whether the Repeater control needs to bind to its specified data source. (Inherited from Repeater)
SelectArguments	Gets a DataSourceSelectArguments object that the Repeater control uses when retrieving data from a data source control. (Inherited from Repeater)
SelectMethod	The name of the method to call in order to read data. (Inherited from Repeater)
SeparatorTemplate	Gets or sets the ITemplate interface that defines how the separator between items is displayed. (Inherited from Repeater)
Site	Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control)
SkinID	Gets or sets the skin to apply to the control. (Inherited from Control)
Table	Gets the table that is associated with the FilterRepeater control.
TableName	Gets the name of the table to filter.
TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from Control)
TemplateSourceDirectory	Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control)
UniqueID	Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control)
ValidateRequestMode	Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control)
ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control)
ViewStateIgnoresCase	Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control)
ViewStateMode	Gets or sets the view-state mode of this control. (Inherited from Control)
Visible	Gets or sets a value that specifies whether the control is displayed.

Methods

AddedControl(Control, Int32)	Called after a child control is added to the Controls collection of the Control object. (Inherited from Control)
AddParsedSubObject(Object)	Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control)
ApplyStyleSheetSkin(Page)	Applies the style properties defined in the page style sheet to the control. (Inherited from Control)
BeginRenderTracing(TextWriter, Object)	Begins design-time tracing of rendering data. (Inherited from Control)
BuildProfileTree(String, Boolean)	Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control)
ClearCachedClientID()	Sets the cached ClientID value to null. (Inherited from Control)
ClearChildControlState()	Deletes the control-state information for the server control's child controls. (Inherited from Control)
ClearChildState()	Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control)
ClearChildViewState()	Deletes the view-state information for all the server control's child controls. (Inherited from Control)
ClearEffectiveClientIDMode()	Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control)
CreateChildControls()	Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Repeater)
CreateControlCollection()	Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control)
CreateControlHierarchy(Boolean)	Creates a control hierarchy, with or without the specified data source. (Inherited from Repeater)
CreateDataSourceSelectArguments()	Returns the Empty value. (Inherited from Repeater)
CreateItem(Int32, ListItemType)	Creates a RepeaterItem object with the specified item type and location within the Repeater control. (Inherited from Repeater)
DataBind()	Binds the FilterRepeater control to the data that is retrieved from a data source.
DataBind(Boolean)	Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control)
DataBindChildren()	Binds a data source to the server control's child controls. (Inherited from Control)
Dispose()	Enables a server control to perform final clean up before it is released from memory. (Inherited from Control)
EndRenderTracing(TextWriter, Object)	Ends design-time tracing of rendering data. (Inherited from Control)
EnsureChildControls()	Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control)
EnsureDataBound()	Verifies that the Repeater control requires data binding and that a valid data source control is specified before calling the DataBind() method. (Inherited from Repeater)
EnsureID()	Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindControl(String)	Searches the current naming container for a server control with the specified id parameter. (Inherited from Control)
FindControl(String, Int32)	Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control)
Focus()	Sets input focus to a control. (Inherited from Control)
GetData()	Returns an IEnumerable interface from the data source. (Inherited from Repeater)
GetDesignModeState()	Gets design-time data for a control. (Inherited from Control)
GetFilteredColumns()	Returns an enumeration of the sortable columns that belong to the table that is associated with the current FilterRepeater control.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetRouteUrl(Object)	Gets the URL that corresponds to a set of route parameters. (Inherited from Control)
GetRouteUrl(RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters. (Inherited from Control)
GetRouteUrl(String, Object)	Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control)
GetRouteUrl(String, RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUniqueIDRelativeTo(Control)	Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control)
GetWhereParameters(IDynamicDataSource)	Gets the list of Where parameters to add to the Where parameter collection of the FilterRepeater control.
HasControls()	Determines if the server control contains any child controls. (Inherited from Control)
HasEvents()	Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control)
InitializeItem(RepeaterItem)	Populates iteratively the specified RepeaterItem with a sub-hierarchy of child controls. (Inherited from Repeater)
IsLiteralContent()	Determines if the server control holds only literal content. (Inherited from Control)
LoadControlState(Object)	Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control)
LoadViewState(Object)	Restores view-state information from a previous page request that was saved using the SaveViewState() method. (Inherited from Repeater)
MapPathSecure(String)	Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnBubbleEvent(Object, EventArgs)	Raises the ItemCommand event if the EventArgs parameter is an instance of RepeaterCommandEventArgs. (Inherited from Repeater)
OnCreatingModelDataSource(CreatingModelDataSourceEventArgs)	Raises the CreatingModelDataSource event. (Inherited from Repeater)
OnDataBinding(EventArgs)	Raises the DataBinding event. (Inherited from Repeater)
OnDataPropertyChanged()	Determines whether data binding is required. (Inherited from Repeater)
OnDataSourceViewChanged(Object, EventArgs)	Sets the RequiresDataBinding property to true. (Inherited from Repeater)
OnFilterItemCreated(RepeaterItem)	Called for every item and alternating item template that is being instantiated by this FilterRepeater control during data binding.
OnInit(EventArgs)	Raises the Init event to initialize the FilterRepeater control.
OnItemCommand(RepeaterCommandEventArgs)	Raises the ItemCommand event. (Inherited from Repeater)
OnItemCreated(RepeaterItemEventArgs)	Raises the ItemCreated event.
OnItemDataBound(RepeaterItemEventArgs)	Raises the ItemDataBound event. (Inherited from Repeater)
OnLoad(EventArgs)	Raises the Load event and performs other initialization. (Inherited from Repeater)
OnPreRender(EventArgs)	Raises the PreRender event. (Inherited from Repeater)
OnUnload(EventArgs)	Raises the Unload event. (Inherited from Control)
OpenFile(String)	Gets a Stream used to read a file. (Inherited from Control)
RaiseBubbleEvent(Object, EventArgs)	Assigns any sources of the event and its information to the control's parent. (Inherited from Control)
RemovedControl(Control)	Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control)
Render(HtmlTextWriter)	Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control)
RenderChildren(HtmlTextWriter)	Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control)
RenderControl(HtmlTextWriter)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control)
RenderControl(HtmlTextWriter, ControlAdapter)	Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control)
ResolveAdapter()	Gets the control adapter responsible for rendering the specified control. (Inherited from Control)
ResolveClientUrl(String)	Gets a URL that can be used by the browser. (Inherited from Control)
ResolveUrl(String)	Converts a URL into one that is usable on the requesting client. (Inherited from Control)
SaveControlState()	Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control)
SaveViewState()	Saves any view-state changes that have occurred since the time the page was posted back to the server. (Inherited from Repeater)
SetDesignModeState(IDictionary)	Sets design-time data for a control. (Inherited from Control)
SetRenderMethodDelegate(RenderMethod)	Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control)
SetTraceData(Object, Object)	Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control)
SetTraceData(Object, Object, Object)	Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control)
ToString()	Returns a string that represents the current object. (Inherited from Object)
TrackViewState()	Causes tracking of view-state changes to the control so they can be stored in the control's StateBag object. (Inherited from Repeater)

Events

CallingDataMethods	Occurs when data methods are being called. (Inherited from Repeater)
CreatingModelDataSource	Occurs when the ModelDataSource object is being created. (Inherited from Repeater)
DataBinding	Occurs when the server control binds to a data source. (Inherited from Control)
Disposed	Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control)
Init	Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control)
ItemCommand	Occurs when a button is clicked in the Repeater control. (Inherited from Repeater)
ItemCreated	Occurs when an item is created in the Repeater control. (Inherited from Repeater)
ItemDataBound	Occurs after an item in the Repeater control is data-bound but before it is rendered on the page. (Inherited from Repeater)
Load	Occurs when the server control is loaded into the Page object. (Inherited from Control)
PreRender	Occurs after the Control object is loaded but prior to rendering. (Inherited from Control)
Unload	Occurs when the server control is unloaded from memory. (Inherited from Control)

Explicit Interface Implementations

IControlBuilderAccessor.ControlBuilder	For a description of this member, see ControlBuilder. (Inherited from Control)
IControlDesignerAccessor.GetDesignModeState()	For a description of this member, see GetDesignModeState(). (Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)	For a description of this member, see SetDesignModeState(IDictionary). (Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control)	For a description of this member, see SetOwnerControl(Control). (Inherited from Control)
IControlDesignerAccessor.UserData	For a description of this member, see UserData. (Inherited from Control)
IDataBindingsAccessor.DataBindings	For a description of this member, see DataBindings. (Inherited from Control)
IDataBindingsAccessor.HasDataBindings	For a description of this member, see HasDataBindings. (Inherited from Control)
IExpressionsAccessor.Expressions	For a description of this member, see Expressions. (Inherited from Control)
IExpressionsAccessor.HasExpressions	For a description of this member, see HasExpressions. (Inherited from Control)
IParserAccessor.AddParsedSubObject(Object)	For a description of this member, see AddParsedSubObject(Object). (Inherited from Control)

Extension Methods

FindDataSourceControl(Control)	Returns the data source that is associated with the data control for the specified control.
FindFieldTemplate(Control, String)	Returns the field template for the specified column in the specified control's naming container.
FindMetaTable(Control)	Returns the metatable object for the containing data control.
GetDefaultValues(INamingContainer)	Gets the collection of the default values for the specified data control.
GetMetaTable(INamingContainer)	Gets the table metadata for the specified data control.
SetMetaTable(INamingContainer, MetaTable)	Sets the table metadata for the specified data control.
SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>)	Sets the table metadata and default value mapping for the specified data control.
SetMetaTable(INamingContainer, MetaTable, Object)	Sets the table metadata and default value mapping for the specified data control.
TryGetMetaTable(INamingContainer, MetaTable)	Determines whether table metadata is available.
EnableDynamicData(INamingContainer, Type)	Enables Dynamic Data behavior for the specified data control.
EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>)	Enables Dynamic Data behavior for the specified data control.
EnableDynamicData(INamingContainer, Type, Object)	Enables Dynamic Data behavior for the specified data control.