Duration (Pacific Standard Time):
To (Pacific Standard Time):
Impact:
User Action:

DataList Class

 

A data bound list control that displays items using templates.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.BaseDataList
        System.Web.UI.WebControls.DataList

<ControlValuePropertyAttribute("SelectedValue")>
Public Class DataList
	Inherits BaseDataList
	Implements INamingContainer, IRepeatInfoUser
Name Description
System_CAPS_pubmethod DataList()

Initializes a new instance of the DataList class.

Name Description
System_CAPS_pubproperty AccessKey

Gets or sets the access key that allows you to quickly navigate to the Web server control.(Inherited from WebControl.)

System_CAPS_protproperty Adapter

Gets the browser-specific adapter for the control.(Inherited from Control.)

System_CAPS_pubproperty AlternatingItemStyle

Gets the style properties for alternating items in the DataList control.

System_CAPS_pubproperty AlternatingItemTemplate

Gets or sets the template for alternating items in the DataList.

System_CAPS_pubproperty AppRelativeTemplateSourceDirectory

Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(Inherited from Control.)

System_CAPS_pubproperty Attributes

Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.(Inherited from WebControl.)

System_CAPS_pubproperty BackColor

Gets or sets the background color of the Web server control.(Inherited from WebControl.)

System_CAPS_pubproperty BindingContainer

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the control that contains this control's data binding.(Inherited from Control.)

System_CAPS_pubproperty BorderColor

Gets or sets the border color of the Web control.(Inherited from WebControl.)

System_CAPS_pubproperty BorderStyle

Gets or sets the border style of the Web server control.(Inherited from WebControl.)

System_CAPS_pubproperty BorderWidth

Gets or sets the border width of the Web server control.(Inherited from WebControl.)

System_CAPS_pubproperty Caption

Gets 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.)

System_CAPS_pubproperty CaptionAlign

Gets 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.)

System_CAPS_pubproperty CellPadding

Gets or sets the amount of space between the contents of a cell and the cell's border.(Inherited from BaseDataList.)

System_CAPS_pubproperty CellSpacing

Gets or sets the amount of space between cells.(Inherited from BaseDataList.)

System_CAPS_protproperty ChildControlsCreated

Gets a value that indicates whether the server control's child controls have been created.(Inherited from Control.)

System_CAPS_pubproperty ClientID

Gets the control ID for HTML markup that is generated by ASP.NET.(Inherited from Control.)

System_CAPS_pubproperty ClientIDMode

Gets or sets the algorithm that is used to generate the value of the ClientID property.(Inherited from Control.)

System_CAPS_protproperty ClientIDSeparator

Gets a character value representing the separator character used in the ClientID property.(Inherited from Control.)

System_CAPS_protproperty Context

Gets the HttpContext object associated with the server control for the current Web request.(Inherited from Control.)

System_CAPS_pubproperty Controls

Gets a System.Web.UI.ControlCollection object that contains a collection of child controls in a data listing control.(Inherited from BaseDataList.)

System_CAPS_pubproperty ControlStyle

Gets the style of the Web server control. This property is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_pubproperty ControlStyleCreated

Gets 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.)

System_CAPS_pubproperty CssClass

Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.(Inherited from WebControl.)

System_CAPS_pubproperty DataItemContainer

Gets a reference to the naming container if the naming container implements IDataItemContainer.(Inherited from Control.)

System_CAPS_pubproperty DataKeyField

Gets or sets the key field in the data source specified by the DataSource property.(Inherited from BaseDataList.)

System_CAPS_pubproperty DataKeys

Gets a DataKeyCollection object that stores the key values of each record in a data listing control.(Inherited from BaseDataList.)

System_CAPS_protproperty DataKeysArray

Gets an ArrayList object that contains the key values of each record in a data listing control.(Inherited from BaseDataList.)

System_CAPS_pubproperty DataKeysContainer

Gets a reference to the naming container if the naming container implements IDataKeysControl.(Inherited from Control.)

System_CAPS_pubproperty DataMember

