OBOUT - ASP.NET Grid - Runtime Templates Tutorial

ASP.NET Grid - Runtime Templates Tutorial

The Templates tutorial explained how to create templates in ASP.NET.
In this tutorial we'll focus on creating templates in C# / VBNET (e.g in codebehind files).

Creating templates in C#/VBNET is a bit difficult than in ASP.NET.We'll describe
the steps you need to take in order to make them work.

Creating the Runtime Template

An object of type Obout.Grid.GridRuntimeTemplate must be created.

C#

GridRuntimeTemplate TemplateEditAddress = new GridRuntimeTemplate();
TemplateEditAddress.ID = "TemplateEditAddress";
TemplateEditAddress.ControlID = "txtAddress";
TemplateEditAddress.ControlPropertyName = "value";
TemplateEditAddress.UseQuotes = true;

VB.NET

Dim TemplateEditAddress As Obout.Grid.GridRuntimeTemplate
TemplateEditAddress = New GridRuntimeTemplate()
TemplateEditAddress.ID = "TemplateEditAddress"
TemplateEditAddress.ControlID = "txtAddress"
TemplateEditAddress.ControlPropertyName = "value"
TemplateEditAddress.UseQuotes = True

Creating the Template and setting its CreateTemplate event handler

An object of type Obout.Grid.RuntimeTemplate must be created. This object will be assigned
to the Template property of the previously created GridRuntimeTemplate object.

The object of type Obout.Grid.RuntimeTemplate has a CreateTemplate event that is executed when the
template is rendered. You need to assign an event handler for this event.

C#

TemplateEditAddress.Template = new Obout.Grid.RuntimeTemplate();
TemplateEditAddress.Template.CreateTemplate += new Obout.Grid.GridRuntimeTemplateEventHandler
                                                                    (CreateEditAddressTemplate);

VB.NET

TemplateEditAddress.Template = New Obout.Grid.RuntimeTemplate()         
AddHandler CType(TemplateEditAddress.Template, Obout.Grid.RuntimeTemplate).CreateTemplate,
                                                                    AddressOf CreateEditAddressTemplate

Implementing the methods to generate the template and to bind it to the data

For each Runtime Template you need to write two methods. One will be the one you specified in the
CreateTemplate event handler and one will be responsible to bind the data and to render
the template.

C#

void CreateEditAddressTemplate(Object sender, Obout.Grid.GridRuntimeTemplateEventArgs e)
{
        Literal oLiteral = new Literal();
        e.Container.Controls.Add(oLiteral);
        oLiteral.DataBinding += new EventHandler(DataBindEditAddressTemplate);
}
void DataBindEditAddressTemplate(Object sender, EventArgs e)
{
        Literal oLiteral = sender as Literal;
        Obout.Grid.TemplateContainer oContainer = oLiteral.NamingContainer as 
                                                                    Obout.Grid.TemplateContainer;

        oLiteral.Text = "<textarea id=\"txtAddress\" rows=\"3\" class=\"ob_gridEditControl\"
                                                                    style=\"overflow: auto;\"></textarea>";
}

VB.NET

Sub CreateEditAddressTemplate(ByVal sender As Object, ByVal e As Obout.Grid.GridRuntimeTemplateEventArgs)
        Dim oLiteral = New Literal()
        e.Container.Controls.Add(oLiteral)
        AddHandler CType(oLiteral, Literal).DataBinding, AddressOf DataBindEditAddressTemplate
End Sub
Sub DataBindEditAddressTemplate(ByVal sender As Object, ByVal e As EventArgs)
        Dim oLiteral = CType(sender, Literal)
        Dim oContainer As Obout.Grid.TemplateContainer
        oContainer = CType(oLiteral.NamingContainer, Obout.Grid.TemplateContainer)

        oLiteral.Text = "<textarea id=""txtAddress"" rows=""3"" class=""ob_gridEditControl""
                                                                    style=""overflow: auto;""></textarea>"
End Sub

"These are great products! My clients love them."

Tony Maldonado

Seattle, WA

Random testimonial All testimonials