Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

PersonalizableAttribute Class

.NET Framework 4

Represents the personalization attribute. This class cannot be inherited.

System.Object
  System.Attribute
    System.Web.UI.WebControls.WebParts.PersonalizableAttribute

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)
C#
C++
F#
VB
Copy 
[AttributeUsageAttribute(AttributeTargets.Property)]
public sealed class PersonalizableAttribute : Attribute

The PersonalizableAttribute type exposes the following members.

  Name Description
Public method PersonalizableAttribute() Initializes a new instance of the PersonalizableAttribute class.
Public method PersonalizableAttribute(Boolean) Initializes a new instance of the PersonalizableAttribute class using the provided parameter.
Public method PersonalizableAttribute(PersonalizationScope) Initializes a new instance of the PersonalizableAttribute class using the provided parameter.
Public method PersonalizableAttribute(PersonalizationScope, Boolean) Initializes a new instance of the PersonalizableAttribute class using the provided parameters.
Top
  Name Description
Public property IsPersonalizable Gets the setting that indicates whether the attribute can be personalized, as established by one of the constructors.
Public property IsSensitive Gets the setting that indicates whether the attribute is sensitive, as established by one of the constructors.
Public property Scope Gets the PersonalizationScope enumeration value for the class instance, as set by one of the constructors.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
  Name Description
Public method Equals When overridden, returns a Boolean evaluation of the current instance of PersonalizableAttribute and another PersonalizableAttribute instance supplied as a parameter. (Overrides Attribute.Equals(Object).)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode When overridden, returns a hash code of the attribute. (Overrides Attribute.GetHashCode().)
Public method Static member GetPersonalizableProperties Returns a collection of PropertyInfo objects for the properties that match the parameter type and are marked as personalizable.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When overridden, returns a value that indicates whether the attribute instance equals the value of the static Default field. (Overrides Attribute.IsDefaultAttribute().)
Public method Match Returns a value that indicates whether the current instance of PersonalizableAttribute and the specified PersonalizableAttribute have the same IsPersonalizable property value. (Overrides Attribute.Match(Object).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public field Static member Default Returns an attribute instance that indicates no support for personalization. This field is read-only.
Public field Static member NotPersonalizable Returns an attribute instance that indicates no support for personalization. This field is read-only.
Public field Static member Personalizable Returns an attribute instance that indicates support for personalization. This field is read-only.
Public field Static member SharedPersonalizable Returns an attribute instance that indicates support for personalization with a shared scope. This field is read-only.
Public field Static member UserPersonalizable Returns an attribute instance that indicates support for personalization in User scope. This field is read-only.
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Exception Condition
HttpException

The property is a read-only or write-only public property.

- or -

The property is a private or protected read/write property.

- or -

The property has index parameters.

The personalization attribute, Personalizable, is applied to public control properties that need to persist personalization information. ASP.NET automatically generates the code to persist or retrieve these values from the underlying data store when the control is in a Web Parts zone on a Web Parts page.

The following requirements must be met for a property to be marked as personalizable:

  • The property must be public and must have public get and set accessors.

  • The property must be a read/write property.

  • The property must be without parameters.

  • The property cannot be indexed.

Code is automatically generated to load and save personalization data for properties. Properties that support personalization are determined based on the existence of this attribute on the property and the fact that the property conforms to the constraints listed above.

Note that read-only and write-only properties are not supported for personalization. Applying this attribute to a read-only or write-only property results in an HttpException being thrown. Parameterized properties also throw an HttpException exception.

Individual properties without this attribute are excluded from personalization if no special handling through the IPersonalizable interface is used.

For more information about using attributes, see Web Parts Personalization Overview.

The following code example demonstrates how to use the PersonalizableAttribute class in code. The sample consists of an .aspx page that references a Web Part user control called ColorSelector.ascx. The following code is the .aspx file for the example.

C#
Copy 

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

The following code is for the ColorSelector.ascx control.

Security note Security Note

This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.
C#
Copy 

<%@ 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"  /> 
        &nbsp;&nbsp;
        <asp:button runat="server"  id="_greenButton" text="Green" />
        &nbsp;&nbsp;
        <asp:button runat="server" id="_blueButton" text="Blue" />
    </div>
</body>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