Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

PersonalizationState Class

Defines the basic functionality that represents the personalization data for a page.

System.Object
  System.Web.UI.WebControls.WebParts.PersonalizationState

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)
public abstract class PersonalizationState

The PersonalizationState type exposes the following members.

  NameDescription
Protected methodPersonalizationStateInitializes a new instance of the PersonalizationState class.
Top
  NameDescription
Public propertyIsDirtyGets a value that indicates whether any personalization information has changed.
Public propertyIsEmptyWhen overridden, gets a value that indicates whether any personalization state was extracted by a state instance.
Public propertyWebPartManagerGets a reference to the WebPartManager control currently associated with the personalization state instance.
Top
  NameDescription
Public methodApplyWebPartManagerPersonalizationWhen overridden, applies personalization data to the WebPartManager control associated with the personalization state instance.
Public methodApplyWebPartPersonalizationWhen overridden, applies personalization data to the specified Web Parts control.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExtractWebPartManagerPersonalizationWhen overridden, extracts personalization information from the WebPartManager control associated with the current personalization state.
Public methodExtractWebPartPersonalizationWhen overridden, extracts personalization data from the specified Web Parts control.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAuthorizationFilterRetrieves the authorization filter for the specified Web Parts control.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSetDirtyMarks the current personalization state as having changed.
Public methodSetWebPartDirtyWhen overridden, marks a Web Parts control as having changed.
Public methodSetWebPartManagerDirtyWhen overridden, marks the associated WebPartManager control as having changed.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodValidateWebPartVerifies that the specified Web Parts control is valid.
Top

Classes that derive from this base class contain the actual implementation for managing, applying, and extracting personalization data. The WebPartPersonalization class makes use of personalization state with a reference to PersonalizationState.

If a developer writes a custom PersonalizationState implementation, a custom PersonalizationProvider must also be written. PersonalizationProvider instances are responsible for creating and consuming PersonalizationState instances.

Notes to Inheritors

Derived classes should always call the base class constructor from the derived constructor.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.