PersonalizableAttribute クラス

定義

パーソナル化属性を表します。 このクラスは継承できません。

public ref class PersonalizableAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class PersonalizableAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Property)>]
type PersonalizableAttribute = class
    inherit Attribute
Public NotInheritable Class PersonalizableAttribute
Inherits Attribute
継承
PersonalizableAttribute
属性

次のコード例は、コードで PersonalizableAttribute クラスを使用する方法を示しています。 このサンプルは、 ColorSelector.ascxと呼ばれる Web パーツ ユーザー コントロールを参照する.aspx ページで構成されています。 次のコードは、この例の.aspx ファイルです。

<%@ Page Language="C#"  %>
<%@ Register TagPrefix="uc1" TagName="colorcontrol" Src="ColorSelector.ascx" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
       
<body>
    <form id="form1" runat="server">
      <div>
         <asp:LoginName ID="LoginName1" runat="server" />
         
        <asp:LoginStatus ID="LoginStatus1" runat="server" LogoutAction="RedirectToLoginPage" />
            <br />
        <br />
         <asp:WebPartManager ID="WebPartManager1" runat="server">
        </asp:WebPartManager>
    
    </div>
        <asp:WebPartZone ID="WebPartZone1" runat="server"  Height="200" Width="200">
        <ZoneTemplate>
        <uc1:colorcontrol id="colorcontrol" runat="server" />
        </ZoneTemplate>
        </asp:WebPartZone>        
    </form>
</body>
</html>

次のコードは、 ColorSelector.ascx コントロール用です。

Important

この例には、潜在的なセキュリティ上の脅威であるユーザー入力を受け入れるテキスト ボックスがあります。 既定では、ASP.NET Web ページでは、ユーザー入力にスクリプトや HTML 要素が含まれていないことが検証されます。 詳細については、「スクリプトの 悪用の概要」を参照してください。

<%@ Control Language="C#" %>

<script runat="server">
private System.Drawing.Color userchoice;

[Personalizable]
public System.Drawing.Color UserColorChoice
{
   get
   {
     return userchoice;
   }
   set
   {
     userchoice = value;
   }
}

protected void OnRed(object src, EventArgs e)
{
  _color.BackColor = System.Drawing.Color.Red;
  UserColorChoice = System.Drawing.Color.Red;
}

protected void OnGreen(object src, EventArgs e)
{
  _color.BackColor = System.Drawing.Color.Green;
  UserColorChoice = System.Drawing.Color.Green;
}

protected void OnBlue(object src, EventArgs e)
{
  _color.BackColor = System.Drawing.Color.Blue;
  UserColorChoice = System.Drawing.Color.Blue;
}

protected void Page_Init(object src, EventArgs e)
{
  _redButton.Click   += new EventHandler(OnRed);  
  _greenButton.Click += new EventHandler(OnGreen);  
  _blueButton.Click  += new EventHandler(OnBlue);  
}

protected void Page_Load(object src, EventArgs e)
{
  if (!IsPostBack)
  {
          _color.BackColor = UserColorChoice;
  }
}

</script>
<body>
    <div>
        <asp:TextBox ID="_color" runat="server" Height="100" Width="100" />
        <br />
        <asp:button runat="server"  id="_redButton" text="Red"  /> 
          
        <asp:button runat="server"  id="_greenButton" text="Green" />
          
        <asp:button runat="server" id="_blueButton" text="Blue" />
    </div>
</body>

注釈

パーソナル化属性 Personalizableは、パーソナル化情報を保持する必要があるパブリック コントロール プロパティに適用されます。 ASP.NET は、コントロールが Web パーツ ページの Web パーツ ゾーンにある場合に、基になるデータ ストアからこれらの値を永続化または取得するコードを自動的に生成します。

プロパティをカスタマイズ可能としてマークするには、次の要件を満たす必要があります。

  • プロパティは public でなければならず、public get アクセサーと set アクセサーが必要です。

  • プロパティは、読み取り/書き込みプロパティである必要があります。

  • プロパティにはパラメーターを指定しない必要があります。

  • プロパティにインデックスを作成できません。

プロパティのパーソナル化データを読み込んで保存するコードが自動的に生成されます。 パーソナル化をサポートするプロパティは、プロパティにこの属性が存在し、プロパティが上記の制約に準拠しているという事実に基づいて決定されます。

パーソナル化では、読み取り専用プロパティと書き込み専用プロパティはサポートされないことに注意してください。 この属性を読み取り専用または書き込み専用のプロパティに適用すると、 HttpException がスローされます。 パラメーター化されたプロパティは、 HttpException 例外もスローします。

この属性を持たない個々のプロパティは、 IPersonalizable インターフェイスによる特別な処理が使用されない場合、パーソナル化から除外されます。

属性の使用の詳細については、「 Web パーツのパーソナル化の概要」を参照してください。

コンストラクター

名前 説明
PersonalizableAttribute()

PersonalizableAttribute クラスの新しいインスタンスを初期化します。

PersonalizableAttribute(Boolean)

指定されたパラメーターを使用して、 PersonalizableAttribute クラスの新しいインスタンスを初期化します。

PersonalizableAttribute(PersonalizationScope, Boolean)

指定されたパラメーターを使用して、 PersonalizableAttribute クラスの新しいインスタンスを初期化します。

PersonalizableAttribute(PersonalizationScope)

指定されたパラメーターを使用して、 PersonalizableAttribute クラスの新しいインスタンスを初期化します。

フィールド

名前 説明
Default

パーソナル化がサポートされていないことを示す属性インスタンスを返します。 このフィールドは読み取り専用です。

NotPersonalizable

パーソナル化がサポートされていないことを示す属性インスタンスを返します。 このフィールドは読み取り専用です。

Personalizable

パーソナル化のサポートを示す属性インスタンスを返します。 このフィールドは読み取り専用です。

SharedPersonalizable

共有スコープでのパーソナル化のサポートを示す属性インスタンスを返します。 このフィールドは読み取り専用です。

UserPersonalizable

スコープでのパーソナル化のサポートを示す属性インスタンス User 返します。 このフィールドは読み取り専用です。

プロパティ

名前 説明
IsPersonalizable

コンストラクターの 1 つによって確立された属性をカスタマイズできるかどうかを示す設定を取得します。

IsSensitive

いずれかのコンストラクターによって確立された属性が機密性の高いかどうかを示す設定を取得します。

Scope

コンストラクターの 1 つによって設定された、クラス インスタンスの PersonalizationScope 列挙値を取得します。

TypeId

派生クラスで実装されている場合は、この Attributeの一意の識別子を取得します。

(継承元 Attribute)

メソッド

名前 説明
Equals(Object)

オーバーライドされると、 PersonalizableAttribute の現在のインスタンスと、パラメーターとして指定された別の PersonalizableAttribute インスタンスのブール評価を返します。

GetHashCode()

オーバーライドされると、属性のハッシュ コードを返します。

GetPersonalizableProperties(Type)

パラメーターの型に一致し、カスタマイズ可能としてマークされているプロパティの PropertyInfo オブジェクトのコレクションを返します。

GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
IsDefaultAttribute()

オーバーライドされた場合、属性インスタンスが静的 Default フィールドの値と等しいかどうかを示す値を返します。

Match(Object)

PersonalizableAttributeの現在のインスタンスと指定したPersonalizableAttributeが同じIsPersonalizableプロパティ値を持っているかどうかを示す値を返します。

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)

適用対象