Thursday, October 23, 2008

GridView Tips and Tricks using ASP.NET – Part III ( Fron dotnetcurry)

GridView Tips and Tricks using ASP.NET – Part III


The GridView control is quiet a handy control and is the most commonly used control when building an ASP.NET site. The more you work with it, the more you realize how powerful it can be while presenting data.

Moving ahead with our GridView Tips and tricks series, I have added some more tips in this article. The previous two articles on the Tips and Tricks are mentioned below:



For this article, we would be using the following template to populate the GridView.

<html xmlns="http://www.w3.org/1999/xhtml" >

<head runat="server">

<title>GridView Tips and Tricks Part 2</title>

</head>

<body>

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

<div>

<asp:GridView ID="GridView1" runat="server" AutoGenerateColumns="False" DataKeyNames="CategoryID"

DataSourceID="SqlDataSource1" ShowFooter="true" AllowPaging="True" AllowSorting="True"

PageSize="5" OnRowDataBound="GridView1_RowDataBound">

<Columns>

<asp:TemplateField HeaderText="CategoryID" InsertVisible="False" SortExpression="CategoryID">

<ItemTemplate>

<asp:Label ID="lblCategoryID" runat="server" Text='<%# Bind("CategoryID") %>'></asp:Label>

</ItemTemplate>

</asp:TemplateField>

<asp:TemplateField HeaderText="CategoryName" SortExpression="CategoryName">

<EditItemTemplate>

<asp:TextBox ID="txtCategoryName" runat="server" Text='<%# Bind("CategoryName") %>'></asp:TextBox>

</EditItemTemplate>

<ItemTemplate>

<asp:Label ID="lblCategoryName" runat="server" Text='<%# Bind("CategoryName") %>'></asp:Label>

</ItemTemplate>

</asp:TemplateField>

<asp:TemplateField HeaderText="Description" SortExpression="Description">

<EditItemTemplate>

<asp:TextBox ID="txtDesc" runat="server" Text='<%# Bind("Description") %>'></asp:TextBox>

</EditItemTemplate>

<ItemTemplate>

<asp:Label ID="lblDesc" runat="server" Text='<%# Bind("Description") %>'></asp:Label>

</ItemTemplate>

</asp:TemplateField>

</Columns>

</asp:GridView>

<asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="Data Source=SUPROTIM;Initial Catalog=Northwind;Integrated Security=True"

ProviderName="System.Data.SqlClient" SelectCommand="SELECT [CategoryID], [CategoryName], [Description] FROM [Categories]"

UpdateCommand="UPDATE [Categories] SET [CategoryName] = @CategoryName, [Description] = @Description WHERE [CategoryID] = @CategoryID"/>

</div>

</form>

</body>

</html>

The web.config holding the connection will look similar to the following:

<configuration>

<appSettings/>

<connectionStrings>

<add name="NorthwindConnectionString" connectionString="Data Source =(local);Integrated Security = SSPI; Initial Catalog=Northwind;"/>

</connectionStrings>

...

</configuration>


Tip 1: Change the color of a GridView Row based on some condition

C#

protected void GridView1_RowCreated(object sender, GridViewRowEventArgs e)

{

if (e.Row.DataItem != null)

{

DataRowView drv = (DataRowView)e.Row.DataItem;

string catName = Convert.ToString(drv["CategoryName"]);

if (catName.Trim() == "Confections")

e.Row.BackColor = System.Drawing.Color.LightBlue;

}

}

VB.NET

Protected Sub GridView1_RowCreated(ByVal sender As Object, ByVal e As GridViewRowEventArgs)

If Not e.Row.DataItem Is Nothing Then

Dim drv As DataRowView = CType(e.Row.DataItem, DataRowView)

Dim catName As String = Convert.ToString(drv("CategoryName"))

If catName.Trim() = "Confections" Then

e.Row.BackColor = System.Drawing.Color.LightBlue

End If

End If

End Sub

Tip 2: How to create an Image Command Field Column and add to the GridView at runtime

C#

if (!Page.IsPostBack)

{

CommandField cmdField = new CommandField();

cmdField.ButtonType = ButtonType.Image;

cmdField.SelectImageUrl = "~/Images/Home_Np1.GIF";

cmdField.ShowSelectButton = true;

cmdField.HeaderText = "Select";

GridView1.Columns.Add(cmdField);

GridView1.DataBind();

}