Gets or sets the specific data member in a multimember data source to bind to a data listing control.(Inherited from BaseDataList.)

System_CAPS_pubproperty DataSource

Gets or sets the source containing a list of values used to populate the items within the control.(Inherited from BaseDataList.)

System_CAPS_pubproperty DataSourceID

Gets 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.)

System_CAPS_protproperty DesignMode

Gets a value indicating whether a control is being used on a design surface.(Inherited from Control.)

System_CAPS_pubproperty EditItemIndex

Gets or sets the index number of the selected item in the DataList control to edit.

System_CAPS_pubproperty EditItemStyle

Gets the style properties for the item selected for editing in the DataList control.

System_CAPS_pubproperty EditItemTemplate

Gets or sets the template for the item selected for editing in the DataList control.

System_CAPS_pubproperty Enabled

Gets or sets a value indicating whether the Web server control is enabled.(Inherited from WebControl.)

System_CAPS_pubproperty EnableTheming

Gets or sets a value indicating whether themes apply to this control.(Inherited from WebControl.)

System_CAPS_pubproperty 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.)

System_CAPS_protproperty Events

Gets a list of event handler delegates for the control. This property is read-only.(Inherited from Control.)

System_CAPS_pubproperty ExtractTemplateRows

Gets 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.

System_CAPS_pubproperty Font

Gets the font properties associated with the Web server control.(Inherited from WebControl.)

System_CAPS_pubproperty FooterStyle

Gets the style properties for the footer section of the DataList control.

System_CAPS_pubproperty FooterTemplate

Gets or sets the template for the footer section of the DataList control.

System_CAPS_pubproperty ForeColor

Gets or sets the foreground color (typically the color of the text) of the Web server control.(Inherited from WebControl.)

System_CAPS_pubproperty GridLines

Gets or sets the grid line style for the DataList control when the RepeatLayout property is set to RepeatLayout.Table.(Overrides BaseDataList.GridLines.)

System_CAPS_pubproperty HasAttributes

Gets a value indicating whether the control has attributes set.(Inherited from WebControl.)

System_CAPS_protproperty HasChildViewState

Gets a value indicating whether the current server control's child controls have any saved view-state settings.(Inherited from Control.)

System_CAPS_pubproperty HeaderStyle

Gets the style properties for the heading section of the DataList control.

System_CAPS_pubproperty HeaderTemplate

Gets or sets the template for the heading section of the DataList control.

System_CAPS_pubproperty Height

Gets or sets the height of the Web server control.(Inherited from WebControl.)

System_CAPS_pubproperty HorizontalAlign

Gets or sets the horizontal alignment of a data listing control within its container.(Inherited from BaseDataList.)

System_CAPS_pubproperty ID

Gets or sets the programmatic identifier assigned to the server control.(Inherited from Control.)

System_CAPS_protproperty IdSeparator

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the character used to separate control identifiers.(Inherited from Control.)

System_CAPS_protproperty Initialized

Gets a value indicating whether the control has been initialized.(Inherited from BaseDataList.)

System_CAPS_protproperty IsBoundUsingDataSourceID

Gets a value indicating whether the DataSourceID property is set.(Inherited from BaseDataList.)

System_CAPS_protproperty IsChildControlStateCleared

Gets a value indicating whether controls contained within this control have control state.(Inherited from Control.)

System_CAPS_protproperty IsEnabled

Gets a value indicating whether the control is enabled.(Inherited from WebControl.)

System_CAPS_protproperty IsTrackingViewState

Gets a value that indicates whether the server control is saving changes to its view state.(Inherited from Control.)

System_CAPS_protproperty IsViewStateEnabled

Gets a value indicating whether view state is enabled for this control.(Inherited from Control.)

System_CAPS_pubproperty Items

Gets a collection of DataListItem objects representing the individual items within the control.

System_CAPS_pubproperty ItemStyle

Gets the style properties for the items in the DataList control.

System_CAPS_pubproperty ItemTemplate

Gets or sets the template for the items in the DataList control.

System_CAPS_protproperty LoadViewStateByID

Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)

System_CAPS_pubproperty NamingContainer

Gets 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.)

System_CAPS_pubproperty Page

Gets a reference to the Page instance that contains the server control.(Inherited from Control.)

System_CAPS_pubproperty Parent

Gets a reference to the server control's parent control in the page control hierarchy.(Inherited from Control.)

System_CAPS_pubproperty RenderingCompatibility

Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.(Inherited from Control.)

System_CAPS_pubproperty RepeatColumns

Gets or sets the number of columns to display in the DataList control.

System_CAPS_pubproperty RepeatDirection

Gets or sets whether the DataList control displays vertically or horizontally.

System_CAPS_pubproperty RepeatLayout

Gets or sets whether the control is displayed in a table or flow layout.

System_CAPS_protproperty RequiresDataBinding

Gets or sets a value indicating whether the data listing control needs to bind to its specified data source.(Inherited from BaseDataList.)

System_CAPS_protproperty SelectArguments

Gets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control.(Inherited from BaseDataList.)

System_CAPS_pubproperty SelectedIndex

Gets or sets the index of the selected item in the DataList control.

System_CAPS_pubproperty SelectedItem

Gets the selected item in the DataList control.

System_CAPS_pubproperty SelectedItemStyle

Gets the style properties for the selected item in the DataList control.

System_CAPS_pubproperty SelectedItemTemplate

Gets or sets the template for the selected item in the DataList control.

System_CAPS_pubproperty SelectedValue

Gets the value of the key field for the selected data list item.

System_CAPS_pubproperty SeparatorStyle

Gets the style properties of the separator between each item in the DataList control.

System_CAPS_pubproperty SeparatorTemplate

Gets or sets the template for the separator between the items of the DataList control.

System_CAPS_pubproperty ShowFooter

Gets or sets a value indicating whether the footer section is displayed in the DataList control.

System_CAPS_pubproperty ShowHeader

Gets or sets a value indicating whether the header section is displayed in the DataList control.

System_CAPS_pubproperty Site

Gets information about the container that hosts the current control when rendered on a design surface.(Inherited from Control.)

System_CAPS_pubproperty SkinID

Gets or sets the skin to apply to the control.(Inherited from WebControl.)

System_CAPS_pubproperty Style

Gets 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.)

System_CAPS_pubproperty SupportsDisabledAttribute

Gets 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.)

System_CAPS_pubproperty TabIndex

Gets or sets the tab index of the Web server control.(Inherited from WebControl.)

System_CAPS_protproperty TagKey

Gets the HTML tag that is used to render the DataList control.(Overrides WebControl.TagKey.)

System_CAPS_protproperty TagName

Gets the name of the control tag. This property is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_pubproperty TemplateControl

Gets or sets a reference to the template that contains this control. (Inherited from Control.)

System_CAPS_pubproperty TemplateSourceDirectory

Gets the virtual directory of the Page or UserControl that contains the current server control.(Inherited from Control.)

System_CAPS_pubproperty ToolTip

Gets or sets the text displayed when the mouse pointer hovers over the Web server control.(Inherited from WebControl.)

System_CAPS_pubproperty UniqueID

Gets the unique, hierarchically qualified identifier for the server control.(Inherited from Control.)

System_CAPS_pubproperty UseAccessibleHeader

Gets 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.)

System_CAPS_pubproperty ValidateRequestMode

Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.(Inherited from Control.)

System_CAPS_protproperty 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.)

System_CAPS_protproperty ViewStateIgnoresCase

Gets a value that indicates whether the StateBag object is case-insensitive.(Inherited from Control.)

System_CAPS_pubproperty ViewStateMode

Gets or sets the view-state mode of this control.(Inherited from Control.)

System_CAPS_pubproperty Visible

Gets or sets a value that indicates whether a server control is rendered as UI on the page.(Inherited from Control.)

System_CAPS_pubproperty Width

Gets or sets the width of the Web server control.(Inherited from WebControl.)

