BaseDataList Class

Definition

Namespace:

System.Web.UI.WebControls

Assembly:

System.Web.dll

Serves as the abstract base class for data listing controls, such as DataList and DataGrid. This class provides the methods and properties common to all data listing controls.

public ref class BaseDataList abstract : System::Web::UI::WebControls::WebControl

public abstract class BaseDataList : System.Web.UI.WebControls.WebControl

type BaseDataList = class
    inherit WebControl

Public MustInherit Class BaseDataList
Inherits WebControl

Inheritance

Object

Control

WebControl

BaseDataList

Derived

System.Web.UI.WebControls.DataGrid

System.Web.UI.WebControls.DataList

Remarks

The BaseDataList class provides the common functionality for all data listing controls, such as DataList and DataGrid. A data listing control is used to display the records from a data source, such as a System.Data.DataView control. Each data listing control can have a unique display style and capabilities. Because the BaseDataList class is abstract, an instance of this class is not created directly. Instead, data listing controls inherit the methods and properties common to all data listing controls from this class.

You can control the appearance of a data listing control by setting certain properties of this class. To determine the amount of spacing between the cells of a data listing control, set the CellSpacing property. To determine the amount of spacing between the contents of a cell and the cell's border, set the CellPadding property. You can display the border between the individual cells of a data listing control by setting the GridLines property. The horizontal alignment of the content in the cells of a data listing control is controlled by the HorizontalAlign property.

The BaseDataList class provides two properties to support data binding. To bind data to any collection that implements the System.Collections.IEnumerable interface (such as System.Data.DataView or System.Collections.ArrayList), or the IListSource interface, use the DataSource property to specify the data source. When you set the DataSource property, you must manually write the code to perform the data binding. To automatically bind a data listing control to a data source represented by a data source control, use the DataSourceID property and set its value to the ID property of the data source control to use. When you set the DataSourceID property, the data listing control automatically binds to the specified data source control. Therefore, you do not need to explicitly call the DataBind method.

If the data source specified by the DataSource property contains multiple sources of data, use the DataMember property to specify the specific source to bind to the control. For example, if you have a System.Data.DataSet object with multiple tables, you must specify which table to bind to the control. After you have specified the data source, use the DataBind method to bind the data source to the control.

The BaseDataList class contains a DataKeys collection that stores the key field of each record (displayed as a row) in a data listing control. This allows you to store the key field with a data listing control without displaying it in the control. The key field is commonly used as part of an update query string to revise a specific record in the data source. The collection is filled with the values from the field specified by the DataKeyField property.

The BaseDataList class provides a SelectedIndexChanged event that is raised when the selected item in the control changes. This allows you to create a custom event handler that performs a specific set of instructions when the event is raised.

Notes to Implementers

When you inherit from BaseDataList, you must override the following members: CreateControlHierarchy(Boolean) and PrepareControlHierarchy().

Constructors

BaseDataList()

Initializes a new instance of the BaseDataList class.

Properties

