Export (0) Print
Expand All

DataGrid.ItemDataBound Event

Occurs after an item is data bound to the DataGrid control.

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

'Declaration
Public Event ItemDataBound As DataGridItemEventHandler
<asp:DataGrid OnItemDataBound="DataGridItemEventHandler" />

The ItemDataBound event is raised after an item is data bound to the DataGrid control. This event provides you with the last opportunity to access the data item before it is displayed on the client. After this event is raised, the data item is nulled out and no longer available.

For more information about handling events, see Consuming Events.

The following code example demonstrates how to specify and code a handler for the ItemDataBound event to display the order that items in the DataGrid are data bounded.

<%@ 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 language="VB" runat="server">

    Dim Cart As DataTable
    Dim CartView As DataView
    Function CreateDataSource() As ICollection
        Dim dt As New DataTable()
        Dim dr As DataRow

        dt.Columns.Add(New DataColumn("IntegerValue", GetType(Int32)))
        dt.Columns.Add(New DataColumn("StringValue", GetType(String)))
        dt.Columns.Add(New DataColumn("CurrencyValue", GetType(Double)))

        Dim i As Integer
        For i = 0 To 9
            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 New DataView(dt)
        Return dv
    End Function 'CreateDataSource


    Sub Page_Load(sender As Object, e As EventArgs)

        If Not IsPostBack Then
            ' Need to load this data only once.
            ItemsGrid.DataSource = CreateDataSource()
            ItemsGrid.DataBind()
        End If
    End Sub 'Page_Load


    Sub Item_Bound(sender As Object, e As DataGridItemEventArgs)

        Label1.Text = Label1.Text & " " & e.Item.ItemIndex
    End Sub 'Item_Bound 

</script>

<head runat="server">
    <title>DataGrid ItemDataBound Example</title>
</head>
<body>

   <form id="form1" runat="server">

      <h3>DataGrid ItemDataBound Example</h3>

      <asp:DataGrid id="ItemsGrid" runat="server"
           BorderColor="black"
           BorderWidth="1"
           CellPadding="3"
           ShowFooter="true"
           OnItemDataBound="Item_Bound"
           AutoGenerateColumns="true">

         <HeaderStyle BackColor="#00aaaa">
         </HeaderStyle>

         <FooterStyle BackColor="#00aaaa">
         </FooterStyle>

      </asp:DataGrid>

      <br />

      <asp:Label id="Label1" 
           Text="Order of items data bound: " 
           runat="server"/>

      <br />

      <asp:Label id="Label2" 
           Text="Note: The -1's refer to the header and footer." 
           runat="server"/>

   </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 10 

            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

      End Sub

      Sub Item_Bound(sender As Object, e As DataGridItemEventArgs) 

         ' Use the ItemDataBound event to customize the DataGrid control. 
         ' The ItemDataBound event allows you to access the data before 
         ' the item is displayed in the control. In this example, the 
         ' ItemDataBound event is used to format the items in the 
         ' CurrencyColumn in currency format.
         If e.Item.ItemType = ListItemType.Item Or _
             e.Item.ItemType = ListItemType.AlternatingItem Then

            ' Retrieve the text of the CurrencyColumn from the DataGridItem
            ' and convert the value to a Double.
            Dim Price As Double = Convert.ToDouble(e.Item.Cells(2).Text)

            ' Format the value as currency and redisplay it in the DataGrid.
            e.Item.Cells(2).Text = Price.ToString("c")

         End If         

      End Sub

</script>

<head runat="server">
    <title>DataGrid ItemDataBound Example</title>
</head>
<body>

   <form id="form1" runat="server">

      <h3>DataGrid ItemDataBound Example</h3>

      <asp:DataGrid id="ItemsGrid" runat="server"
           BorderColor="black"
           BorderWidth="1"
           CellPadding="3"
           ShowFooter="true"
           OnItemDataBound="Item_Bound">

         <HeaderStyle BackColor="#00aaaa">
         </HeaderStyle>

         <FooterStyle BackColor="#00aaaa">
         </FooterStyle>

      </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 10 

            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)

         ' Manually register the event-handling method for the  
         ' ItemDataBound event of the DataGrid control.
         AddHandler ItemsGrid.ItemDataBound, AddressOf Item_Bound

         ' Load sample data only once, when the page is first loaded.
         If Not IsPostBack Then

            ItemsGrid.DataSource = CreateDataSource()
            ItemsGrid.DataBind()

         End If

      End Sub

      Sub Item_Bound(sender As Object, e As DataGridItemEventArgs) 

         ' Use the ItemDataBound event to customize the DataGrid control. 
         ' The ItemDataBound event allows you to access the data before 
         ' the item is displayed in the control. In this example, the 
         ' ItemDataBound event is used to format the items in the 
         ' CurrencyColumn in currency format.
         If e.Item.ItemType = ListItemType.Item Or _
             e.Item.ItemType = ListItemType.AlternatingItem Then

            ' Retrieve the text of the CurrencyColumn from the DataGridItem
            ' and convert the value to a Double.
            Dim Price As Double = Convert.ToDouble(e.Item.Cells(2).Text)

            ' Format the value as currency and redisplay it in the DataGrid.
            e.Item.Cells(2).Text = Price.ToString("c")

         End If         

      End Sub

</script>

<head runat="server">
    <title>DataGrid ItemDataBound Example</title>
</head>
<body>

   <form id="form1" runat="server">

      <h3>DataGrid ItemDataBound Example</h3>

      <asp:DataGrid id="ItemsGrid" runat="server"
           BorderColor="black"
           BorderWidth="1"
           CellPadding="3"
           ShowFooter="true">

         <HeaderStyle BackColor="#00aaaa">
         </HeaderStyle>

         <FooterStyle BackColor="#00aaaa">
         </FooterStyle>

      </asp:DataGrid>

   </form>

</body>
</html>

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft