System.Web 1.0.5000.0 2.0.0.0 Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details. System.Web.UI.WebControls.WebControl System.ComponentModel.Designer("System.Web.UI.Design.WebControls.BaseDataListDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.IDesigner") System.ComponentModel.DefaultProperty("DataSource") System.ComponentModel.DefaultEvent("SelectedIndexChanged")

The class provides the common functionality for all data listing controls, such as and . A data listing control is used to display the records from a data source, such as a control. Each data listing control can have a unique display style and capabilities. Because the 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 property. To determine the amount of spacing between the contents of a cell and the cell's border, set the property. You can display the border between the individual cells of a data listing control by setting the property. The horizontal alignment of the content in the cells of a data listing control is controlled by the property.

The class provides two properties to support data binding. To bind data to any collection that implements the interface (such as or ), or the interface, use the property to specify the data source. When you set the 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 property and set its value to the property of the data source control to use. When you set the property, the data listing control automatically binds to the specified data source control. Therefore, you do not need to explicitly call the method.

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

The class contains a 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 property.

The class provides a 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.

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

- Constructor

  A object is not created directly. This constructor is commonly called in the constructor of a derived class to initialize the properties defined in the class.

  Initializes a new instance of the class.

  1.0.5000.0
  2.0.0.0
- Method
  System.Void `` To be added

  Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's collection.

  An that represents the parsed element. 1.0.5000.0 2.0.0.0
- Property
  1.0.5000.0
  2.0.0.0
  System.ComponentModel.Localizable(true)
  System.ComponentModel.DefaultValue("")
  System.String To be added.

  Use the property to specify the text to render in an HTML caption element in the control. The text that you specify provides assistive technology devices with a description of the control.

  To specify the alignment of the HTML caption element in the control, use the property.

  The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see and ASP.NET Globalization and Localization.

  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.

- Property
  1.0.5000.0
  2.0.0.0
  System.ComponentModel.DefaultValue(System.Web.UI.WebControls.TableCaptionAlign.NotSet)
  System.Web.UI.WebControls.TableCaptionAlign To be added.

  Use the property to specify 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.

  This property is set using one of the enumeration values. The following table lists the possible values.

  Value

  Description

  NotSet

  The caption element's alignment is not set.

  Top

  The caption element is aligned with the top of the table.

  Bottom

  The caption element is aligned with the bottom of the table.

  Left

  The caption element is aligned with the left edge of the table.

  Right

  The caption element is aligned with the right edge of the table.

  Use the property to specify the text to render in an HTML caption element in a control.

  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.

- Property
  System.Int32 To be added: an object of type 'int'

  Use the property to control the spacing between the contents of a cell and the cell's border. The padding amount specified is added to all four sides of the cell.

  All cells in the same column of a data listing control share the same cell width. Therefore, if the content of one cell is longer than the content of other cells in the same column, the padding amount is applied to the widest cell. All other cells in the column are also set to this cell width.

  Similarly, all cells in the same row share the same height. The padding amount is applied to the height of the tallest cell in the row. All other cells in the row are set to this cell height. Individual cell sizes cannot be specified.

  Gets or sets the amount of space between the contents of a cell and the cell's border.

  1.0.5000.0
  2.0.0.0
  System.ComponentModel.DefaultValue(-1)
- Property
  System.Int32 To be added: an object of type 'int'

  Use the property to control the spacing between adjacent cells in a data listing control. This spacing is applied both vertically and horizontally. The cell spacing is uniform for the entire data listing control. Individual cell spacing between each row or column cannot be specified.

  If you set this property to a value greater than 0 and set the property to a value that displays the cell borders, a gap is displayed between the borders of adjacent cells. In this situation, the property controls the size of the gap.

  Gets or sets the amount of space between cells.

  1.0.5000.0
  2.0.0.0
  System.ComponentModel.DefaultValue(0)
- Property
  System.Web.UI.ControlCollection a

  Use the collection to manage the child controls contained in a data listing control. You can add controls, remove controls, or iterate through the server controls in the collection.

  Gets a object that contains a collection of child controls in a data listing control.

  1.0.5000.0
  2.0.0.0
- Method
  System.Void To be added

  Creates a child control using the view state.

  1.0.5000.0
  2.0.0.0
- Method
  System.Void ``

  The method is a helper method used by a derived class to create its control hierarchy.

  When overridden in a derived class, creates the control hierarchy for the data listing control with or without the specified data source.

  true to use the control's data source; otherwise, false. 1.0.5000.0 2.0.0.0
- Method
  2.0.0.0
  System.Web.UI.DataSourceSelectArguments

  The method is a helper method used by the property to create its default object.

  Creates a default object used by the data-bound control if no arguments are specified.

  A initialized to .

- Method
  System.Void

  Use the method to bind the data source specified by the property to the data listing control. By binding the data source to a data listing control, the information in the data source is displayed in a data listing control.

  The method is also commonly used to synchronize the data source and a data listing control after information in the data source is updated. This allows any changes in the data source to also be updated in a data listing control.

  If the data source for the data listing control is specified by the property, you do not need to call the method. ASP.NET calls this method automatically to bind the specified data source control to the data listing control.

  Binds the control and all its child controls to the specified data source.

  1.0.5000.0
  2.0.0.0
