.NET Framework Class Library
DataList Class

A data bound list control that displays items using templates.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
Syntax
<[%$TOPIC/7efxhktc_en-us_VS_110_2_0_0_0_0%]("SelectedValue")> _
Public Class DataList _
	Inherits [%$TOPIC/7efxhktc_en-us_VS_110_2_0_0_0_1%] _
	Implements [%$TOPIC/7efxhktc_en-us_VS_110_2_0_0_0_2%], [%$TOPIC/7efxhktc_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/7efxhktc_en-us_VS_110_2_0_1_0_0%]("SelectedValue")]
public class DataList : [%$TOPIC/7efxhktc_en-us_VS_110_2_0_1_0_1%], [%$TOPIC/7efxhktc_en-us_VS_110_2_0_1_0_2%], 
	[%$TOPIC/7efxhktc_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/7efxhktc_en-us_VS_110_2_0_2_0_0%](L"SelectedValue")]
public ref class DataList : public [%$TOPIC/7efxhktc_en-us_VS_110_2_0_2_0_1%], 
	[%$TOPIC/7efxhktc_en-us_VS_110_2_0_2_0_2%], [%$TOPIC/7efxhktc_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/7efxhktc_en-us_VS_110_2_0_3_0_0%]("SelectedValue")>]
type DataList =  
    class 
        inherit [%$TOPIC/7efxhktc_en-us_VS_110_2_0_3_0_1%] 
        interface [%$TOPIC/7efxhktc_en-us_VS_110_2_0_3_0_2%] 
        interface [%$TOPIC/7efxhktc_en-us_VS_110_2_0_3_0_3%] 
    end
<asp:DataList />

The DataList type exposes the following members.

Constructors
  NameDescription
Public method DataListInitializes a new instance of the DataList class.
Top
Properties
  NameDescription
