BaseDataList.Controls Property

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 virtual property System::Web::UI::ControlCollection ^ Controls { System::Web::UI::ControlCollection ^ get(); };

public override System.Web.UI.ControlCollection Controls { get; }

member this.Controls : System.Web.UI.ControlCollection

Public Overrides ReadOnly Property Controls As ControlCollection

Property Value

ControlCollection

A ControlCollection that contains a collection of child controls in a data listing control.

Examples

The following code example demonstrates how to programmatically add a control to the Controls collection.

ASP.NET (C#)


<%@ Page Language="C#" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
   <script runat="server">
 
      ICollection CreateDataSource() 
      {
         // Create sample data for the DataGrid control.
         DataTable dt = new DataTable();
         DataRow dr;
 
         // Define columns for the data source.
         dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32)));
         dt.Columns.Add(new DataColumn("StringValue", typeof(string)));
         dt.Columns.Add(new DataColumn("CurrencyValue", typeof(double)));
 
         // Populate data source with sample values.
         for (int i = 0; i < 9; i++) 
         {
            dr = dt.NewRow();
 
            dr[0] = i;
            dr[1] = "Item " + i.ToString();
            dr[2] = 1.23 * (i + 1);
 
            dt.Rows.Add(dr);
         }
 
         DataView dv = new DataView(dt);
         return dv;
      }
 
      void Page_Load(Object sender, EventArgs e) 
      {
 
         // Bind data to the DataGrid control only when the page first loads.
         if (!IsPostBack) 
         {
            ItemsGrid.DataSource= CreateDataSource();
            ItemsGrid.DataBind();
         }

         // Create a Label control to display the total number of items 
         // displayed in the DataGrid.
         Label myLabel = new Label();
         myLabel.Text = "<br /><br /><b>Total Number of Items: " + ItemsGrid.Items.Count.ToString() + "</b>";
         myLabel.ID = "SummaryLabel";

         // Add the Label control to the Controls collection of the DataGrid.
         ItemsGrid.Controls.Add(myLabel);

      }

   </script>
 
<head runat="server">
    <title>BaseDataList Controls Example</title>
</head>
<body>
 
   <form id="form1" runat="server">
 
      <h3>BaseDataList Controls Example</h3>
 
      <b>Product List</b>
 
      <asp:DataGrid id="ItemsGrid"
           BorderColor="black"
           BorderWidth="1"
           CellPadding="3"
           AutoGenerateColumns="True"
           runat="server">

         <HeaderStyle BackColor="#00aaaa">
         </HeaderStyle>
 
      </asp:DataGrid>

   </form>
 
</body>
</html>


<%@ 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 DataGrid 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)))
 
         ' Populate the table with sample values.
         Dim i As Integer

         For i = 0 to 8 
        
            dr = dt.NewRow()
 
            dr(0) = i
            dr(1) = "Item " & i.ToString()
            dr(2) = 1.23 * (i + 1)
 
            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 
  
            ItemsGrid.DataSource = CreateDataSource()
            ItemsGrid.DataBind()

         End If

         ' Create a Label control to display the total number of items 
         ' displayed in the DataGrid.
         Dim myLabel As Label = New Label()
         myLabel.Text = "<br /><br /><b>Total Number of Items: " & ItemsGrid.Items.Count.ToString() & "</b>"
         myLabel.ID = "SummaryLabel"

         ' Add the Label control to the Controls collection of the DataGrid.
         ItemsGrid.Controls.Add(myLabel)

      End Sub

   </script>
 
<head runat="server">
    <title>BaseDataList Controls Example</title>
</head>
<body>
 
   <form id="form1" runat="server">
 
      <h3>BaseDataList Controls Example</h3>
 
      <b>Product List</b>
 
      <asp:DataGrid id="ItemsGrid"
           BorderColor="black"
           BorderWidth="1"
           CellPadding="3"
           AutoGenerateColumns="True"
           runat="server">

         <HeaderStyle BackColor="#00aaaa">
         </HeaderStyle>
 
      </asp:DataGrid>

   </form>
 
</body>
</html>

Remarks

Use the Controls 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.

Applies to

Product	Versions
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via