- Property
  System.String To be added: an object of type 'string'

  Use the property to specify the key field in the data source indicated by the property. The specified field is used to populate the collection. 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 in a handler for an event, such as ItemCommand or DeleteCommand, as part of an update query string to revise a specific record in the data source. The key field helps the update query string identify the appropriate record to modify.

  This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.

  Gets or sets the key field in the data source specified by the property.

  1.0.5000.0
  2.0.0.0
  System.Web.UI.Themeable(false)
  System.ComponentModel.DefaultValue("")
- Property
  System.Web.UI.WebControls.DataKeyCollection To be added: an object of type 'DataKeyCollection'

  Use the collection to access the key values 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. This collection is automatically filled with the values from the field specified by the property.

  The key field is commonly used in a handler for an event, such as ItemCommand or DeleteCommand, as part of an update query string to revise a specific record in the data source. The key field helps the update query string identify the appropriate record to modify.

  For more information on accessing data with ASP.NET, see Accessing Data with ASP.NET.

  Gets a object that stores the key values of each record in a data listing control.

  1.0.5000.0
  2.0.0.0
  System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
  System.ComponentModel.Browsable(false)
- Property
  System.Collections.ArrayList a

  The property is used by a derived class to store the key values of each record in a data listing control. This property is generally used to generate the object contained in the property.

  Gets an object that contains the key values of each record in a data listing control.

  1.0.5000.0
  2.0.0.0
- Property
  System.String To be added: an object of type 'string'

  Use the property to specify a member from a multimember data source to bind to the list control. For example, if you have a data source with more than one table specified in the property, use the property to specify which table to bind to a data listing control.

  This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.

  Gets or sets the specific data member in a multimember data source to bind to a data listing control.

  1.0.5000.0
  2.0.0.0
  System.Web.UI.Themeable(false)
  System.ComponentModel.DefaultValue("")
- Property
  System.Object To be added: an object of type 'object'

  Use the property to specify the source of values to bind to a data listing control. A data source must be a collection that implements either the interface (such as , , or ) or the interface to bind to a control derived from the class. When you set the property, you must manually write the code to perform data binding.

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

  Alternately, you can use the property to automatically bind to a data source represented by a data source control. When you set the property, the data listing control automatically binds to the specified data source control. You do not need to write code that explicitly calls the method.

  If values are specified for both the property and the property, ASP.NET is not able to resolve the data source and an exception is thrown.

  This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.

  Gets or sets the source containing a list of values used to populate the items within the control.

  1.0.5000.0
  2.0.0.0
  System.Web.UI.Themeable(false)
  System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
  System.ComponentModel.DefaultValue(null)
  System.ComponentModel.Bindable(true)
- Property
  2.0.0.0
  System.Web.UI.Themeable(false)
  System.Web.UI.IDReferenceProperty(typeof(System.Web.UI.DataSourceControl))
  System.ComponentModel.DefaultValue("")
  System.String To be added.

  Use the property to access the property of the data source control that the data listing control should use to retrieve its data source. The data source control referenced by the property can be any control that implements the interface. The data source control must exist either in the same naming container as the data listing control that references it, or in a parent control of the data listing control. When you specify a value for this property, the data listing control automatically binds to the specified data source control. You do not need to write code that explicitly calls the method.

  Alternately, you can use the property to specify the source of values to bind to a data listing control. The data source must be a collection that implements the interface (such as , , or ) or the interface to bind to a control derived from the class. When you set the property, you must manually write the code to perform data binding.

  If values are specified for both the property and the property, ASP.NET is not able to resolve the data source and an exception is thrown.

  This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes Overview.

  Gets or sets the property of the data source control that the data listing control should use to retrieve its data source.

- Method
  2.0.0.0
  System.Void

  When you specify a value for the property, ASP.NET automatically binds the data listing control to the specified data source control. When ASP.NET performs data binding for the control, it calls the method first to verify that the control has not already been bound to data and that a valid data source control that implements the interface is specified for its property. The method then calls the method.

  Verifies that the data listing control requires data binding and that a valid data source control is specified before calling the method.

- Method
  2.0.0.0
  System.Collections.IEnumerable

  The method is a helper method called by derived classes (such as and ) to retrieve the data source.

  Returns an -implemented object that represents the data source.

  An -implemented object that represents the data source.

- Property
  System.Web.UI.WebControls.GridLines To be added: an object of type 'GridLines'

  Use the property to specify whether the border between the cells of a data listing control is displayed. This property is set with one of the enumeration values. The following table lists the possible values.

  Value

  Description

  None

  No cell border is displayed.

  Horizontal

  Only the upper and lower borders of the cells in a data listing control are displayed.

  Vertical

  Only the left and right borders of the cells in the data list control are displayed.

  Both

  All borders of the cells in a data listing control are displayed.

  Gets or sets a value that specifies whether the border between the cells of a data listing control is displayed.

  1.0.5000.0
  2.0.0.0
  System.ComponentModel.DefaultValue(System.Web.UI.WebControls.GridLines.Both)