Public property AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected property AdapterGets the browser-specific adapter for the control. (Inherited from Control.)
Public property AlternatingItemStyleGets the style properties for alternating items in the DataList control.
Public property AlternatingItemTemplateGets or sets the template for alternating items in the DataList.
Public property AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public property AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public property BackColorGets or sets the background color of the Web server control. (Inherited from WebControl.)
Public property BindingContainerInfrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public property BorderColorGets or sets the border color of the Web control. (Inherited from WebControl.)
Public property BorderStyleGets or sets the border style of the Web server control. (Inherited from WebControl.)
Public property BorderWidthGets or sets the border width of the Web server control. (Inherited from WebControl.)
Public property CaptionGets or sets the text to render in an HTML caption element in the control. This property is provided to make the control more accessible to users of assistive technology devices. (Inherited from BaseDataList.)
Public property CaptionAlignGets or sets the horizontal or vertical position of the HTML caption element in a control. This property is provided to make the control more accessible to users of assistive technology devices. (Inherited from BaseDataList.)
Public property CellPaddingGets or sets the amount of space between the contents of a cell and the cell's border. (Inherited from BaseDataList.)
Public property CellSpacingGets or sets the amount of space between cells. (Inherited from BaseDataList.)
Protected property ChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public property ClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public property ClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected property ClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Protected property ContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public property ControlsGets a System.Web.UIControlCollection object that contains a collection of child controls in a data listing control. (Inherited from BaseDataList.)
Public property ControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public property ControlStyleCreatedGets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.)
Public property CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public property DataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public property DataKeyFieldGets or sets the key field in the data source specified by the DataSource property. (Inherited from BaseDataList.)
Public property DataKeysGets a DataKeyCollection object that stores the key values of each record in a data listing control. (Inherited from BaseDataList.)
Protected property DataKeysArrayGets an ArrayList object that contains the key values of each record in a data listing control. (Inherited from BaseDataList.)
Public property DataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Public property DataMemberGets or sets the specific data member in a multimember data source to bind to a data listing control. (Inherited from BaseDataList.)
Public property DataSourceGets or sets the source containing a list of values used to populate the items within the control. (Inherited from BaseDataList.)
Public property DataSourceIDGets or sets the ID property of the data source control that the data listing control should use to retrieve its data source. (Inherited from BaseDataList.)
Protected property DesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public property EditItemIndexGets or sets the index number of the selected item in the DataList control to edit.
Public property EditItemStyleGets the style properties for the item selected for editing in the DataList control.
Public property EditItemTemplateGets or sets the template for the item selected for editing in the DataList control.
Public property EnabledGets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public property EnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public property EnableViewStateGets 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 property EventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public property ExtractTemplateRowsGets or sets a value that indicates whether the rows of a Table control, defined in each template of a DataList control, are extracted and displayed.
Public property FontGets the font properties associated with the Web server control. (Inherited from WebControl.)
Public property FooterStyleGets the style properties for the footer section of the DataList control.
Public property FooterTemplateGets or sets the template for the footer section of the DataList control.
Public property ForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public property GridLinesGets or sets the grid line style for the DataList control when the RepeatLayout property is set to RepeatLayout.Table. (Overrides BaseDataListGridLines.)
Public property HasAttributesGets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected property HasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Public property HeaderStyleGets the style properties for the heading section of the DataList control.
Public property HeaderTemplateGets or sets the template for the heading section of the DataList control.
Public property HeightGets or sets the height of the Web server control. (Inherited from WebControl.)
Public property HorizontalAlignGets or sets the horizontal alignment of a data listing control within its container. (Inherited from BaseDataList.)
Public property IDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected property IdSeparatorInfrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Protected property InitializedGets a value indicating whether the control has been initialized. (Inherited from BaseDataList.)
Protected property IsBoundUsingDataSourceIDGets a value indicating whether the DataSourceID property is set. (Inherited from BaseDataList.)
Protected property IsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected property IsEnabledGets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected property IsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected property IsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public property ItemsGets a collection of DataListItem objects representing the individual items within the control.
Public property ItemStyleGets the style properties for the items in the DataList control.
Public property ItemTemplateGets or sets the template for the items in the DataList control.
Protected property LoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public property NamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ControlID property value. (Inherited from Control.)
Public property PageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public property ParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public property RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Public property RepeatColumnsGets or sets the number of columns to display in the DataList control.
Public property RepeatDirectionGets or sets whether the DataList control displays vertically or horizontally.
Public property RepeatLayoutGets or sets whether the control is displayed in a table or flow layout.
Protected property RequiresDataBindingGets or sets a value indicating whether the data listing control needs to bind to its specified data source. (Inherited from BaseDataList.)
Protected property SelectArgumentsGets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control. (Inherited from BaseDataList.)
Public property SelectedIndexGets or sets the index of the selected item in the DataList control.
Public property SelectedItemGets the selected item in the DataList control.
Public property SelectedItemStyleGets the style properties for the selected item in the DataList control.
Public property SelectedItemTemplateGets or sets the template for the selected item in the DataList control.
Public property SelectedValueGets the value of the key field for the selected data list item.
Public property SeparatorStyleGets the style properties of the separator between each item in the DataList control.
Public property SeparatorTemplateGets or sets the template for the separator between the items of the DataList control.
Public property ShowFooterGets or sets a value indicating whether the footer section is displayed in the DataList control.
Public property ShowHeaderGets or sets a value indicating whether the header section is displayed in the DataList control.
Public property SiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public property SkinIDGets or sets the skin to apply to the control. (Inherited from WebControl.)
Public property StyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.)
Public property SupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Inherited from BaseDataList.)
Public property TabIndexGets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected property TagKeyGets the HTML tag that is used to render the DataList control. (Overrides WebControlTagKey.)
Protected property TagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public property TemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
Public property TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public property ToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public property UniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public property UseAccessibleHeaderGets or sets a value indicating whether the data listing control renders its header in an accessible format. This property is provided to make the control more accessible to users of assistive technology devices. (Inherited from BaseDataList.)
Public property ValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.)
Protected property ViewStateGets 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 property ViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public property ViewStateModeGets or sets the view-state mode of this control. (Inherited from Control.)
Public property VisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public property WidthGets or sets the width of the Web server control. (Inherited from WebControl.)
Top
Methods
  NameDescription
Protected method AddAttributesToRenderAdds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method AddedControlCalled after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected method AddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection collection. (Inherited from BaseDataList.)
Public method ApplyStyleCopies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.)
Public method ApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected method BeginRenderTracingBegins design-time tracing of rendering data. (Inherited from Control.)
Protected method BuildProfileTreeInfrastructure. 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 method ClearCachedClientIDInfrastructure. Sets the cached ClientID value to . (Inherited from Control.)
Protected method ClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected method ClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearEffectiveClientIDModeInfrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.)
Public method CopyBaseAttributesCopies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method CreateChildControlsInfrastructure. Creates a child control using the view state. (Inherited from BaseDataList.)
Protected method CreateControlCollectionCreates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
Protected method CreateControlHierarchyCreates the control hierarchy that is used to render the data list control, with or without the specified data source. (Overrides BaseDataListCreateControlHierarchy(Boolean).)
Protected method CreateControlStyleCreates the default style object that is used internally by the DataList control to implement all style related properties. (Overrides WebControlCreateControlStyle.)
Protected method CreateDataSourceSelectArgumentsCreates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified. (Inherited from BaseDataList.)
Protected method CreateItemCreates a DataListItem object.
Public method DataBindBinds the control and all its child controls to the specified data source. (Inherited from BaseDataList.)
Protected method 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.)
Protected method DataBindChildrenBinds a data source to the server control's child controls. (Inherited from Control.)
Public method DisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected method EndRenderTracingEnds design-time tracing of rendering data. (Inherited from Control.)
Protected method EnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected method EnsureDataBoundVerifies that the data listing control requires data binding and that a valid data source control is specified before calling the DataBind method. (Inherited from BaseDataList.)
Protected method EnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public method Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindControl(String)Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Protected method FindControl(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 method FocusSets input focus to a control. (Inherited from Control.)
Protected method GetDataReturns an IEnumerable-implemented object that represents the data source. (Inherited from BaseDataList.)
Protected method GetDesignModeStateInfrastructure. Gets design-time data for a control. (Inherited from Control.)
Public method GetHashCodeServes as the default hash function. (Inherited from Object.)
Public method GetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public method GetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public method GetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public method GetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method GetUniqueIDRelativeToReturns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public method HasControlsDetermines if the server control contains any child controls. (Inherited from Control.)
Protected method HasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected method InitializeItemInitializes a DataListItem object based on the specified templates and styles for the list-item type.
Protected method IsLiteralContentInfrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected method LoadControlStateRestores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected method LoadViewStateLoads the previously saved view state of the DataList control. (Overrides WebControlLoadViewState(Object).)
Protected method MapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method MergeStyleCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method OnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Overrides ControlOnBubbleEvent(Object, EventArgs).)
Protected method OnCancelCommandRaises the CancelCommand event. This allows you to provide a custom handler for the event.
Protected method OnDataBindingInfrastructure. Raises the DataBinding event of a BaseDataList control. (Inherited from BaseDataList.)
Protected method OnDataPropertyChangedCalled when one of the base data source identification properties is changed, to rebind the data-bound control to its data. (Inherited from BaseDataList.)
Protected method OnDataSourceViewChangedRaises the DataSourceViewChanged event. (Inherited from BaseDataList.)
Protected method OnDeleteCommandRaises the DeleteCommand event. This allows you to provide a custom handler for the event.
Protected method OnEditCommandRaises the EditCommand event. This allows you to provide a custom handler for the event.
Protected method OnInitRaises the Init event for the DataList control. (Overrides BaseDataListOnInit(EventArgs).)
Protected method OnItemCommandRaises the ItemCommand event. This allows you to provide a custom handler for the event.
Protected method OnItemCreatedRaises the ItemCreated event. This allows you to provide a custom handler for the event.
Protected method OnItemDataBoundRaises the ItemDataBound event. This allows you to provide a custom handler for the event.
Protected method OnLoadInfrastructure. Raises the Load event. (Inherited from BaseDataList.)
Protected method OnPreRenderInfrastructure. Raises the PreRender event. (Inherited from BaseDataList.)
Protected method OnSelectedIndexChangedRaises the SelectedIndexChanged event of a BaseDataList control. (Inherited from BaseDataList.)
Protected method OnUnloadRaises the Unload event. (Inherited from Control.)
Protected method OnUpdateCommandRaises the UpdateCommand event. This allows you to provide a custom handler for the event.
Protected method OpenFileGets a Stream used to read a file. (Inherited from Control.)
Protected method PrepareControlHierarchyPrepares the control hierarchy for rendering in the DataList control. (Overrides BaseDataListPrepareControlHierarchy.)
Protected method RaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected method RemovedControlCalled after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected method RenderInfrastructure. Renders the control to the specified HTML writer. (Inherited from BaseDataList.)
Public method RenderBeginTagRenders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method RenderChildrenOutputs 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.)
Protected method RenderContentsRenders the list items in the DataList control. (Overrides WebControlRenderContents(HtmlTextWriter).)
Public method 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.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter)Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
Public method RenderEndTagRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method ResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public method ResolveClientUrlGets a URL that can be used by the browser. (Inherited from Control.)
Public method ResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected method SaveControlStateSaves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected method SaveViewStateSaves the changes to the control view state since the time the page was posted back to the server. (Overrides WebControlSaveViewState.)
Protected method SetDesignModeStateSets design-time data for a control. (Inherited from Control.)
Public method SetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public method 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.)
Public method 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.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Protected method TrackViewStateTracks view-state changes to the DataList control so they can be stored in the control's ViewState property. (Overrides WebControlTrackViewState.)
Top
Events
  NameDescription
Public event CancelCommandOccurs when the Cancel button is clicked for an item in the DataList control.
Public event DataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
Public event DeleteCommandOccurs when the Delete button is clicked for an item in the DataList control.
Public event DisposedOccurs 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 event EditCommandOccurs when the Edit button is clicked for an item in the DataList control.
Public event InitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public event ItemCommandOccurs when any button is clicked in the DataList control.
Public event ItemCreatedOccurs on the server when an item in the DataList control is created.
Public event ItemDataBoundOccurs when an item is data bound to the DataList control.
Public event LoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
Public event PreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public event SelectedIndexChangedOccurs when a different item is selected in a data listing control between posts to the server. (Inherited from BaseDataList.)
Public event UnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
Public event UpdateCommandOccurs when the Update button is clicked for an item in the DataList control.
Top
Extension Methods
  NameDescription
Public Extension Method EnableDynamicData(Type)Overloaded. Enables Dynamic Data behavior for the specified data control. (Defined by DataControlExtensions.)
Public Extension Method EnableDynamicData(Type, Object)Overloaded. Enables Dynamic Data behavior for the specified data control. (Defined by DataControlExtensions.)
Public Extension Method EnableDynamicData(Type, IDictionaryString, Object)Overloaded. Enables Dynamic Data behavior for the specified data control. (Defined by DataControlExtensions.)
Public Extension Method FindDataSourceControlReturns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension Method FindFieldTemplateReturns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension Method FindMetaTableReturns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Public Extension Method GetDefaultValuesGets the collection of the default values for the specified data control. (Defined by DynamicDataExtensions.)
Public Extension Method GetMetaTableGets the table metadata for the specified data control. (Defined by DynamicDataExtensions.)
Public Extension Method SetMetaTable(MetaTable)Overloaded. Sets the table metadata for the specified data control. (Defined by DynamicDataExtensions.)
Public Extension Method SetMetaTable(MetaTable, IDictionaryString, Object)Overloaded. Sets the table metadata and default value mapping for the specified data control. (Defined by DynamicDataExtensions.)
Public Extension Method SetMetaTable(MetaTable, Object)Overloaded. Sets the table metadata and default value mapping for the specified data control. (Defined by DynamicDataExtensions.)
Public Extension Method TryGetMetaTableDetermines whether table metadata is available. (Defined by DynamicDataExtensions.)
Top
Fields
  NameDescription
