How to create a summary row for a DataGrid in ASP.NET by using Visual Basic .NET

This step-by-step article describes how to create a summary row for a DataGrid control in ASP.NET by using Visual Basic .NET.

Original product version:   Visual Basic .NET
Original KB number:   313154

Summary

In this article, you create a Visual Basic .NET project, add code to access the view named Sales Totals by Amount from the Northwind database, and then bind the Sales Totals by Amount view to the DataGrid. This sample uses the ItemDataBound event of the DataGrid to total the SaleAmount field when you bind the data to the DataGrid. This sample also uses the footer of the DataGrid to display the summary or the totals.

This article refers to the Microsoft .NET Framework Class Library namespace System.Data.SqlClient.

Requirements

The following list outlines the recommended hardware, software, network infrastructure, and service packs that are required:

• Microsoft Windows
• Microsoft .NET Framework
• Microsoft Visual Studio .NET
• Microsoft Internet Information Services (IIS)
• Microsoft SQL Server 7.0 or later and the Northwind database

Create a Visual Basic .NET project and add the DataGrid

In this section, you create a Visual Basic .NET project, select a format for the DataGrid, and then set the DataGrid to display the footer. Because you use the footer to display the summary, it's important that you display the footer.

1. Start Visual Studio .NET. The Visual Studio .NET IDE appears.

2. On the File menu, point to New, and then click Project.

3. In the New Project dialog box, click Visual Basic Projects under Project Types, and then click ASP.NET Web Application under Templates.

4. In the New Project dialog box, notice that the Name box is unavailable (it appears dimmed). The Location box contains the following text (or similar):
   http://localhost/WebApplication1

   Change the location to http://localhost/SummaryRow, and then click OK. A new project is created, which includes a Web Form that is named WebForm1.aspx.

5. In Solution Explorer, double-click WebForm1.aspx.

6. Drag a DataGrid control from the toolbox to the form.

7. Right-click the DataGrid control, and then click Auto Format. Click Colorful 1, and then click OK.

8. Right-click the DataGrid control, and then click Properties. In the Properties dialog box, change the value of the ShowFooter property to True.

Write code to access the database

In this section, you use the Sales Totals by Amount view that is located in the Northwind database to calculate the summary for the SaleAmount field. The Sales Totals by Amount view includes the Orders, the CompanyName, and the SaleAmount fields.

1. In the IDE, right-click the Web Form, and then click View Code.

2. In the code-behind window, add the following code to the top of the page:

   Imports System.Data
   Imports System.Data.SqlClient
   

3. Add the following code in the class declaration section:

   Private myTotal As System.Double 'This variable tracks the running total.
   

4. Replace the code in the Page_Load event with the following code:

   Private Sub Page_Load(ByVal sender As System.Object, _
   ByVal e As System.EventArgs) Handles MyBase.Load
       'Connect to the database, retrieve data, and then fill the data in the DataSet.
       Dim myConnection As New SqlConnection("server=(local)\netsdk;"Integrated Security=SSPI" & _
       pwd=;database=northwind")
       Dim myDataAdapter As New SqlDataAdapter("SELECT top 15 [OrderID], [CompanyName], " & _
       "[SaleAmount] FROM [Northwind].[dbo].[Sales Totals by Amount]", myConnection)
       Dim myDataSet As New DataSet()
       myDataAdapter.Fill(myDataSet)
       'Set the DataSource for the DataGrid, and then bind the data.
       DataGrid1.DataSource = myDataSet
       DataGrid1.DataBind()
   End Sub
   

5. Modify the connection string as appropriate for your environment.

Use the ItemDataBound event

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

For each item that is data bound, you must check the ItemType property. If ItemType is of type Item or AlternatingItem, you receive the value from the last cell of the item, which contains the SaleAmount value. In this sample, you add this value to the running summary variable. When the ItemType is Footer, you receive the total from all of the rows. Therefore, you assign the value of the summary variable to the text value of the last cell.

Add the following code after the Page_Load event:

Private Sub DataGrid1_ItemDataBound(ByVal sender As Object, _
ByVal e As System.Web.UI.WebControls.DataGridItemEventArgs) Handles DataGrid1.ItemDataBound
    Select Case e.Item.ItemType
    Case ListItemType.AlternatingItem, ListItemType.Item
    'Calculate total for the field of each row and alternating row.
    myTotal += CDbl(e.Item.Cells(2).Text)
    'Format the data, and then align the text of each cell to the right.
    e.Item.Cells(2).Text = Format(CDbl(e.Item.Cells(2).Text), "##,##0.00")
    e.Item.Cells(2).Attributes.Add("align", "right")
    Case ListItemType.Footer
    'Use the footer to display the summary row.
    e.Item.Cells(1).Text = "Total Sales"
    e.Item.Cells(1).Attributes.Add("align", "left")
    e.Item.Cells(2).Attributes.Add("align", "right")
    e.Item.Cells(2).Text = myTotal.ToString("c")
    End Select
End Sub

Build the project and test the code

1. On the File menu, click Save All.
2. On the Build menu, click Build Solution.
3. In Solution Explorer, right-click the .aspx page, and then click View in Browser. The .aspx page appears in the browser, and the DataGrid displays the OrderID, the CompanyName, and the SaleAmount columns. Notice that the footer displays the total of the SaleAmount column.

References

• DataGrid Class
• Formatting Overview