TemplateInstance Enumeration


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Specifies how many times an instance of a template can be created.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

public enum TemplateInstance

Member nameDescription

A template that is instantiated multiple times.


A template that is instantiated only one time.

The TemplateInstance enumeration specifies values indicating the number of times an instance of a template can be created. The TemplateInstanceAttribute class uses values from the TemplateInstance enumeration. In particular, the Single and Multiple fields specify single and multiple instances of a template, respectively. A single instance of a template allows you to reference controls that are contained within the template.

Examples of controls that use the Single value in property metadata include the ZoneTemplate property of the CatalogZone control, the ZoneTemplate property of the EditorZone control, and the ZoneTemplate property of the WebPartZone.

The following code example demonstrates how to use the TemplateInstance enumeration and the TemplateInstanceAttribute class. A custom LoginView control, named MyLoginView, overrides the AnonymousTemplate property and uses the TemplateInstanceAttribute class to specify that only one instance of the AnonymousTemplate property is created.

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

namespace Samples.AspNet.CS.Controls
	public class MyLoginView : LoginView
		private ITemplate _anonymoustemplate;

		public override ITemplate AnonymousTemplate
				return _anonymoustemplate;
				_anonymoustemplate = value;

The following code example is an ASPX file that uses the MyLoginView control and demonstrates how to access a Label control that is inside the AnonymousTemplate property.

<%@ Page Language="C#" %>
<%@ Register TagPrefix="AspNetSamples" Namespace="Samples.AspNet.CS.Controls" Assembly="Samples.AspNet.CS.Controls" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  protected void Page_Load(object sender, EventArgs e)
    this.LoginViewLabel1.Text = "LoginView Anonymous Template Label Set Dynamically.";    

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>TemplateInstance Example</title>
    <form id="form1" runat="server">
      <AspNetSamples:MyLoginView id="MyLoginView1" runat="server">
          <asp:Label ID="LoginViewLabel1" runat="server" Text="Test"/>

.NET Framework
Available since 2.0
Return to top