Creating DataGrid Templated Columns Dynamically - Part II

Introduction

In previous part of this article we saw how to use LoadTemplate method to dynamically add templated columns to the DataGrid. In this part we will see how to do that using ITemplate interface.

ITemplate Interface

This interface found in System.Web.UI namespace has one method with following signature.

void InstantiateIn(Control container);

This method must be implemented in order to decide 'parent' of the template.

Implementing ITemplate interface

Let us start by creating our own implementation of ITemplate. Create a new class and add following code to it:

using System;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Data;

namespace DynamicDataGridTemplates
{
public class CTemplateColumn:ITemplate
{
	private string colname;

	public CTemplateColumn(string cname)
	{
		colname=cname;
	}

	//must implement following method
	public void InstantiateIn(Control container)
	{
		LiteralControl l = new LiteralControl();
		l.DataBinding += 
		new EventHandler(this.OnDataBinding);
		container.Controls.Add(l);
	}

	public void OnDataBinding(object sender, EventArgs e)
	{
		LiteralControl l = (LiteralControl) sender;
		DataGridItem container = 
		(DataGridItem) l.NamingContainer;
		l.Text = 
		((DataRowView)
		container.DataItem)[colname].ToString();
	}
}
}

Here, the constructor accepts the column name to which we want to bind our templated column. We have created a literal control in the InstantiateIn method. Since our column will be data bound we add OndataBinding event handler that populates the control with the appropriate values. Then we add this literalcontrol to the container's controls collection. In the OnDataBinding event handler the NamingContainer gives the current DataGridItem (since our parent control is DataGrid).

Adding a template column to the DataGrid

Now, let us use our implementation of ITemplate interface to add a templated column to the DataGrid. Add following code in the page_Load event.

DataGrid datagrid1=new DataGrid();
TemplateColumn tc1=new TemplateColumn();
tc1.ItemTemplate=new CTemplateColumn("lastname");
tc1.HeaderText="Last Name";
datagrid1.Columns.Add(tc1);
Page.Controls[1].Controls.Add(datagrid1);

string connstr = 
@"Integrated Security=SSPI;User ID=sa;Initial 
Catalog=Northwind;Data Source=MyServer/NetSDK";
SqlConnection cnn=new SqlConnection(connstr);
SqlDataAdapter da=
new SqlDataAdapter("select * from employees", cnn)
DataSet ds=new DataSet();
da.Fill(ds, "employees");

datagrid1.DataSource = ds;
datagrid1.DataMember = "employees";
datagrid1.DataBind();

Here, we have create instance of DataGrid class. We have crerated instance of TemplateColumn class. Our intention is to add a templated column whose ItemTemplate is as decided by our class. Hence we set ItemTemplate property. In the same manner you can also set EditItemTemplate. We have passed the column name (lastname) in the constructor of this class. We then add this column to the DataGrid and DataGrid to the page. Binding of DataGrid follows as usual.

After running your application you should get a DataGrid with single templated column titled 'Last Name'.

Summary

In this article we saw how to add a templated column to a DataGrid on the fly using ITemplate interface. We created a custom class that implemented this interface We then set this class as ItemTemplate for the DataGrid. As you see this method though a bit complex gives more overall control on the process.

About the author

Name :	Bipin Joshi
Email :	webmaster@dotnetbips.com
Profile :	Bipin Joshi - the creator and owner of DotNetBips - is a Microsoft MVP, Software Developer and Author. He has written dozens of articles for DotNetBips and other web sites. Know more about him and DotNetBips here.