TemplateInstanceAttribute クラス

リファレンス

定義

名前空間:: System.Web.UI

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

テンプレートの許可されるインスタンス数を指定するために使用されるメタデータ属性を定義します。このクラスは継承できません。

public ref class TemplateInstanceAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class TemplateInstanceAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type TemplateInstanceAttribute = class
    inherit Attribute

Public NotInheritable Class TemplateInstanceAttribute
Inherits Attribute

継承: Object

Attribute
TemplateInstanceAttribute

属性: AttributeUsageAttribute

例

次のコード例では、列挙型とクラスを使用する TemplateInstance 方法を TemplateInstanceAttribute 示します。という名前のカスタム LoginView コントロールは、プロパティをAnonymousTemplateオーバーライドし、クラスをTemplateInstanceAttribute使用して、プロパティのAnonymousTemplateインスタンスを 1 つだけ作成するように指定MyLoginViewAします。

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 MyLoginViewA : LoginView
    {
        private ITemplate _anonymoustemplate;

        [Browsable(false),
        DefaultValue(null),
        PersistenceMode(PersistenceMode.InnerProperty),
        TemplateContainer(typeof(LoginView)),
        TemplateInstance(TemplateInstance.Single)
        ]
        public override ITemplate AnonymousTemplate
        {
            get
            {
                return _anonymoustemplate;
            }
            set
            {
                _anonymoustemplate = value;
            }
        }
    }
}

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

次のコード例は、コントロールを使用し、クラスのMyLoginViewATemplateInstanceAttributeプロパティにアクセスする方法を示す ASPX ファイルです。

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Reflection" %>
<%@ 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">
   
  // <Snippet3> 
  protected void Page_Load(object sender, EventArgs e)
  {
        
    // Get the class type for which to access metadata.
    Type clsType = typeof(MyLoginViewA);
    // Get the PropertyInfo object for FirstTemplate.
    PropertyInfo pInfo = clsType.GetProperty("AnonymousTemplate");
    // See if the TemplateInstanceAttribute is defined for this property.
    bool isDef = Attribute.IsDefined(pInfo, typeof(TemplateInstanceAttribute));

    // Display the result if the attribute exists.
    if (isDef)
    {
      TemplateInstanceAttribute tia =
        (TemplateInstanceAttribute)Attribute.GetCustomAttribute(pInfo, typeof(TemplateInstanceAttribute));
      Response.Write("The <AnonymousTemplate> has the TemplateInstanceAttribute = " + tia.Instances.ToString() + ".<br />");
      if (tia.IsDefaultAttribute())
        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.");
    }

  }
  // </Snippet3> 

</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>

<%@ 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">

  ' <Snippet3>
  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
  ' </Snippet3>
  
</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>

注釈

TemplateInstanceAttributeクラスを使用すると、テンプレートプロパティを 1 つまたは複数のインスタンス化を許可する 1 つとしてマークできます。 1 つのインスタンス化のみを許可するテンプレートでは、その内部に含まれるコントロールを参照できます。プロパティは ZoneTemplate 、1 回だけインスタンス化できるプロパティの例です。

この TemplateInstanceAttribute クラスは省略可能です。テンプレートプロパティがクラスで TemplateInstanceAttribute 拡張されていない場合は、既定値の Multiple フィールドが使用されます。属性の使用の詳細については、「属性」を参照してください。

コンストラクター

TemplateInstanceAttribute(TemplateInstance)

TemplateInstanceAttribute 列挙値を指定して、TemplateInstance クラスの新しいインスタンスを初期化します。

フィールド

Default	TemplateInstanceAttribute クラスの既定値を定義します。このフィールドは読み取り専用です。
Multiple	複数回インスタンス生成されるテンプレートを表す属性として TemplateInstanceAttribute クラスのインスタンスを作成します。このフィールドは読み取り専用です。
Single	1 回だけインスタンス生成されるテンプレートを表す属性として TemplateInstanceAttribute クラスのインスタンスを作成します。このフィールドは読み取り専用です。

プロパティ

Instances	現在のテンプレートインスタンスが表す TemplateInstance 列挙値を取得します。
TypeId	派生クラスで実装されると、この Attribute の一意の識別子を取得します。 (継承元 Attribute)

メソッド

Equals(Object)	指定されたオブジェクトが TemplateInstanceAttribute オブジェクトかどうか、およびこの TemplateInstanceAttribute オブジェクトと同一かどうかを示します。
GetHashCode()	この TemplateInstanceAttribute オブジェクトのハッシュコードを取得します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
IsDefaultAttribute()	現在の TemplateInstanceAttribute オブジェクトが既定のTemplateInstanceAttribute オブジェクトと同じかどうかを示す値を返します。
Match(Object)	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (継承元 Attribute)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

明示的なインターフェイスの実装

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	一連の名前を対応する一連のディスパッチ識別子に割り当てます。 (継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。 (継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)	オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。 (継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。 (継承元 Attribute)

適用対象