VB.NET

If (Not Page.IsPostBack) Then

Dim cmdField As CommandField = New CommandField()

cmdField.ButtonType = ButtonType.Image

cmdField.SelectImageUrl = "~/Images/Home_Np1.GIF"

cmdField.ShowSelectButton = True

cmdField.HeaderText = "Select"

GridView1.Columns.Add(cmdField)

GridView1.DataBind()

End If

Tip 3: How to display images in the GridView from Filesystem based on an existing Column

Let us imagine that you have a folder ‘Images’ where you have stored images for each category. Eg: 1.GIF, 2.GIF, 3.GIF and so on. Now you want to display a different image based on each CategoryID. So for CategoryID = 1, the image is 1.GIF; for CategoryID=2, the image is 2.GIF and so on.

<asp:TemplateField>

<ItemTemplate>

<asp:Image runat="server" ImageUrl='<%# "~/Images/"+ Eval("CategoryID") + ".GIF" %>' >

</asp:Image>

</ItemTemplate>

</asp:TemplateField>

Tip 4: How to Retrieve Images from the database and display it in a GridView

I will assume that we have a image column called CatImg in the Categories table.

The first step would be to create an ImageHandler. In such scenarios such as the gridview, usually prefer to go in for a handler when I have to return binary data directly from the database. It gives more control on the resource returned. Moreover it is a preferred solution when you have to set the image programmatically.

To add a handler, right click project > Add New Item > Generic Handler > ShowImage.ashx. The code shown below, uses the Request.QueryString[“id”] to retrieve the CategoryID from it. The ID is then passed to the ‘ShowCatImage()’ method where the image is fetched from the database and returned in a MemoryStream object. We then read the stream into a byte array. Using the OutputStream.Write(), we write the sequence of bytes to the current stream and you get to see your image.

C#

<%@ WebHandler Language="C#" Class="ShowImage" %>


using System;

using System.Configuration;

using System.Web;

using System.IO;

using System.Data;

using System.Data.SqlClient;


public class ShowImage : IHttpHandler

{

public void ProcessRequest(HttpContext context)

{

Int32 catid;

if (context.Request.QueryString["id"] != null)

catid = Convert.ToInt32(context.Request.QueryString["id"]);

else

throw new ArgumentException("No parameter specified");


context.Response.ContentType = "image/jpeg";

Stream strm = ShowCatImage(catid);

byte[] buffer = new byte[4096];

int byteSeq = strm.Read(buffer, 0, 4096);


while (byteSeq > 0)

{

context.Response.OutputStream.Write(buffer, 0, byteSeq);

byteSeq = strm.Read(buffer, 0, 4096);

}

//context.Response.BinaryWrite(buffer);

}


public Stream ShowCatImage(int catid)

{

string conn = ConfigurationManager.ConnectionStrings["NorthwindConnectionString"].ConnectionString;

SqlConnection connection = new SqlConnection(conn);

string sql = "SELECT catImg FROM Categories WHERE CategoryID = @ID";

SqlCommand cmd = new SqlCommand(sql, connection);

cmd.CommandType = CommandType.Text;

cmd.Parameters.AddWithValue("@ID", catid);

connection.Open();

object img = cmd.ExecuteScalar();

try

{

return new MemoryStream((byte[])img);

}

catch

{

return null;

}

finally

{

connection.Close();

}

}


public bool IsReusable

{

get

{

return false;

}

}



}


VB.NET

<%@ WebHandler Language="vb" Class="ShowImage" %>


Imports System

Imports System.Configuration

Imports System.Web

Imports System.IO

Imports System.Data

Imports System.Data.SqlClient


Public Class ShowImage

Implements IHttpHandler

Public Sub ProcessRequest(ByVal context As HttpContext) Implements IHttpHandler.ProcessRequest

Dim catid As Int32

If Not context.Request.QueryString("id") Is Nothing Then

catid = Convert.ToInt32(context.Request.QueryString("id"))

Else

Throw New ArgumentException("No parameter specified")

End If


context.Response.ContentType = "image/jpeg"

