Language

Dynamically Populating a Control (C#)

By Christian Wenz|

Download Code or Download PDF

The DynamicPopulate control in the ASP.NET AJAX Control Toolkit calls a web service (or page method) and fills the resulting value into a target control on the page, without a page refresh.

Overview

The DynamicPopulate control in the ASP.NET AJAX Control Toolkit calls a web service (or page method) and fills the resulting value into a target control on the page, without a page refresh. This tutorial shows how to set this up.

Steps

First of all, you need an ASP.NET Web Service which implements the method to be called by DynamicPopulate. The web service class requires the ScriptService attribute which is defined within Microsoft.Web.Script.Services; otherwise ASP.NET AJAX cannot create the client-side JavaScript proxy for the web service which in turn is required by DynamicPopulate.

The web method must expect one argument of type string, called contextKey, since the DynamicPopulate control sends one piece of context information with each web service call. The following web service returns the current date in a format represented by the contextKey argument:

<%@ WebService Language="C#" Class="DynamicPopulate" %> using System; using System.Web; using System.Web.Services; using System.Web.Services.Protocols; using System.Web.Script.Services; [ScriptService] public class DynamicPopulate : System.Web.Services.WebService { [WebMethod] public string getDate(string contextKey) { string myDate = ""; switch (contextKey) { case "format1": myDate = String.Format("{0:MM}-{0:dd}-{0:yyyy}", DateTime.Now); break; case "format2": myDate = String.Format("{0:dd}.{0:MM}.{0:yyyy}", DateTime.Now); break; case "format3": myDate = String.Format("{0:yyyy}/{0:MM}/{0:dd}", DateTime.Now); break; } return myDate; } }

The web service is then saved as DynamicPopulate.cs.asmx. Alternatively, you could implement the getDate() method as a page method within the actual ASP.NET page with the DynamicPopulate control.

In the next step, create a new ASP.NET file. As always, the first step is to include the ScriptManager in the current page to load the ASP.NET AJAX library and to make the Control Toolkit work:

<asp:ScriptManager ID="asm" runat="server" />

Then, add a label control (for instance using the HTML control of the same name, or the <asp:Label /> web control) which will later show the result of the web service call.

<label id="myDate" runat="server" />

An HTML button (as an HTML control, since we do not require a postback to the server) will then be used to trigger the dynamic population:

<input type="button" id="Button1" runat="server" value="Load date (m-d-y)" />

Finally, we need the DynamicPopulateExtender control to wire things up. The following attributes will be set (apart from the obvious ones, ID and runat="server"):

  • TargetControlID where to put the result from the web service call
  • ServicePath path to the web service (omit if you want to use a page method)
  • ServiceMethod name of the web method or page method
  • ContextKey context information to be sent to the web service
  • PopulateTriggerControlID element which triggers the web service call
  • ClearContentsDuringUpdate whether to empty the target element during the web service call

As you can see, the control requires some information but putting everything into place is quite straight-forward. Here is the markup for the DynamicPopulateExtender control in the current scenario:

<ajaxToolkit:DynamicPopulateExtender ID="dpe1" runat="server" ClearContentsDuringUpdate="true" TargetControlID="myDate" ServicePath="DynamicPopulate.cs.asmx" ServiceMethod="getDate" ContextKey="format1" PopulateTriggerControlID="Button1" />

Run the ASP.NET page in the browser and click on the button; you will receive the current date in month-day-year format.

A click on the button retrieves the date from the server (Click to view full-size image)

This article was originally created on June 2, 2008

Author Information

Christian Wenz

Christian Wenz – Christian Wenz is an author, trainer, and consultant. His main focus of working and writing is on web technologies and security. Christian has written or co-written over 100 books for various publishers. He works with both open source and closed source web technologies. This leads to the unusual situation that he has both been awarded a Microsoft MVP for ASP/ASP.NET and is listed in Zend's Who is Who of PHP. He is also listed in Mozilla's credits (about:credits) and is considered an expert in browser-agnostic JavaScript.