Name Description
System_CAPS_protmethod AddAttributesToRender(HtmlTextWriter)

Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protmethod AddedControl(Control, Int32)

Called after a child control is added to the Controls collection of the Control object.(Inherited from Control.)

System_CAPS_protmethod 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 collection.(Inherited from BaseDataList.)

System_CAPS_pubmethod ApplyStyle(Style)

Copies 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.)

System_CAPS_pubmethod ApplyStyleSheetSkin(Page)

Applies the style properties defined in the page style sheet to the control.(Inherited from Control.)

System_CAPS_protmethod BeginRenderTracing(TextWriter, Object)

Begins design-time tracing of rendering data.(Inherited from Control.)

System_CAPS_protmethod BuildProfileTree(String, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.)

System_CAPS_protmethod ClearCachedClientID()

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the cached ClientID value to null.(Inherited from Control.)

System_CAPS_protmethod ClearChildControlState()

Deletes the control-state information for the server control's child controls. (Inherited from Control.)

System_CAPS_protmethod ClearChildState()

Deletes the view-state and control-state information for all the server control's child controls.(Inherited from Control.)

System_CAPS_protmethod ClearChildViewState()

Deletes the view-state information for all the server control's child controls.(Inherited from Control.)

System_CAPS_protmethod ClearEffectiveClientIDMode()

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.(Inherited from Control.)

System_CAPS_pubmethod CopyBaseAttributes(WebControl)

Copies 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.)

System_CAPS_protmethod CreateChildControls()

This API supports the product infrastructure and is not intended to be used directly from your code. Creates a child control using the view state.(Inherited from BaseDataList.)

System_CAPS_protmethod CreateControlCollection()

Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.(Inherited from Control.)

System_CAPS_protmethod CreateControlHierarchy(Boolean)

Creates the control hierarchy that is used to render the data list control, with or without the specified data source.(Overrides BaseDataList.CreateControlHierarchy(Boolean).)

System_CAPS_protmethod CreateControlStyle()

Creates the default style object that is used internally by the DataList control to implement all style related properties.(Overrides WebControl.CreateControlStyle().)

System_CAPS_protmethod CreateDataSourceSelectArguments()

Creates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified.(Inherited from BaseDataList.)

System_CAPS_protmethod CreateItem(Int32, ListItemType)

Creates a DataListItem object.

System_CAPS_pubmethod DataBind()

Binds the control and all its child controls to the specified data source.(Inherited from BaseDataList.)

System_CAPS_protmethod 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.)

System_CAPS_protmethod DataBindChildren()

Binds a data source to the server control's child controls.(Inherited from Control.)

System_CAPS_pubmethod Dispose()

Enables a server control to perform final clean up before it is released from memory.(Inherited from Control.)

System_CAPS_protmethod EndRenderTracing(TextWriter, Object)

Ends design-time tracing of rendering data.(Inherited from Control.)

System_CAPS_protmethod EnsureChildControls()

Determines whether the server control contains child controls. If it does not, it creates child controls.(Inherited from Control.)

System_CAPS_protmethod EnsureDataBound()

Verifies 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.)

System_CAPS_protmethod EnsureID()

Creates an identifier for controls that do not have an identifier assigned.(Inherited from Control.)

System_CAPS_pubmethod Equals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethod Finalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethod FindControl(String)

Searches the current naming container for a server control with the specified id parameter.(Inherited from Control.)

System_CAPS_protmethod FindControl(String, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.)

System_CAPS_pubmethod Focus()

Sets input focus to a control.(Inherited from Control.)

System_CAPS_protmethod GetData()

Returns an IEnumerable-implemented object that represents the data source.(Inherited from BaseDataList.)

System_CAPS_protmethod GetDesignModeState()

This API supports the product infrastructure and is not intended to be used directly from your code. Gets design-time data for a control.(Inherited from Control.)

System_CAPS_pubmethod GetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethod GetRouteUrl(Object)

Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)

System_CAPS_pubmethod GetRouteUrl(RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)

