TemplateInstanceAttribute Class
Defines a metadata attribute that is used to specify the number of allowed instances of a template. This class cannot be inherited.
Assembly: System.Web (in System.Web.dll)
The TemplateInstanceAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | TemplateInstanceAttribute | Initializes a new instance of the TemplateInstanceAttribute class with the specified TemplateInstance enumeration value. |
| Name | Description | |
|---|---|---|
![]() | Equals | Indicates whether the specified object is a TemplateInstanceAttribute object and is identical to the this TemplateInstanceAttribute object. (Overrides Attribute.Equals(Object).) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Gets a hash code for this TemplateInstanceAttribute object. (Overrides Attribute.GetHashCode.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IsDefaultAttribute | Returns a value indicating if the current TemplateInstanceAttribute object is the same as the default TemplateInstanceAttribute object. (Overrides Attribute.IsDefaultAttribute.) |
![]() | Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | Default | Defines the default value for the TemplateInstanceAttribute class. This field is read-only. |
![]() ![]() | Multiple | Creates an instance of the TemplateInstanceAttribute class as one representing a template that will be instantiated multiple times. This field is read-only. |
![]() ![]() | Single | Creates an instance of the TemplateInstanceAttribute class as one representing a template that will be instantiated a single time. This field is read-only. |
| Name | Description | |
|---|---|---|
![]() ![]() | _Attribute.GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
![]() ![]() | _Attribute.GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
![]() ![]() | _Attribute.GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
![]() ![]() | _Attribute.Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
The TemplateInstanceAttribute class allows you to mark a template property as one that allows single or multiple instantiations. A template that only allows a single instantiation can have the controls that are contained inside of it referenced. The ZoneTemplate property is an example of a property that can be instantiated only one time.
This TemplateInstanceAttribute class is optional. If a template property is not extended with a TemplateInstanceAttribute class, the default value, the Multiple field, is used. For more information about using attributes, see Extending Metadata Using Attributes.
The following code example demonstrates how to use the TemplateInstance enumeration and the TemplateInstanceAttribute class. A custom LoginView control named MyLoginViewA overrides the AnonymousTemplate property and uses the TemplateInstanceAttribute class to specify that only one instance of the AnonymousTemplate property is created.
Imports Microsoft.VisualBasic Imports System Imports System.Data Imports System.ComponentModel Imports System.Web Imports System.Web.UI Imports System.Web.UI.WebControls Namespace Samples.AspNet.VB.Controls Public Class MyLoginViewA Inherits LoginView Private _anonymoustemplate As ITemplate <Browsable(False), DefaultValue(""), PersistenceMode(PersistenceMode.InnerProperty), TemplateContainer(GetType(LoginView)), TemplateInstance(TemplateInstance.Single)> _ Public Overrides Property AnonymousTemplate() As System.Web.UI.ITemplate Get Return _anonymoustemplate End Get Set(ByVal value As System.Web.UI.ITemplate) _anonymoustemplate = value End Set End Property End Class End Namespace
The following code example is an ASPX file that uses the MyLoginViewA control and demonstrates how to access properties of the TemplateInstanceAttribute class.
<%@ Page Language="VB" %> <%@ Import Namespace="System.Reflection" %> <%@ Register TagPrefix="AspNetSamples" Namespace="Samples.AspNet.VB.Controls" Assembly="Samples.AspNet.VB.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 Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) ' Get the class type for which to access metadata. Dim clsType As Type = GetType(MyLoginViewA) ' Get the PropertyInfo object for FirstTemplate. Dim pInfo As PropertyInfo = clsType.GetProperty("AnonymousTemplate") ' See if the TemplateInstanceAttribute is defined for this property. Dim isDef As Boolean = Attribute.IsDefined(pInfo, GetType(TemplateContainerAttribute)) ' Display the result if the attribute exists. If isDef Then Dim tia As TemplateInstanceAttribute = CType(Attribute.GetCustomAttribute(pInfo, GetType(TemplateInstanceAttribute)), TemplateInstanceAttribute) Response.Write("The <AnonymousTemplate> has the TemplateInstanceAttribute = " & tia.Instances.ToString() & ".<br />") If (tia.IsDefaultAttribute()) Then Response.Write("The TemplateInstanceAttribute used is the same as the default instance.") Else Response.Write("The TemplateInstanceAttribute used is not the same as the default instance.") End If End If End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>TemplateInstance Example</title> </head> <body> <form id="form1" runat="server"> <div> <AspNetSamples:MyLoginViewA id="MyLoginViewA1" runat="server"> <AnonymousTemplate> <asp:Label ID="LoginViewLabel1" runat="server" Text="LoginView Anonymous Template Text"/> </AnonymousTemplate> </AspNetSamples:MyLoginViewA> </div> </form> </body> </html>
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