Public field Static member CancelCommandNameRepresents the Cancel command name. This field is read-only.
Public field Static member DeleteCommandNameRepresents the Delete command name. This field is read-only.
Public field Static member EditCommandNameRepresents the Edit command name. This field is read-only.
Public field Static member SelectCommandNameRepresents the Select command name. This field is read-only.
Public field Static member UpdateCommandNameRepresents the Update command name. This field is read-only.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method IAttributeAccessorGetAttributeInfrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetation Private method IAttributeAccessorSetAttributeSets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetation Private property IControlBuilderAccessorControlBuilderFor a description of this member, see IControlBuilderAccessorControlBuilder. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessorGetDesignModeStateFor a description of this member, see IControlDesignerAccessorGetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessorSetDesignModeStateFor a description of this member, see IControlDesignerAccessorSetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessorSetOwnerControlInfrastructure. For a description of this member, see IControlDesignerAccessorSetOwnerControl. (Inherited from Control.)
Explicit interface implemetation Private property IControlDesignerAccessorUserDataFor a description of this member, see IControlDesignerAccessorUserData. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessorDataBindingsFor a description of this member, see IDataBindingsAccessorDataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessorHasDataBindingsFor a description of this member, see IDataBindingsAccessorHasDataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessorExpressionsFor a description of this member, see IExpressionsAccessorExpressions. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessorHasExpressionsFor a description of this member, see IExpressionsAccessorHasExpressions. (Inherited from Control.)
Explicit interface implemetation Private method IParserAccessorAddParsedSubObjectFor a description of this member, see IParserAccessorAddParsedSubObject. (Inherited from Control.)
Explicit interface implemetation Private method IRepeatInfoUserGetItemStyleInfrastructure. For a description of this member, see IRepeatInfoUserGetItemStyle.
Explicit interface implemetation Private property IRepeatInfoUserHasFooterInfrastructure. For a description of this member, see IRepeatInfoUserHasFooter.
Explicit interface implemetation Private property IRepeatInfoUserHasHeaderInfrastructure. For a description of this member, see IRepeatInfoUserHasHeader.
Explicit interface implemetation Private property IRepeatInfoUserHasSeparatorsInfrastructure. For a description of this member, see IRepeatInfoUserHasSeparators.
Explicit interface implemetation Private method IRepeatInfoUserRenderItemInfrastructure. For a description of this member, see IRepeatInfoUserRenderItem.
Explicit interface implemetation Private property IRepeatInfoUserRepeatedItemCountInfrastructure. For a description of this member, see IRepeatInfoUserRepeatedItemCount.
Top
Remarks

In this topic:

  • Introduction

  • Templates

  • Customizing the Appearance of the DataList Control

  • Display Direction and Layout

  • Security

  • Declarative Syntax

Introduction

Use the DataList control to display a template-defined data bound list. The DataList control supports selecting and editing.

Templates

The contents of the DataList control can be manipulated by using templates. The following table lists the supported templates.

Template Name

Description

AlternatingItemTemplate

If defined, provides the content and layout for alternating items in the DataList. If not defined, ItemTemplate is used.

EditItemTemplate

If defined, provides the content and layout for the item currently being edited in the DataList. If not defined, ItemTemplate is used.

FooterTemplate

If defined, provides the content and layout for the footer section of the DataList. If not defined, a footer section will not be displayed.

HeaderTemplate

If defined, provides the content and layout for the header section of the DataList. If not defined, a header section will not be displayed.

ItemTemplate

Required template that provides the content and layout for items in the DataList.

SelectedItemTemplate

If defined, provides the content and layout for the currently selected item in the DataList. If not defined, ItemTemplate is used.

SeparatorTemplate

If defined, provides the content and layout for the separator between items in the DataList. If not defined, a separator will not be displayed.

At the very minimum, the ItemTemplate needs to be defined to display the items in the DataList control. Additional templates can be used to provide a custom look to the DataList control.

Customizing the Appearance of the DataList Control

The appearance of the DataList control may be customized by setting the style properties for the different parts of the control. The following table lists the different style properties.

Style Property

Description

AlternatingItemStyle

Specifies the style for alternating items in the DataList control.

EditItemStyle

Specifies the style for the item being edited in the DataList control.

FooterStyle

Specifies the style for the footer in the DataList control.

HeaderStyle

Specifies the style for the header in the DataList control.

ItemStyle

Specifies the style for the items in the DataList control.

SelectedItemStyle

Specifies the style for the selected item in the DataList control.

SeparatorStyle

Specifies the style for the separator between the items in the DataList control.

You can also show or hide different parts of the control. The following table lists the properties that control which parts are shown or hidden.

Property

Description

ShowFooter

Shows or hides the footer section of the DataList control.

ShowHeader

Shows or hides the header section of the DataList control.

Display Direction and Layout

The display direction of a DataList control can be vertical or horizontal. Set the RepeatDirection property to specify the display direction.

