Export (0) Print
Expand All

DataList.ShowHeader Property

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

[Visual Basic]
Public Overridable Property ShowHeader As Boolean
[C#]
public virtual bool ShowHeader {get; set;}
[C++]
public: __property virtual bool get_ShowHeader();
public: __property virtual void set_ShowHeader(bool);
[JScript]
public function get ShowHeader() : Boolean;
public function set ShowHeader(Boolean);

Property Value

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 a null reference (Nothing in Visual Basic).

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.

Example

[Visual Basic, C#] The following example demonstrates how to use the ShowHeader property to display the header section in the DataList control.

[Visual Basic, C#] 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 Web Forms Code Model.
[Visual Basic] 

<%@ Page Language="VB" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>
 
<html>
   <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

      Sub Selection_Change(sender As Object, e As EventArgs)

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

      End Sub
 
   </script>
 
<body>
 
   <form 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"
           ShowBorder="True"
           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"
                 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"
                 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>


[C#] 

<%@ Page Language="C#" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>
 
<html>
   <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>
 
<body>
 
   <form 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"
           ShowBorder="True"
           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"
                 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"
                 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>

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

See Also

DataList Class | DataList Members | System.Web.UI.WebControls Namespace | HeaderStyle | HeaderTemplate

Show:
© 2014 Microsoft