System_CAPS_pubmethod GetRouteUrl(String, Object)

Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)

System_CAPS_pubmethod GetRouteUrl(String, RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)

System_CAPS_pubmethod GetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod GetUniqueIDRelativeTo(Control)

Returns the prefixed portion of the UniqueID property of the specified control.(Inherited from Control.)

System_CAPS_pubmethod HasControls()

Determines if the server control contains any child controls.(Inherited from Control.)

System_CAPS_protmethod HasEvents()

Returns a value indicating whether events are registered for the control or any child controls.(Inherited from Control.)

System_CAPS_protmethod InitializeItem(DataListItem)

Initializes a DataListItem object based on the specified templates and styles for the list-item type.

System_CAPS_protmethod IsLiteralContent()

This API supports the product infrastructure and is not intended to be used directly from your code. Determines if the server control holds only literal content.(Inherited from Control.)

System_CAPS_protmethod LoadControlState(Object)

Restores control-state information from a previous page request that was saved by the SaveControlState method.(Inherited from Control.)

System_CAPS_protmethod LoadViewState(Object)

Loads the previously saved view state of the DataList control.(Overrides WebControl.LoadViewState(Object).)

System_CAPS_protmethod MapPathSecure(String)

Retrieves the physical path that a virtual path, either absolute or relative, maps to.(Inherited from Control.)

System_CAPS_protmethod MemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethod MergeStyle(Style)

Copies 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.)

System_CAPS_protmethod OnBubbleEvent(Object, EventArgs)

Determines whether the event for the server control is passed up the page's UI server control hierarchy.(Overrides Control.OnBubbleEvent(Object, EventArgs).)

System_CAPS_protmethod OnCancelCommand(DataListCommandEventArgs)

Raises the CancelCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethod OnDataBinding(EventArgs)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises the DataBinding event of a BaseDataList control.(Inherited from BaseDataList.)

System_CAPS_protmethod OnDataPropertyChanged()

Called when one of the base data source identification properties is changed, to rebind the data-bound control to its data.(Inherited from BaseDataList.)

System_CAPS_protmethod OnDataSourceViewChanged(Object, EventArgs)

Raises the DataSourceViewChanged event.(Inherited from BaseDataList.)

System_CAPS_protmethod OnDeleteCommand(DataListCommandEventArgs)

Raises the DeleteCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethod OnEditCommand(DataListCommandEventArgs)

Raises the EditCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethod OnInit(EventArgs)

Raises the Init event for the DataList control.(Overrides BaseDataList.OnInit(EventArgs).)

System_CAPS_protmethod OnItemCommand(DataListCommandEventArgs)

Raises the ItemCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethod OnItemCreated(DataListItemEventArgs)

Raises the ItemCreated event. This allows you to provide a custom handler for the event.

System_CAPS_protmethod OnItemDataBound(DataListItemEventArgs)

Raises the ItemDataBound event. This allows you to provide a custom handler for the event.

System_CAPS_protmethod OnLoad(EventArgs)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises the Load event.(Inherited from BaseDataList.)

System_CAPS_protmethod OnPreRender(EventArgs)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises the PreRender event.(Inherited from BaseDataList.)

System_CAPS_protmethod OnSelectedIndexChanged(EventArgs)

Raises the SelectedIndexChanged event of a BaseDataList control. (Inherited from BaseDataList.)

System_CAPS_protmethod OnUnload(EventArgs)

Raises the Unload event.(Inherited from Control.)

System_CAPS_protmethod OnUpdateCommand(DataListCommandEventArgs)

Raises the UpdateCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethod OpenFile(String)

Gets a Stream used to read a file.(Inherited from Control.)

System_CAPS_protmethod PrepareControlHierarchy()

Prepares the control hierarchy for rendering in the DataList control.(Overrides BaseDataList.PrepareControlHierarchy().)

System_CAPS_protmethod RaiseBubbleEvent(Object, EventArgs)

