How To Make A WebGrid Row Clickable

This snippet is one in a series showing how to use jQuery to enhance the behaviour of a Web Pages WebGrid. This example shows how to make an entire row clickable so that the user is taken to another page that displays details of the selected row.

This example makes use of the SQL CE 4.0 version of the Northwind database. It assumes that you have a layout page that references jQuery and includes a RenderSection call to an optional section named "script":

<!DOCTYPE html>

<html lang="en">
    <head>
        <meta charset="utf-8" />
        <title>@Page.Title</title>
        <script src="@"//code.jquery.com/jquery.min.js"type="text/javascript"></script>
        <link href="@Href("~/styles/site.css")" rel="stylesheet" />
        @RenderSection("script", required: false)
    </head>
    <body>
        @RenderBody()
    </body>
</html>

The main page gets data from the database, specifies some columns and an AJAX update container. It also includes the jQuery that makes rows clickable in the script section:

@{
    Page.Title = "Clickable Rows";
    var db = Database.Open("Northwind");
    var query = "SELECT * FROM Customers";
    var data = db.Query(query);
    var columns = new[]{"CustomerID", "CompanyName", "ContactName", "Address", "City", "Country", "Phone"};
    var grid = new WebGrid(data, ajaxUpdateContainerId: "grid", columnNames: columns);
}
<h1>Clickable Rows</h1>
<div id="grid">
    @grid.GetHtml(    
        tableStyle : "table",
        alternatingRowStyle : "alternate",
        headerStyle : "header"
    )
</div>
@section script{
<script type="text/javascript">
    $(function(){
        $('tbody tr').hover( function(){
            $(this).toggleClass('clickable');
        }).on('click', function(){
            location.href = '/Details/' + $(this).find('td:first').text();  
        }); 
    });
</script>       
}

The CSS for the 'clickable' style is defined as follows:

.clickable{
    cursor: pointer;
    background: #ffff99;
}

As the user runs their cursor (hovers) over the rows of data, the current row turns yellow and the the cursor changes to a hand with a pointing finger shape. This event handler has only been applied to the table rows within the tbody element, so that the table head and foot are not affected. At the same time, the row has a click event handler added, which navigates the user to a page called Details. The text content of the first cell in each row ('td:first') is appended to the URL as UrlData. Accordingly, clicking on the first row will take the user to Details/ALFKI. The code to retrieve and display the related details in this example is simple:

@{
    Page.Title = "Details";
    var db = Database.Open("Northwind");
    var query = "SELECT * FROM Customers WHERE CustomerID = @0";
    var data = db.QuerySingle(query, UrlData[0]);

}
<h1>Details</h1>
@foreach(var item in data.GetDynamicMemberNames()){
    <strong>@item:</strong> @data[item]<br />
}

A demo containing the source code is available here.

 

Date Posted:
Last Updated:
Posted by:
Total Views to date: 66299

7 Comments

- Jacob Fernandez

Thank you for this working tutorial. But I have things in my mind. Is it reusable? What if I have 10 webgrids? What should I do with the jquery?

- Mike

@Jacob,

You can use jQuery to target specific WebGrids by placing them in their own divs, with their own id for instance.

- CodeGolem

Hi! Nice article!
Thank you for sharing.

But what if I don't want to display the ID field on the grid?

:)

- Ola

GREAT example!

The only problem for me is that after changing the grid page it stops working - the grid is not clickable any more.

- Mindaugas

Hi, your tutorials and examples are excellent. I tried to combine the jquery example from searchable webgrid with the jquery from this example but it didn't work. Both have there own <script> section but only the second one seems to be in effect. Can you point me in the right direction? Should I combine the jquery into one?

Thanks again.

@section script{

<script type="text/javascript">
$(function(){
$('th a, tfoot a').live('click', function() {
$('form').attr('action', $(this).attr('href')).submit();
return false;
});
});
</script>
}

- Britto

Works Perfectly... Thx

- Raymond

@CodeGolem: on the ID field, add the following > .Hidden(true)
This prevents the ID from showing, but yet, you can use it since
its still there ;) (ie. if you need to redirect to a detail page or alike..)
Add your comment

If you have any comments to make about this article, please use this form to do so. Make sure that your comment relates specifically to the article above. More general comments can be posted through the form on the Contact page.

Please note, all comments are moderated, and I end up deleting quite a lot. The kind of things that will ensure your comment is deleted without ever seeing the light of day are as follows:

  • Requests to fix your code (post a question to forums.asp.net instead, please)
  • Gratuitous links to your own site or product
  • Anything abusive or libellous
  • Spam

I do not pass email addresses on to spammers, so a valid one will assist me in responding to you personally if required.

Recent Comments

Anh Huynh 4/27/2015 3:51 PM
In response to Create PDFs in ASP.NET - getting started with iTextSharp
I can't get a WRITE access to the online server so I change the method from FileStream to and it for...

Rogerio 4/24/2015 11:16 PM
In response to Adding Search
Hi, great post. Congratulations. @mb, you could make your parameters optional and just at of your...

chandradev 4/24/2015 11:53 AM
In response to 7 C# 6.0 Features That Every ASP.NET Developer Should Know About
very nice article. Thanks for sharing with us....

Lokesh 4/24/2015 9:06 AM
In response to 7 C# 6.0 Features That Every ASP.NET Developer Should Know About
Excellent Article..!! Thanks Mike :)...

kawish 4/24/2015 7:04 AM
In response to Using The Themes Helper In Razor Web Pages
Nice:)...

Mahdi 4/23/2015 9:49 PM
In response to Adding a New Row In The Razor WebGrid
Thank u very very. its useful for me...

Jerrie Pelser 4/23/2015 4:24 PM
In response to Entity Framework 6 Recipe: Storing And Managing Time
Nice article Mike! I think there is an error in the House property getter of MovieFormModel. Your...

mike 4/22/2015 4:45 PM
In response to Parameter Queries in ASP.NET with MS Access
If the insert statement got failed how w can i get the error message of as string?...

frank 4/22/2015 9:44 AM
In response to Sessions in ASP.NET 5
Mike can you write up an article showcasing the difference / upgrade paths of ASP.net Web Pages and...

Scott 4/21/2015 11:39 PM
In response to ASP.NET MVC DropDownLists - Multiple Selection and Enum Support
Excellent! Just what I need for the current application I am working on. Even to the extent that I a...