- Property
  System.Web.UI.WebControls.HorizontalAlign To be added: an object of type 'HorizontalAlign'

  Use the property to specify the horizontal alignment of a data listing control within its container. This property is set with one of the enumeration values. The following table lists the possible values.

  Value

  Description

  NotSet

  The horizontal alignment is not set.

  Left

  The data listing control is left-aligned within its container.

  Center

  The data listing control is centered within its container.

  Right

  The data listing control is right-aligned within its container.

  Gets or sets the horizontal alignment of a data listing control within its container.

  1.0.5000.0
  2.0.0.0
  System.ComponentModel.DefaultValue(System.Web.UI.WebControls.HorizontalAlign.NotSet)
  System.ComponentModel.Category("Layout")
- Property
  2.0.0.0
  System.Boolean To be added.

  The property is used by derived classes (such as and ) to determine whether the control has been initialized.

  Gets a value indicating whether the control has been initialized.

- Method
  System.Boolean ``

  Use the static method to determine whether the specified data type can be bound to a list control that inherits from the class. The supported data types are , , , , , , , , , , , , , , and .

  Determines whether the specified data type can be bound to a list control that derives from the class.

  true if the specified data type can be bound to a list control that derives from the class; otherwise, false.

  A that contains the data type to test. 1.0.5000.0 2.0.0.0
- Property
  2.0.0.0
  System.Boolean To be added.

  The property is used by derived classes (such as and ) to determine whether the data-bound control is bound to an ASP.NET version 2.0 data source control.

  Gets a value indicating whether the property is set.

- Method
  System.Void ``

  The event is raised when data is bound to the control. This method notifies the control to perform any data-binding logic that is associated with it.

  Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

  The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

  Raises the event of a control.

  An that contains the event data. 1.0.5000.0 2.0.0.0
- Method
  2.0.0.0
  System.Void

  The method is called to rebind the data-bound control to its data when the , , or property changes values after the page's event.

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

- Method
  2.0.0.0
  System.Void `` ``

  The method notifies a data-bound control that the underlying data source has changed and that the control should rebind and any necessary work should be performed. Typically, the method is called when a property of the data source view has changed.

  The class sets the property to true when the event is raised.

  Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

  The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

  Raises the event.

  The source of the event. An that contains the event data.
- Method
  2.0.0.0
  System.Void ``

  The method notifies the control to perform any initialization steps that are required to create and set up an instance.

  Raises the event for the control.

  An that contains the event data.
- Method
  2.0.0.0
  System.Void `` To be added.

  Raises the event.

  An that contains the event data.
- Method
  2.0.0.0
  System.Void `` `` To be added. To be added. To be added. To be added.
- Method
  2.0.0.0
  System.Void `` To be added.

  Raises the event.

  An that contains the event data.
- Method
  System.Void ``

  The event is raised when a different item is selected in a data listing control between posts to the server. The method allows you to create a custom handler for the event.

  Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

  The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

  Raises the event of a control.

  An that contains the event data. 1.0.5000.0 2.0.0.0
- Method
  System.Void

  When you inherit from , you must implement the method to prepare the control hierarchy for the data-bound control.

  Sets up the control hierarchy for the data-bound control.

  1.0.5000.0
  2.0.0.0
- Method
  System.Void `` To be added

  Renders the control to the specified HTML writer.

  A that contains the output stream to render on the client. 1.0.5000.0 2.0.0.0
- Property
  2.0.0.0
  System.Boolean To be added.

  The control uses the property to determine whether the control needs to call the method to bind to its specified data source.

  Each time the set accessor is called on either the , the , or the property to change the data source after the method has already been called, ASP.NET automatically sets the value of the property to true. The value of the property is also set to true when the method is called.

  ASP.NET automatically sets the value of the property to false immediately after the method has been called.

  Gets or sets a value indicating whether the data listing control needs to bind to its specified data source.

- Property
  2.0.0.0
  System.Web.UI.DataSourceSelectArguments To be added.

  The property calls the method to create a default object.

  Gets a object that the data-bound control uses when retrieving data from a data source control.

- Event
  System.EventHandler

  The event is raised when a different item is selected in a data listing control between posts to the server.

  For more information about handling events, see Consuming Events.

  Occurs when a different item is selected in a data listing control between posts to the server.

  1.0.5000.0
  2.0.0.0
- Property
  1.0.5000.0
  2.0.0.0
  System.ComponentModel.DefaultValue(false)
  System.Boolean To be added.

  Use the property to specify 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. By default, the value of this property is false and the header for the control is rendered between cell tags <td> and </td>. If the value of this property is true, the header for the control is rendered between table header cell tags <th> and </th>. In addition, a scope="col" attribute is added to the table header to specify that the header applies to all the cells in the column. The default rendering of the <th> element is preserved, rendering text as bold and centered horizontally. Developers can override the behavior of the <th> element using a cascading style sheet (CSS). However, requiring the use of style sheets is discouraged when creating accessible Web pages.

  For data listing controls, such as the control and the control, that inherit from the class, you can set the property declaratively or programmatically. If you set the property programmatically, set it before binding data with the method.

  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.