Assigns any sources of the event and its information to the control's parent.(Inherited from Control.)

System_CAPS_protmethod RemovedControl(Control)

Called after a child control is removed from the Controls collection of the Control object.(Inherited from Control.)

System_CAPS_protmethod Render(HtmlTextWriter)

This API supports the product infrastructure and is not intended to be used directly from your code. Renders the control to the specified HTML writer.(Inherited from BaseDataList.)

System_CAPS_pubmethod RenderBeginTag(HtmlTextWriter)

Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protmethod 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.)

System_CAPS_protmethod RenderContents(HtmlTextWriter)

Renders the list items in the DataList control.(Overrides WebControl.RenderContents(HtmlTextWriter).)

System_CAPS_pubmethod 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.)

System_CAPS_protmethod RenderControl(HtmlTextWriter, ControlAdapter)

Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.(Inherited from Control.)

System_CAPS_pubmethod RenderEndTag(HtmlTextWriter)

Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protmethod ResolveAdapter()

Gets the control adapter responsible for rendering the specified control.(Inherited from Control.)

System_CAPS_pubmethod ResolveClientUrl(String)

Gets a URL that can be used by the browser.(Inherited from Control.)

System_CAPS_pubmethod ResolveUrl(String)

Converts a URL into one that is usable on the requesting client.(Inherited from Control.)

System_CAPS_protmethod SaveControlState()

Saves any server control state changes that have occurred since the time the page was posted back to the server.(Inherited from Control.)

System_CAPS_protmethod SaveViewState()

Saves the changes to the control view state since the time the page was posted back to the server.(Overrides WebControl.SaveViewState().)

System_CAPS_protmethod SetDesignModeState(IDictionary)

Sets design-time data for a control.(Inherited from Control.)

System_CAPS_pubmethod SetRenderMethodDelegate(RenderMethod)

This API supports the product infrastructure and is not intended to be used directly from your code. Assigns an event handler delegate to render the server control and its content into its parent control.(Inherited from Control.)

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod ToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethod TrackViewState()

Tracks view-state changes to the DataList control so they can be stored in the control's ViewState property.(Overrides WebControl.TrackViewState().)

Name Description
System_CAPS_pubfield System_CAPS_static CancelCommandName

Represents the Cancel command name. This field is read-only.

System_CAPS_pubfield System_CAPS_static DeleteCommandName

Represents the Delete command name. This field is read-only.

System_CAPS_pubfield System_CAPS_static EditCommandName

Represents the Edit command name. This field is read-only.

System_CAPS_pubfield System_CAPS_static SelectCommandName

Represents the Select command name. This field is read-only.

System_CAPS_pubfield System_CAPS_static UpdateCommandName

Represents the Update command name. This field is read-only.

Name Description
System_CAPS_pubevent CancelCommand

Occurs when the Cancel button is clicked for an item in the DataList control.

System_CAPS_pubevent DataBinding

Occurs when the server control binds to a data source.(Inherited from Control.)

System_CAPS_pubevent DeleteCommand

Occurs when the Delete button is clicked for an item in the DataList control.

System_CAPS_pubevent 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.)

System_CAPS_pubevent EditCommand

Occurs when the Edit button is clicked for an item in the DataList control.

System_CAPS_pubevent Init

Occurs when the server control is initialized, which is the first step in its lifecycle.(Inherited from Control.)

System_CAPS_pubevent ItemCommand

Occurs when any button is clicked in the DataList control.

System_CAPS_pubevent ItemCreated

Occurs on the server when an item in the DataList control is created.

System_CAPS_pubevent ItemDataBound

Occurs when an item is data bound to the DataList control.

System_CAPS_pubevent Load

Occurs when the server control is loaded into the Page object.(Inherited from Control.)

System_CAPS_pubevent PreRender

Occurs after the Control object is loaded but prior to rendering.(Inherited from Control.)

System_CAPS_pubevent SelectedIndexChanged

Occurs when a different item is selected in a data listing control between posts to the server.(Inherited from BaseDataList.)

