Using query string values to filter data with model binding and web forms

by Tom FitzMacken

This tutorial series demonstrates basic aspects of using model binding with an ASP.NET Web Forms project. Model binding makes data interaction more straight-forward than dealing with data source objects (such as ObjectDataSource or SqlDataSource). This series starts with introductory material and moves to more advanced concepts in later tutorials.

This tutorial shows how to pass a value in the query string and use that value to retrieve data through model binding.

This tutorial builds on the project created in the earlier parts of the series.

You can download the complete project in C# or VB. The downloadable code works with either Visual Studio 2012 or Visual Studio 2013. It uses the Visual Studio 2012 template, which is slightly different than the Visual Studio 2013 template shown in this tutorial.

What you’ll build

In this tutorial, you’ll:

1. Add a new page to show the enrolled courses for a student
2. Retrieve the enrolled courses for the selected student based on a value in the query string
3. Add a hyperlink with a query string value from the grid view to the new page

The steps in this tutorial are fairly similar to what you did in the earlier tutorial to filter the displayed students based on the user selection in a drop down list. In that tutorial, you used the Control attribute in the select method to specify that the parameter value comes from a control. In this tutorial, you’ll use the QueryString attribute in the select method to specify that the parameter value comes from the query string.

Add new page for displaying a student’s courses

Add a new web form that uses the Site.master master page, and name the page Courses.

In the Courses.aspx file, add a grid view to display the courses for the selected student.

[!code-aspxMain]

   1:  <asp:Content ID="Content1" ContentPlaceHolderID="MainContent" runat="server">

   2:      <asp:GridView runat="server" ID="coursesGrid"

   3:          ItemType="ContosoUniversityModelBinding.Models.Enrollment"

   4:          SelectMethod="coursesGrid_GetData" AutoGenerateColumns="false">

   5:          <Columns>

   6:              <asp:BoundField HeaderText="Title" DataField="Course.Title" />

   7:              <asp:BoundField HeaderText="Credits" DataField="Course.Credits" />

   8:              <asp:BoundField HeaderText="Grade" DataField="Grade" />

   9:          </Columns>

  10:          <EmptyDataTemplate>

  11:              <asp:Label Text="No Enrolled Courses" runat="server" />

  12:          </EmptyDataTemplate>

  13:      </asp:GridView>

  14:  </asp:Content>

Define the select method

In Courses.aspx.cs, you will add the select method with the name you specified in the grid view’s SelectMethod property. In that method, you’ll define the query for retrieving a student’s courses, and specify that the parameter comes from a query string value with the same name as the parameter.

First, you must add the following using statements.

[!code-csharpMain]

   1:  using ContosoUniversityModelBinding.Models;

   2:  using System.Web.ModelBinding;

   3:  using System.Data.Entity;

Then, add the following code to Courses.aspx.cs:

[!code-csharpMain]

   1:  public IQueryable<Enrollment> coursesGrid_GetData([QueryString] int? studentID)

   2:  {

   3:      SchoolContext db = new SchoolContext();

   4:      var query = db.Enrollments.Include(e => e.Course)

   5:          .Where(e => e.StudentID == studentID);

   6:      return query;

   7:  }

The QueryString attribute means that a query string value named StudentID is automatically assigned to the parameter in this method.

Add hyperlink with query string value

In the grid view on Students.aspx, you will add a hyperlink field that links to your new Courses page. The hyperlink will include a query string value with the student’s id.

In Students.aspx, add the following field to the grid view columns just below the field for Total Credits.

[!code-aspxMain]

   1:  <asp:TemplateField HeaderText="Total Credits">  

   2:      <ItemTemplate>

   3:          <asp:Label Text="&lt;%# Item.Enrollments.Sum(en => en.Course.Credits) %>" 

   4:              runat="server" />

   5:      </ItemTemplate>

   6:  </asp:TemplateField>

   7:  <asp:HyperLinkField Text="Courses" DataNavigateUrlFormatString="~/Courses.aspx?StudentID={0}"

   8:      DataNavigateUrlFields="StudentID" />

Run the application and notice that the grid view now includes the Courses link.

When you click one of the links, you’ll see that student’s enrolled courses.

Conclusion

In this tutorial, you added a link with a query string value. You used that query string value for the parameter value in the select method.

In the next tutorial, you will move the code from the code-behind files into a business logic layer and a data access layer.

Previous Next

Comments ( )