The layout of the DataList control is controlled with the RepeatLayout property. Setting this property to RepeatLayout.Table will display the DataList in a table format, while RepeatLayout.Flow displays the DataList without a table structure.

Security

The DataList control can contain controls that enable users to enter information.

Caution noteCaution

This control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. You can use validation controls to verify user input before displaying the input text in a control. ASP.NET provides an input request validation feature to block script and HTML in user input.

For more information about security, see Securing Standard Controls, How to: Protect Against Script Exploits in a Web Application by Applying HTML Encoding to Strings, and Validating User Input in ASP.NET Web Pages.

Declarative Syntax

<asp:DataList
    AccessKey="string"
    BackColor="color name|#dddddd"
    BorderColor="color name|#dddddd"
    BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
        Inset|Outset"
    BorderWidth="size"
    Caption="string"
    CaptionAlign="NotSet|Top|Bottom|Left|Right"
    CellPadding="integer"
    CellSpacing="integer"
    CssClass="string"
    DataKeyField="string"
    DataMember="string"
    DataSource="string"
    DataSourceID="string"
    EditItemIndex="integer"
    Enabled="True|False"
    EnableTheming="True|False"
    EnableViewState="True|False"
    ExtractTemplateRows="True|False"
    Font-Bold="True|False"
    Font-Italic="True|False"
    Font-Names="string"
    Font-Overline="True|False"
    Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
        Large|X-Large|XX-Large"
    Font-Strikeout="True|False"
    Font-Underline="True|False"
    ForeColor="color name|#dddddd"
    GridLines="None|Horizontal|Vertical|Both"
    Height="size"
    HorizontalAlign="NotSet|Left|Center|Right|Justify"
    ID="string"
    OnCancelCommand="CancelCommand event handler"
    OnDataBinding="DataBinding event handler"
    OnDeleteCommand="DeleteCommand event handler"
    OnDisposed="Disposed event handler"
    OnEditCommand="EditCommand 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"
    OnSelectedIndexChanged="SelectedIndexChanged event handler"
    OnUnload="Unload event handler"
    OnUpdateCommand="UpdateCommand event handler"
    RepeatColumns="integer"
    RepeatDirection="Horizontal|Vertical"
    RepeatLayout="Table|Flow"
    runat="server"
    SelectedIndex="integer"
    ShowFooter="True|False"
    ShowHeader="True|False"
    SkinID="string"
    Style="string"
    TabIndex="integer"
    ToolTip="string"
    UseAccessibleHeader="True|False"
    Visible="True|False"
    Width="size"
>
        <AlternatingItemStyle />
        <AlternatingItemTemplate>
            <!-- child controls -->
        </AlternatingItemTemplate>
        <EditItemStyle />
        <EditItemTemplate>
            <!-- child controls -->
        </EditItemTemplate>
        <FooterStyle />
        <FooterTemplate>
            <!-- child controls -->
        </FooterTemplate>
        <HeaderStyle />
        <HeaderTemplate>
            <!-- child controls -->
        </HeaderTemplate>
        <ItemStyle />
        <ItemTemplate>
            <!-- child controls -->
        </ItemTemplate>
        <SelectedItemStyle />
        <SelectedItemTemplate>
            <!-- child controls -->
        </SelectedItemTemplate>
        <SeparatorStyle />
        <SeparatorTemplate>
            <!-- child controls -->
        </SeparatorTemplate>
</asp:DataList>
Examples

The following code example demonstrates how to use a DataList control to display a list of items from a data source.

NoteNote

The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see ASP.NET Web Forms Page Code Model.


<%@ Page Language="VB" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
   <script runat="server">

      Function CreateDataSource() As ICollection 

         ' Create sample data for the DataList control.
         Dim dt As DataTable = New DataTable()
         dim dr As DataRow

         ' Define the columns of the table.
         dt.Columns.Add(New DataColumn("IntegerValue", GetType(Int32)))
         dt.Columns.Add(New DataColumn("StringValue", GetType(String)))
         dt.Columns.Add(New DataColumn("CurrencyValue", GetType(Double)))
         dt.Columns.Add(New DataColumn("ImageValue", GetType(String)))

         ' Populate the table with sample values.
         Dim i As Integer

         For i = 0 To 8 

            dr = dt.NewRow()

            dr(0) = i
            dr(1) = "Description for item " & i.ToString()
            dr(2) = 1.23 * (i + 1)
            dr(3) = "Image" & i.ToString() & ".jpg"

            dt.Rows.Add(dr)

         Next i

         Dim dv As DataView = New DataView(dt)
         Return dv

      End Function

      Sub Page_Load(sender As Object, e As EventArgs) 

         ' Load sample data only once, when the page is first loaded.
         If Not IsPostBack Then 

            ItemsList.DataSource = CreateDataSource()
            ItemsList.DataBind()

         End If

      End Sub

   </script>

<head runat="server">
    <title>DataList Example</title>
</head>
<body>

   <form id="form1" runat="server">

      <h3>DataList Example</h3>

      <asp:DataList id="ItemsList"
           BorderColor="black"
           CellPadding="5"
           CellSpacing="5"
           RepeatDirection="Vertical"
           RepeatLayout="Table"
           RepeatColumns="3"
           runat="server">

         <HeaderStyle BackColor="#aaaadd">
         </HeaderStyle>

         <AlternatingItemStyle BackColor="Gainsboro">
         </AlternatingItemStyle>

         <HeaderTemplate>

            List of items

         </HeaderTemplate>

         <ItemTemplate>

            Description: <br />
            <%# DataBinder.Eval(Container.DataItem, "StringValue") %>

            <br />

            Price: <%# DataBinder.Eval(Container.DataItem, "CurrencyValue", "{0:c}") %>

            <br />

            <asp:Image id="ProductImage" AlternateText="Product picture" 
                 ImageUrl='<%# DataBinder.Eval(Container.DataItem, "ImageValue") %>'
                 runat="server"/>

         </ItemTemplate>

      </asp:DataList>

   </form>

</body>
</html>

<%@ Page Language="C#" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
   <script runat="server">

      ICollection CreateDataSource() 
      {

         // Create sample data for the DataList control.
         DataTable dt = new DataTable();
         DataRow dr;

         // Define the columns of the table.
         dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32)));
         dt.Columns.Add(new DataColumn("StringValue", typeof(String)));
         dt.Columns.Add(new DataColumn("CurrencyValue", typeof(double)));
         dt.Columns.Add(new DataColumn("ImageValue", typeof(String)));

         // Populate the table with sample values.
         for (int i = 0; i < 9; i++) 
         {
            dr = dt.NewRow();

            dr[0] = i;
            dr[1] = "Description for item " + i.ToString();
            dr[2] = 1.23 * (i + 1);
            dr[3] = "Image" + i.ToString() + ".jpg";

            dt.Rows.Add(dr);
         }

         DataView dv = new DataView(dt);
         return dv;
      }


      void Page_Load(Object sender, EventArgs e) 
      {

         // Load sample data only once, when the page is first loaded.
         if (!IsPostBack) 
         {
            ItemsList.DataSource = CreateDataSource();
            ItemsList.DataBind();
         }

      }

   </script>

<head runat="server">
    <title>DataList Example</title>
</head>
<body>

   <form id="form1" runat="server">

      <h3>DataList Example</h3>

      <asp:DataList id="ItemsList"
           BorderColor="black"
           CellPadding="5"
           CellSpacing="5"
           RepeatDirection="Vertical"
           RepeatLayout="Table"
           RepeatColumns="3"
           runat="server">

         <HeaderStyle BackColor="#aaaadd">
         </HeaderStyle>

         <AlternatingItemStyle BackColor="Gainsboro">
         </AlternatingItemStyle>

         <HeaderTemplate>

            List of items

         </HeaderTemplate>

         <ItemTemplate>

            Description: <br />
            <%# DataBinder.Eval(Container.DataItem, "StringValue") %>

            <br />

            Price: <%# DataBinder.Eval(Container.DataItem, "CurrencyValue", "{0:c}") %>

            <br />

            <asp:Image id="ProductImage" AlternateText="Product picture" 
                 ImageUrl='<%# DataBinder.Eval(Container.DataItem, "ImageValue") %>'
                 runat="server"/>

         </ItemTemplate>

      </asp:DataList>

   </form>

</body>
</html>
Version Information

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0
Platforms

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.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.