System_CAPS_pubevent Unload

Occurs when the server control is unloaded from memory.(Inherited from Control.)

System_CAPS_pubevent UpdateCommand

Occurs when the Update button is clicked for an item in the DataList control.

Name Description
System_CAPS_pubinterface System_CAPS_privmethod IAttributeAccessor.GetAttribute(String)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an attribute of the Web control with the specified name.(Inherited from WebControl.)

System_CAPS_pubinterface System_CAPS_privmethod IAttributeAccessor.SetAttribute(String, String)

Sets an attribute of the Web control to the specified name and value.(Inherited from WebControl.)

System_CAPS_pubinterface System_CAPS_privmethod IControlDesignerAccessor.GetDesignModeState()

For a description of this member, see IControlDesignerAccessor.GetDesignModeState.(Inherited from Control.)

System_CAPS_pubinterface System_CAPS_privmethod IControlDesignerAccessor.SetDesignModeState(IDictionary)

For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)

System_CAPS_pubinterface System_CAPS_privmethod IControlDesignerAccessor.SetOwnerControl(Control)

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)

System_CAPS_pubinterface System_CAPS_privmethod IParserAccessor.AddParsedSubObject(Object)

For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)

System_CAPS_pubinterface System_CAPS_privmethod IRepeatInfoUser.GetItemStyle(ListItemType, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IRepeatInfoUser.GetItemStyle.

System_CAPS_pubinterface System_CAPS_privmethod IRepeatInfoUser.RenderItem(ListItemType, Int32, RepeatInfo, HtmlTextWriter)

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IRepeatInfoUser.RenderItem.

System_CAPS_pubinterface System_CAPS_privproperty IControlBuilderAccessor.ControlBuilder

For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)

System_CAPS_pubinterface System_CAPS_privproperty IControlDesignerAccessor.UserData

For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)

System_CAPS_pubinterface System_CAPS_privproperty IDataBindingsAccessor.DataBindings

For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)

System_CAPS_pubinterface System_CAPS_privproperty IDataBindingsAccessor.HasDataBindings

For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)

System_CAPS_pubinterface System_CAPS_privproperty IExpressionsAccessor.Expressions

For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)

System_CAPS_pubinterface System_CAPS_privproperty IExpressionsAccessor.HasExpressions

For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)

System_CAPS_pubinterface System_CAPS_privproperty IRepeatInfoUser.HasFooter

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IRepeatInfoUser.HasFooter.

System_CAPS_pubinterface System_CAPS_privproperty IRepeatInfoUser.HasHeader

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IRepeatInfoUser.HasHeader.

System_CAPS_pubinterface System_CAPS_privproperty IRepeatInfoUser.HasSeparators

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IRepeatInfoUser.HasSeparators.

System_CAPS_pubinterface System_CAPS_privproperty IRepeatInfoUser.RepeatedItemCount

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IRepeatInfoUser.RepeatedItemCount.

Name Description
System_CAPS_pubmethod EnableDynamicData(Type)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethod EnableDynamicData(Type, IDictionary<String, Object>)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethod EnableDynamicData(Type, Object)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethod FindDataSourceControl()

Returns the data source that is associated with the data control for the specified control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethod FindFieldTemplate(String)

Returns the field template for the specified column in the specified control's naming container.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethod FindMetaTable()

Returns the metatable object for the containing data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethod GetDefaultValues()

Overloaded. Gets the collection of the default values for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethod GetMetaTable()

Overloaded. Gets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethod SetMetaTable(MetaTable)

Overloaded. Sets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethod SetMetaTable(MetaTable, IDictionary<String, Object>)

Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethod SetMetaTable(MetaTable, Object)

Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethod TryGetMetaTable(MetaTable)

Overloaded. Determines whether table metadata is available.(Defined by DynamicDataExtensions.)

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

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.

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.

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.

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

System_CAPS_caution Caution

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.

<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>

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

System_CAPS_note Note

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>

.NET Framework
Available since 1.1

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

Return to top