FormView.HeaderRow Property

 

Gets the FormViewRow object that represents the header row in a FormView control.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

<BrowsableAttribute(False)>
Public Overridable ReadOnly Property HeaderRow As FormViewRow

Property Value

Type: System.Web.UI.WebControls.FormViewRow

A FormViewRow that represents the header row in a FormView control.

The header row is displayed at the top of the FormView control when the HeaderText or HeaderTemplate property is set. Use the HeaderRow property to programmatically access the FormViewRow object that represents the header row.

System_CAPS_noteNote

The HeaderRow property is available only after the FormView control creates the header row in the ItemCreated event.

This property is commonly used when you need to programmatically manipulate the header row, for example, when adding custom content. Any modification to the HeaderRow property must be performed after the FormView control has been rendered; otherwise, the FormView control overwrites any changes.

The following example demonstrates how to use the HeaderRow property to programmatically modify the properties of the header row during the ItemCreated event.


<%@ Page language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Sub EmployeeFormView_ItemCreated(ByVal sender As Object, ByVal e As EventArgs)

    ' Use the HeaderRow property to retrieve the header row.
    Dim header As FormViewRow = EmployeeFormView.HeaderRow

    ' Retrieve the HeaderLabel Label control from the header row. 
    Dim headerLabel As Label = CType(header.FindControl("HeaderLabel"), Label)

    If headerLabel IsNot Nothing Then

      ' Display the current page number.
      Dim currentPage As Integer = EmployeeFormView.PageIndex + 1
      headerLabel.Text = "Page " & currentPage.ToString()

    End If

  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>FormView HeaderTemplate Example</title>
</head>
<body>
    <form id="Form1" runat="server">

      <h3>FormView HeaderTemplate Example</h3>

      <asp:formview id="EmployeeFormView"
        datasourceid="EmployeeSource"
        allowpaging="true" 
        datakeynames="EmployeeID"
        onitemcreated="EmployeeFormView_ItemCreated"
        runat="server">

        <headertemplate>
          <table>
            <tr>
              <td>
                <asp:image id="LogoImage"
                  imageurl="~/Images/LogoImage.jpg"
                  alternatetext="Our Logo"
                  runat="server"/>
              </td>
              <td>
                <asp:label id="HeaderLabel"
                  runat="server"/>
              </td>
            </tr>
          </table>
        </headertemplate>

        <headerstyle horizontalalign="Center"
          forecolor="White"
          backcolor="LightBlue"/>

        <itemtemplate>

          <table>
            <tr>
              <td>
                <asp:image id="EmployeeImage"
                  imageurl='<%# Eval("PhotoPath") %>'
                  alternatetext='<%# Eval("LastName") %>' 
                  runat="server"/>
              </td>
              <td>
                <h3><%# Eval("FirstName") %>&nbsp;<%# Eval("LastName") %></h3>      
                <%# Eval("Title") %>        
              </td>
            </tr>
          </table>

        </itemtemplate>

        <pagersettings position="Bottom"
          mode="NextPrevious"/> 

      </asp:formview>

      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="EmployeeSource"
        selectcommand="Select [EmployeeID], [LastName], [FirstName], [Title], [PhotoPath] From [Employees]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
        runat="server"/>

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

.NET Framework
Available since 2.0
Return to top
Show: