Edit

Share via

DataList.ShowHeader Property

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

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

C# 
[System.ComponentModel.Bindable(true)]
public virtual bool ShowHeader { get; set; }
C# 
public virtual bool ShowHeader { get; set; }

Property Value

Boolean

true if the header is displayed; otherwise, false. The default value is true, however this property is only examined when the HeaderTemplate property is not null.

Attributes
BindableAttribute

Examples

The following code example demonstrates how to use the ShowHeader property to display the header section in the DataList control.

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.

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 DataList control.
         DataTable dt = new DataTable();
         DataRow dr;
 
         // Define the columns of the table.
         dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32)));
         dt.Columns.Add(new DataColumn("StringValue", typeof(String)));
         dt.Columns.Add(new DataColumn("CurrencyValue", typeof(double)));
         dt.Columns.Add(new DataColumn("ImageValue", typeof(String)));
 
         // Populate the table with sample values.
         for (int i = 0; i < 9; i++) 
         {
            dr = dt.NewRow();
 
            dr[0] = i;
            dr[1] = "Description for item " + i.ToString();
            dr[2] = 1.23 * (i + 1);
            dr[3] = "Image" + i.ToString() + ".jpg";
 
            dt.Rows.Add(dr);
         }
 
         DataView dv = new DataView(dt);
         return dv;
      }
  
      void Page_Load(Object sender, EventArgs e) 
      {

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

      }

      void Selection_Change(Object sender, EventArgs e)
      {

         // Set whether to display the header and footer sections
         // of the DataList control.
         ItemsList.ShowHeader = ShowHeaderCheckBox.Checked;
         ItemsList.ShowFooter = ShowFooterCheckBox.Checked;

      }
 
   </script>
 
<head runat="server">
    <title>DataList ShowHeader and ShowFooter Example</title>
</head>
<body>
 
   <form id="form1" runat="server">

      <h3>DataList ShowHeader and ShowFooter Example</h3>

      Select whether to show or hide the header and footer sections.

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

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

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

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

         <HeaderTemplate>

            List of items

         </HeaderTemplate>

         <FooterTemplate>

            <asp:Image id="FooterImage"
                 GenerateEmptyAlternateText='true'
                 ImageUrl='FooterImage.jpg'
                 runat="server"/>

         </FooterTemplate>
               
         <ItemTemplate>

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

            <br />

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

            <br />

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

         </ItemTemplate>
 
      </asp:DataList>

<hr />

      <table cellpadding="5">

         <tr>

            <td>

               <asp:CheckBox id="ShowHeaderCheckBox"
                    Text="Show header section"
                    Checked="True"
                    AutoPostBack="True"
                    OnCheckedChanged="Selection_Change"
                    runat="server"/>
 
            </td>

            <td>

               <asp:CheckBox id="ShowFooterCheckBox"
                    Text="Show footer section"
                    Checked="True"
                    AutoPostBack="True"
                    OnCheckedChanged="Selection_Change"
                    runat="server"/>

            </td>

         </tr>

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

Remarks

Use the ShowHeader property to specify whether the header section is displayed in the DataList control.

You can control appearance of the header section by setting the HeaderStyle property. The contents of the header section are controlled by the HeaderTemplate property.

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

See also