AccessKey	Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl)
Adapter	Gets the browser-specific adapter for the control. (Inherited from Control)
AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control)
Attributes	Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl)
BackColor	Gets or sets the background color of the Web server control. (Inherited from WebControl)
BindingContainer	Gets the control that contains this control's data binding. (Inherited from Control)
BorderColor	Gets or sets the border color of the Web control. (Inherited from WebControl)
BorderStyle	Gets or sets the border style of the Web server control. (Inherited from WebControl)
BorderWidth	Gets or sets the border width of the Web server control. (Inherited from WebControl)
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.
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.
CellPadding	Gets or sets the amount of space between the contents of a cell and the cell's border.
CellSpacing	Gets or sets the amount of space between cells.
ChildControlsCreated	Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control)
ClientID	Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control)
ClientIDMode	Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control)
ClientIDSeparator	Gets a character value representing the separator character used in the ClientID property. (Inherited from Control)
Context	Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control)
Controls	Gets a ControlCollection object that contains a collection of child controls in a data listing control.
ControlStyle	Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl)
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)
CssClass	Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl)
DataItemContainer	Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control)
DataKeyField	Gets or sets the key field in the data source specified by the DataSource property.
DataKeys	Gets a DataKeyCollection object that stores the key values of each record in a data listing control.
DataKeysArray	Gets an ArrayList object that contains the key values of each record in a data listing control.
DataKeysContainer	Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control)
DataMember	Gets or sets the specific data member in a multimember data source to bind to a data listing control.
DataSource	Gets or sets the source containing a list of values used to populate the items within the control.
DataSourceID	Gets or sets the ID property of the data source control that the data listing control should use to retrieve its data source.
DesignMode	Gets a value indicating whether a control is being used on a design surface. (Inherited from Control)
Enabled	Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl)
EnableTheming	Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl)
EnableViewState	Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control)
Events	Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control)
Font	Gets the font properties associated with the Web server control. (Inherited from WebControl)
ForeColor	Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl)
GridLines	Gets or sets a value that specifies whether the border between the cells of a data listing control is displayed.
HasAttributes	Gets a value indicating whether the control has attributes set. (Inherited from WebControl)
HasChildViewState	Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control)
Height	Gets or sets the height of the Web server control. (Inherited from WebControl)
HorizontalAlign	Gets or sets the horizontal alignment of a data listing control within its container.
ID	Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control)
IdSeparator	Gets the character used to separate control identifiers. (Inherited from Control)
Initialized	Gets a value indicating whether the control has been initialized.
IsBoundUsingDataSourceID	Gets a value indicating whether the DataSourceID property is set.
IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state. (Inherited from Control)
IsEnabled	Gets a value indicating whether the control is enabled. (Inherited from WebControl)
IsTrackingViewState	Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control)
IsViewStateEnabled	Gets a value indicating whether view state is enabled for this control. (Inherited from Control)
LoadViewStateByID	Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control)
NamingContainer	Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control)
Page	Gets a reference to the Page instance that contains the server control. (Inherited from Control)
Parent	Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control)
RenderingCompatibility	Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control)
RequiresDataBinding	Gets or sets a value indicating whether the data listing control needs to bind to its specified data source.
SelectArguments	Gets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control.
Site	Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control)
SkinID	Gets or sets the skin to apply to the control. (Inherited from WebControl)
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)
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.
TabIndex	Gets or sets the tab index of the Web server control. (Inherited from WebControl)
TagKey	Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl)
TagName	Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl)
TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from Control)
TemplateSourceDirectory	Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control)
ToolTip	Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl)
UniqueID	Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control)
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.
ValidateRequestMode	Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control)
ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control)
ViewStateIgnoresCase	Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control)
ViewStateMode	Gets or sets the view-state mode of this control. (Inherited from Control)
Visible	Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control)
Width	Gets or sets the width of the Web server control. (Inherited from WebControl)

Methods

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)
AddedControl(Control, Int32)	Called after a child control is added to the Controls collection of the Control object. (Inherited from Control)
AddParsedSubObject(Object)	Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection collection.
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)
ApplyStyleSheetSkin(Page)	Applies the style properties defined in the page style sheet to the control. (Inherited from Control)
BeginRenderTracing(TextWriter, Object)	Begins design-time tracing of rendering data. (Inherited from Control)
BuildProfileTree(String, Boolean)	Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control)
ClearCachedClientID()	Sets the cached ClientID value to null. (Inherited from Control)
ClearChildControlState()	Deletes the control-state information for the server control's child controls. (Inherited from Control)
ClearChildState()	Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control)
ClearChildViewState()	Deletes the view-state information for all the server control's child controls. (Inherited from Control)
ClearEffectiveClientIDMode()	Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control)
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)
CreateChildControls()	Creates a child control using the view state.
CreateControlCollection()	Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control)
CreateControlHierarchy(Boolean)	When overridden in a derived class, creates the control hierarchy for the data listing control with or without the specified data source.
CreateControlStyle()	Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl)
CreateDataSourceSelectArguments()	Creates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified.
DataBind()	Binds the control and all its child controls to the specified data source.
DataBind(Boolean)	Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control)
DataBindChildren()	Binds a data source to the server control's child controls. (Inherited from Control)
Dispose()	Enables a server control to perform final clean up before it is released from memory. (Inherited from Control)
EndRenderTracing(TextWriter, Object)	Ends design-time tracing of rendering data. (Inherited from Control)
EnsureChildControls()	Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control)
EnsureDataBound()	Verifies that the data listing control requires data binding and that a valid data source control is specified before calling the DataBind() method.
EnsureID()	Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindControl(String)	Searches the current naming container for a server control with the specified id parameter. (Inherited from Control)
FindControl(String, Int32)	Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control)
Focus()	Sets input focus to a control. (Inherited from Control)
GetData()	Returns an IEnumerable-implemented object that represents the data source.
GetDesignModeState()	Gets design-time data for a control. (Inherited from Control)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetRouteUrl(Object)	Gets the URL that corresponds to a set of route parameters. (Inherited from Control)
GetRouteUrl(RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters. (Inherited from Control)
GetRouteUrl(String, Object)	Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control)
GetRouteUrl(String, RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUniqueIDRelativeTo(Control)	Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control)
HasControls()	Determines if the server control contains any child controls. (Inherited from Control)
HasEvents()	Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control)
IsBindableType(Type)	Determines whether the specified data type can be bound to a list control that derives from the BaseDataList class.
IsLiteralContent()	Determines if the server control holds only literal content. (Inherited from Control)
LoadControlState(Object)	Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control)
LoadViewState(Object)	Restores view-state information from a previous request that was saved with the SaveViewState() method. (Inherited from WebControl)
MapPathSecure(String)	Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
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)
OnBubbleEvent(Object, EventArgs)	Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control)
OnDataBinding(EventArgs)	Raises the DataBinding event of a BaseDataList control.
OnDataPropertyChanged()	Called when one of the base data source identification properties is changed, to rebind the data-bound control to its data.
OnDataSourceViewChanged(Object, EventArgs)	Raises the DataSourceViewChanged event.
OnInit(EventArgs)	Raises the Init event for the BaseDataList control.
OnLoad(EventArgs)	Raises the Load event.
OnPreRender(EventArgs)	Raises the PreRender event.
OnSelectedIndexChanged(EventArgs)	Raises the SelectedIndexChanged event of a BaseDataList control.
OnUnload(EventArgs)	Raises the Unload event. (Inherited from Control)
OpenFile(String)	Gets a Stream used to read a file. (Inherited from Control)
PrepareControlHierarchy()	Sets up the control hierarchy for the data-bound control.
RaiseBubbleEvent(Object, EventArgs)	Assigns any sources of the event and its information to the control's parent. (Inherited from Control)
RemovedControl(Control)	Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control)
Render(HtmlTextWriter)	Renders the control to the specified HTML writer.
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)
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)
RenderContents(HtmlTextWriter)	Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl)
RenderControl(HtmlTextWriter)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control)
RenderControl(HtmlTextWriter, ControlAdapter)	Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control)
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)
ResolveAdapter()	Gets the control adapter responsible for rendering the specified control. (Inherited from Control)
ResolveClientUrl(String)	Gets a URL that can be used by the browser. (Inherited from Control)
ResolveUrl(String)	Converts a URL into one that is usable on the requesting client. (Inherited from Control)
SaveControlState()	Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control)
SaveViewState()	Saves any state that was modified after the TrackViewState() method was invoked. (Inherited from WebControl)
SetDesignModeState(IDictionary)	Sets design-time data for a control. (Inherited from Control)
SetRenderMethodDelegate(RenderMethod)	Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control)
SetTraceData(Object, Object)	Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control)
SetTraceData(Object, Object, Object)	Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control)
ToString()	Returns a string that represents the current object. (Inherited from Object)
TrackViewState()	Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebControl)

Events

DataBinding	Occurs when the server control binds to a data source. (Inherited from Control)
Disposed	Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control)
Init	Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control)
Load	Occurs when the server control is loaded into the Page object. (Inherited from Control)
PreRender	Occurs after the Control object is loaded but prior to rendering. (Inherited from Control)
SelectedIndexChanged	Occurs when a different item is selected in a data listing control between posts to the server.
Unload	Occurs when the server control is unloaded from memory. (Inherited from Control)

Explicit Interface Implementations

IAttributeAccessor.GetAttribute(String)	Gets an attribute of the Web control with the specified name. (Inherited from WebControl)
IAttributeAccessor.SetAttribute(String, String)	Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl)
IControlBuilderAccessor.ControlBuilder	For a description of this member, see ControlBuilder. (Inherited from Control)
IControlDesignerAccessor.GetDesignModeState()	For a description of this member, see GetDesignModeState(). (Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)	For a description of this member, see SetDesignModeState(IDictionary). (Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control)	For a description of this member, see SetOwnerControl(Control). (Inherited from Control)
IControlDesignerAccessor.UserData	For a description of this member, see UserData. (Inherited from Control)
IDataBindingsAccessor.DataBindings	For a description of this member, see DataBindings. (Inherited from Control)
IDataBindingsAccessor.HasDataBindings	For a description of this member, see HasDataBindings. (Inherited from Control)
IExpressionsAccessor.Expressions	For a description of this member, see Expressions. (Inherited from Control)
IExpressionsAccessor.HasExpressions	For a description of this member, see HasExpressions. (Inherited from Control)
IParserAccessor.AddParsedSubObject(Object)	For a description of this member, see AddParsedSubObject(Object). (Inherited from Control)

Extension Methods

FindDataSourceControl(Control)	Returns the data source that is associated with the data control for the specified control.
FindFieldTemplate(Control, String)	Returns the field template for the specified column in the specified control's naming container.
FindMetaTable(Control)	Returns the metatable object for the containing data control.

See also

• DataGrid
• DataList
• CellSpacing
• CellPadding
• GridLines
• HorizontalAlign
• DataSource
• DataMember
• DataBind()
• DataKeys
• DataKeyField
• SelectedIndexChanged
• IEnumerable
• DataView
• ArrayList
• DataSet