About GridView, HyperLinkField, and UrlEncode

Introduction

Unlike BoundField, HyperLinkField doesn't have methods like HtmlEncode or UrlEncode etc. But, it's quite normal when you have to do a "URL encode" processing for a hyperlink's parameter. Such as a person name may contain special characters like '&', etc. For eastern developers in China, Japan, or Korea, this will be more familiar.

Background

Some of us hope Microsoft will add such a commonly-used feature in the next version of the .NET Framework. But it's still a problem in .NET 3.x till now. We learned from a feedback report from Microsoft that Microsoft will do no modification on this due to its policy on backwards compatibility between versions of the .NET Framework. Till now, the popular way to solve this problem is to convert the HyperLinkField into a TemplateField and to use the HttpUtility.UrlEncode method to solve it by hand. Because this conversion is not reversible, it may introduce some inconveniences when you have to do some minor modifications.

Using the Code

The following code gives you another choice, avoiding conversion into a TemplateField and hacking for the UrlEncode feature of the HyperLinkField:

public static void HyperLinkFieldUrlEncodeHack(GridView gridView)
{
    if (gridView == null)
    {
        return;
    }
    gridView.RowDataBound += delegate(object sender, GridViewRowEventArgs e)
    {
        if (e.Row.RowType != DataControlRowType.DataRow)
        {
            return;
        }
        for (int i = 0; i < gridView.Columns.Count; i++)
        {
            DataControlField field = gridView.Columns[i];
            if (field is HyperLinkField)
            {
                TableCell td = e.Row.Cells[i];
                if (td.Controls.Count > 0 && td.Controls[0] is HyperLink)
                {
                    HyperLink hyperLink = (HyperLink)td.Controls[0];
                    HyperLinkField hyperLinkField = (HyperLinkField)field;
                    if (!String.IsNullOrEmpty(hyperLinkField.DataNavigateUrlFormatString))
                    {
                        string[] dataUrlFields = 
                          new string[hyperLinkField.DataNavigateUrlFields.Length];
                        for (int j = 0; j < dataUrlFields.Length; j++)
                        {
                            object obj = DataBinder.Eval(e.Row.DataItem,
                                hyperLinkField.DataNavigateUrlFields[j]);
                            dataUrlFields[j] = HttpUtility.UrlEncode(
                                (obj == null ? "" : obj.ToString()));
                        }
                        hyperLink.NavigateUrl = String.Format(
                            hyperLinkField.DataNavigateUrlFormatString, dataUrlFields);
                    }
                }
            }
        }
    };
}

You may simply call this method and pass the GridView, which includes the HyperLinkField which needs the URL Encode hacking, as the parameter. It'll be OK! Quite simple, isn't it?

Points of Interest

Just like the guys who left comments after the post, I also opposite Microsoft's strict backwards compatibility policy. While different versions of .NET applications can run side-by-side, why give so much attention to it? That is just my opinion.

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)