Dim strm As Stream = ShowCatImage(catid)

Dim buffer As Byte() = New Byte(4095){}

Dim byteSeq As Integer = strm.Read(buffer, 0, 4096)


Do While byteSeq > 0

context.Response.OutputStream.Write(buffer, 0, byteSeq)

byteSeq = strm.Read(buffer, 0, 4096)

Loop

'context.Response.BinaryWrite(buffer);

End Sub


Public Function ShowCatImage(ByVal catid As Integer) As Stream

Dim conn As String = ConfigurationManager.ConnectionStrings("NorthwindConnectionString").ConnectionString

Dim connection As SqlConnection = New SqlConnection(conn)

Dim sql As String = "SELECT catImg FROM Categories WHERE CategoryID = @ID"

Dim cmd As SqlCommand = New SqlCommand(sql, connection)

cmd.CommandType = CommandType.Text

cmd.Parameters.AddWithValue("@ID", catid)

connection.Open()

Dim img As Object = cmd.ExecuteScalar()

Try

Return New MemoryStream(CType(img, Byte()))

Catch

Return Nothing

Finally

connection.Close()

End Try

End Function


Public ReadOnly Property IsReusable() As Boolean Implements IHttpHandler.IsReusable

Get

Return False

End Get

End Property



End Class


To access this image in the GridView based on the CategoryID, just add the following:

<asp:TemplateField>

<ItemTemplate>

<asp:Image runat="server" ImageUrl='<%# "ShowImage.ashx?id=" + Eval("CategoryID") %>' >

</asp:Image>

</ItemTemplate>

</asp:TemplateField>

Tip 5: How to programmatically enable/disable a control in the GridView when in the Edit Mode

If you want to quickly take a decision whether to enable or disable a control when the user edits the row, then use the Enabled attribute and set it to a method that returns a bool value:

<asp:TemplateField HeaderText="CategoryName" SortExpression="CategoryName">

<EditItemTemplate>

<asp:TextBox ID="txtCategoryName" runat="server" Enabled='<%# EnableDisableTextBox() %>' Text='<%# Bind("CategoryName") %>'></asp:TextBox>

</EditItemTemplate>

<ItemTemplate>

<asp:Label ID="lblCategoryName" runat="server" Text='<%# Bind("CategoryName") %>'></asp:Label>

</ItemTemplate>

</asp:TemplateField>

C#

protected bool EnableDisableTextBox()

{

if (1 == 1)

return false;

}

VB.NET

Protected Function EnableDisableTextBox() As Boolean

If 1 = 1 Then

Return False

End If

End Function

You can test this code by adding a CommandField to the GridView as shown below

<asp:CommandField ButtonType="Link" ShowEditButton="true" />

Tip 6: How to insert an Image in between Rows of a GridView using ASP.NET

Please check my article on the same over here


Tip 7: How to loop through all the rows in all the pages of a GridView

One simple way to loop through all the rows in all the pages of a GridView is to access its DataSource. In this example, we will loop through the SQLDataSource to retrieve all the rows in a GridView and access its cell value. You can modify the logic depending on the type of controls you have added to the GridView

C#

protected void Button1_Click(object sender, EventArgs e)

{

DataSourceSelectArguments dsaArgs = new DataSourceSelectArguments();

DataView view = (DataView)SqlDataSource1.Select(dsaArgs);

DataTable dt = view.ToTable();

for (int i = 0; i < dt.Rows.Count; i++)

{

for (int j = 0; j < dt.Columns.Count; j++)

{

string s = dt.Rows[i][j].ToString();

}

}

}

VB.NET

Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)

Dim dsaArgs As DataSourceSelectArguments = New DataSourceSelectArguments()

Dim view As DataView = CType(SqlDataSource1.Select(dsaArgs), DataView)

Dim dt As DataTable = view.ToTable()

For i As Integer = 0 To dt.Rows.Count - 1

For j As Integer = 0 To dt.Columns.Count - 1

Dim s As String = dt.Rows(i)(j).ToString()

Next j

Next i

End Sub

Well that was a quick overview of some of the most frequently used features of the GridView control. I hope you liked the article and I thank you for viewing it.

1 comment:

4 said...

Howdy Dane,

I never think about that way

Thank you SOOO MUCH..