Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

FilterRepeater Class

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

Namespace:  System.Web.DynamicData
Assembly:  System.Web.DynamicData (in System.Web.DynamicData.dll)
public ref class FilterRepeater : public Repeater, 
	IWhereParametersProvider
<asp:FilterRepeater />

The FilterRepeater type exposes the following members.

  NameDescription
Public methodFilterRepeaterInitializes a new instance of the FilterRepeater class.
Top
  NameDescription
Protected propertyAdapterGets the browser-specific adapter for the control. (Inherited from Control.)
Public propertyAlternatingItemTemplateGets or sets the object implementing System.Web.UI::ITemplate that defines how alternating items in the control are displayed. (Inherited from Repeater.)
Public propertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public propertyBindingContainerInfrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Protected propertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public propertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public propertyClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected propertyClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Protected propertyContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public propertyContextTypeNameGets or sets the name of the data-source object to use to retrieve the data.
Public propertyControlsGets a System.Web.UI::ControlCollection that contains the child controls of the Repeater control. (Inherited from Repeater.)
Public propertyDataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public propertyDataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Public propertyDataMemberGets or sets the specific table in the DataSource to bind to the control. (Inherited from Repeater.)
Public propertyDataSourceGets or sets the data source that provides data for populating the list. (Inherited from Repeater.)
Public propertyDataSourceIDGets or sets the ID property of the data source control that the Repeater control should use to retrieve its data source. (Inherited from Repeater.)
Protected propertyDesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public propertyDynamicFilterContainerIdGets or sets the ID of the FilterRepeater control in an ItemTemplate instance.
Public propertyEnableThemingGets or sets a value indicating whether themes are applied to this control. (Inherited from Repeater.)
Public propertyEnableViewStateGets 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.)
Protected propertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public propertyFooterTemplateGets or sets the System.Web.UI::ITemplate that defines how the footer section of the Repeater control is displayed. (Inherited from Repeater.)
Protected propertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Public propertyHeaderTemplateGets or sets the System.Web.UI::ITemplate that defines how the header section of the Repeater control is displayed. (Inherited from Repeater.)
Public propertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected propertyIdSeparatorInfrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Protected propertyInitializedInfrastructure. Returns a value indicating whether the control has been initialized. (Inherited from Repeater.)
Protected propertyIsBoundUsingDataSourceIDInfrastructure. Gets a value indicating whether the DataSourceID property is set. (Inherited from Repeater.)
Protected propertyIsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected propertyIsDataBindingAutomaticGets a value that indicates whether data binding is automatic. (Inherited from Repeater.)
Protected propertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected propertyIsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public propertyItemsGets a collection of RepeaterItem objects in the Repeater control. (Inherited from Repeater.)
Public propertyItemTemplateGets or sets the System.Web.UI::ITemplate that defines how items in the Repeater control are displayed. (Inherited from Repeater.)
Public propertyItemTypeThe name of the model type for strongly typed data binding. (Inherited from Repeater.)
Protected propertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public propertyNamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control::ID property value. (Inherited from Control.)
Public propertyPageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public propertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public propertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Protected propertyRequiresDataBindingGets or sets a value indicating whether the Repeater control needs to bind to its specified data source. (Inherited from Repeater.)
Protected propertySelectArgumentsInfrastructure. Gets a DataSourceSelectArguments object that the Repeater control uses when retrieving data from a data source control. (Inherited from Repeater.)
Public propertySelectMethodThe name of the method to call in order to read data. (Inherited from Repeater.)
Public propertySeparatorTemplateGets or sets the System.Web.UI::ITemplate interface that defines how the separator between items is displayed. (Inherited from Repeater.)
Public propertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public propertySkinIDGets or sets the skin to apply to the control. (Inherited from Control.)
Public propertyTableGets the table that is associated with the FilterRepeater control.
Public propertyTableNameGets the name of the table to filter.
Public propertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
Public propertyTemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public propertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public propertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.)
Protected propertyViewStateGets 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.)
Protected propertyViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public propertyViewStateModeGets or sets the view-state mode of this control. (Inherited from Control.)
Public propertyVisibleGets or sets a value that specifies whether the control is displayed. (Overrides Control::Visible.)
Top
  NameDescription
Protected methodAddedControlCalled after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected methodAddParsedSubObjectNotifies 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.)
Public methodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected methodBeginRenderTracingBegins design-time tracing of rendering data. (Inherited from Control.)
Protected methodBuildProfileTreeInfrastructure. 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.)
Protected methodClearCachedClientIDInfrastructure. Sets the cached ClientID value to nullptr. (Inherited from Control.)
Protected methodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected methodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearEffectiveClientIDModeInfrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.)
Protected methodCreateChildControlsInfrastructure. 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.)
Protected methodCreateControlCollectionCreates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
Protected methodCreateControlHierarchyInfrastructure. Creates a control hierarchy, with or without the specified data source. (Inherited from Repeater.)
Protected methodCreateDataSourceSelectArgumentsInfrastructure. Returns the Empty value. (Inherited from Repeater.)
Protected methodCreateItemInfrastructure. Creates a RepeaterItem object with the specified item type and location within the Repeater control. (Inherited from Repeater.)
Public methodDataBind()Binds the FilterRepeater control to the data that is retrieved from a data source. (Overrides Repeater::DataBind().)
Protected methodDataBind(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.)
Protected methodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from Control.)
Public methodDisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected methodEndRenderTracingEnds design-time tracing of rendering data. (Inherited from Control.)
Protected methodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected methodEnsureDataBoundVerifies that the Repeater control requires data binding and that a valid data source control is specified before calling the DataBind method. (Inherited from Repeater.)
Protected methodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindControl(String)Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Protected methodFindControl(String, Int32)Infrastructure. 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.)
Public methodFocusSets input focus to a control. (Inherited from Control.)
Protected methodGetDataInfrastructure. Returns an IEnumerable interface from the data source. (Inherited from Repeater.)
Protected methodGetDesignModeStateInfrastructure. Gets design-time data for a control. (Inherited from Control.)
Protected methodGetFilteredColumnsReturns an enumeration of the sortable columns that belong to the table that is associated with the current FilterRepeater control.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUniqueIDRelativeToReturns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public methodGetWhereParametersGets the list of Where parameters to add to the Where parameter collection of the FilterRepeater control.
Public methodHasControlsDetermines if the server control contains any child controls. (Inherited from Control.)
Protected methodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected methodInitializeItemInfrastructure. Populates iteratively the specified RepeaterItem with a sub-hierarchy of child controls. (Inherited from Repeater.)
Protected methodIsLiteralContentInfrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected methodLoadControlStateRestores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected methodLoadViewStateRestores view-state information from a previous page request that was saved using the SaveViewState method. (Inherited from Repeater.)
Protected methodMapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnBubbleEventInfrastructure. Raises the ItemCommand event if the EventArgs parameter is an instance of RepeaterCommandEventArgs. (Inherited from Repeater.)
Protected methodOnCreatingModelDataSourceRaises the CreatingModelDataSource event. (Inherited from Repeater.)
Protected methodOnDataBindingInfrastructure. Raises the DataBinding event. (Inherited from Repeater.)
Protected methodOnDataPropertyChangedInfrastructure. Determines whether data binding is required. (Inherited from Repeater.)
Protected methodOnDataSourceViewChangedSets the RequiresDataBinding property to true. (Inherited from Repeater.)
Protected methodOnFilterItemCreatedCalled for every item and alternating item template that is being instantiated by this FilterRepeater control during data binding.
Protected methodOnInitRaises the Control::Init event to initialize the FilterRepeater control. (Overrides Repeater::OnInit(EventArgs).)
Protected methodOnItemCommandRaises the ItemCommand event. (Inherited from Repeater.)
Protected methodOnItemCreatedRaises the ItemCreated event. (Overrides Repeater::OnItemCreated(RepeaterItemEventArgs).)
Protected methodOnItemDataBoundRaises the ItemDataBound event. (Inherited from Repeater.)
Protected methodOnLoadRaises the Load event and performs other initialization. (Inherited from Repeater.)
Protected methodOnPreRenderRaises the PreRender event. (Inherited from Repeater.)
Protected methodOnUnloadRaises the Unload event. (Inherited from Control.)
Protected methodOpenFileGets a Stream used to read a file. (Inherited from Control.)
Protected methodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected methodRemovedControlCalled after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected methodRenderSends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.)
Protected methodRenderChildrenOutputs 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.)
Public methodRenderControl(HtmlTextWriter)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
Protected methodRenderControl(HtmlTextWriter, ControlAdapter)Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
Protected methodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public methodResolveClientUrlGets a URL that can be used by the browser. (Inherited from Control.)
Public methodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected methodSaveControlStateSaves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected methodSaveViewStateSaves any view-state changes that have occurred since the time the page was posted back to the server. (Inherited from Repeater.)
Protected methodSetDesignModeStateSets design-time data for a control. (Inherited from Control.)
Public methodSetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public methodSetTraceData(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.)
Public methodSetTraceData(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.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodTrackViewStateCauses tracking of view-state changes to the control so they can be stored in the control's StateBag object. (Inherited from Repeater.)
Top
  NameDescription
Public eventCallingDataMethodsOccurs when data methods are being called. (Inherited from Repeater.)
Public eventCreatingModelDataSourceOccurs when the ModelDataSource object is being created. (Inherited from Repeater.)
Public eventDataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
Public eventDisposedOccurs 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.)
Public eventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public eventItemCommandOccurs when a button is clicked in the Repeater control. (Inherited from Repeater.)
Public eventItemCreatedOccurs when an item is created in the Repeater control. (Inherited from Repeater.)
Public eventItemDataBoundOccurs after an item in the Repeater control is data-bound but before it is rendered on the page. (Inherited from Repeater.)
Public eventLoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
Public eventPreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public eventUnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
Top
  NameDescription
Public Extension MethodFindDataSourceControlReturns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension MethodFindFieldTemplateReturns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension MethodFindMetaTableReturns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Top
  NameDescription
Explicit interface implemetationPrivate propertyIControlBuilderAccessor::ControlBuilderFor a description of this member, see IControlBuilderAccessor::ControlBuilder. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor::GetDesignModeStateFor a description of this member, see IControlDesignerAccessor::GetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor::SetDesignModeStateFor a description of this member, see IControlDesignerAccessor::SetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor::SetOwnerControlInfrastructure. For a description of this member, see IControlDesignerAccessor::SetOwnerControl. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIControlDesignerAccessor::UserDataFor a description of this member, see IControlDesignerAccessor::UserData. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor::DataBindingsFor a description of this member, see IDataBindingsAccessor::DataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor::HasDataBindingsFor a description of this member, see IDataBindingsAccessor::HasDataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor::ExpressionsFor a description of this member, see IExpressionsAccessor::Expressions. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor::HasExpressionsFor a description of this member, see IExpressionsAccessor::HasExpressions. (Inherited from Control.)
Explicit interface implemetationPrivate methodIParserAccessor::AddParsedSubObjectFor a description of this member, see IParserAccessor::AddParsedSubObject. (Inherited from Control.)
Top

This type is obsolete. Use QueryableFilterRepeater, instead.

In this topic:

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>

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.