PersonalizableAttribute クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

PersonalizableAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Property)> _
Public NotInheritable Class
 PersonalizableAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As PersonalizableAttribute

[AttributeUsageAttribute(AttributeTargets.Property)] 
public sealed class PersonalizableAttribute
 : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Property)] 
public ref class PersonalizableAttribute sealed
 : public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ 
public final class PersonalizableAttribute
 extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Property) 
public final class PersonalizableAttribute
 extends Attribute

解説

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

プロパティをパーソナル化可能とマークするには、次の要件を満たしている必要があります。

プロパティがパブリックであり、プロパティにパブリックの get アクセサと set アクセサが存在する必要があります。
プロパティが読み取り/書き込みプロパティである必要があります。
プロパティがパラメータを持たないプロパティである必要があります。
プロパティにインデックスを付けることはできません。

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

読み取り専用プロパティおよび書き込み専用プロパティのパーソナル化は、サポートされていません。読み取り専用プロパティまたは書き込み専用プロパティにこの属性を適用すると、HttpException がスローされます。パラメータ付きのプロパティの場合も、HttpException 例外がスローされます。

この属性を持たない個々のプロパティは、IPersonalizable インターフェイスを通じて特別な処理を行わなければ、パーソナル化から除外されます。

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

使用例

コードで 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  >
<head runat="server">
    <title>Untitled Page</title>
</head>
       
<body>
    <form id="form1" runat="server">
      <div>
        &nbsp;<asp:LoginName ID="LoginName1" runat="server"
 />
        &nbsp;
        <asp:LoginStatus ID="LoginStatus1" runat="server"
 LogoutAction="RedirectToLoginPage" />
        &nbsp;&nbsp;&nbsp;&nbsp;<br />
        <br />
        &nbsp;<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 コントロールの例です。

<%@ 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>
    
    <asp:TextBox ID=_color runat=server Height=100 Width=100 />
    <p>
    <asp:button runat=server  id=_redButton text="Red"  /> 
    &nbsp;&nbsp;
    <asp:button runat=server  id=_greenButton text="Green" />
    &nbsp;&nbsp;
    <asp:button runat=server id=_blueButton text="Blue" />
    
</body>