PersonalizationState Class

.NET Framework (current version)

Other Versions

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

Namespace: System.Web.UI.WebControls.WebParts
Assembly: System.Web (in System.Web.dll)

Inheritance Hierarchy

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

Syntax

C++

public ref class PersonalizationState abstract

Constructors

	Name	Description
	PersonalizationState(WebPartManager^)	Initializes a new instance of the PersonalizationState class.

Properties

	Name	Description
	IsDirty	Gets a value that indicates whether any personalization information has changed.
	IsEmpty	When overridden, gets a value that indicates whether any personalization state was extracted by a state instance.
	WebPartManager	Gets a reference to the WebPartManager control currently associated with the personalization state instance.

Methods

	Name	Description
	ApplyWebPartManagerPersonalization()	When overridden, applies personalization data to the WebPartManager control associated with the personalization state instance.
	ApplyWebPartPersonalization(WebPart^)	When overridden, applies personalization data to the specified Web Parts control.
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	ExtractWebPartManagerPersonalization()	When overridden, extracts personalization information from the WebPartManager control associated with the current personalization state.
	ExtractWebPartPersonalization(WebPart^)	When overridden, extracts personalization data from the specified Web Parts control.
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetAuthorizationFilter(String^)	Retrieves the authorization filter for the specified Web Parts control.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	SetDirty()	Marks the current personalization state as having changed.
	SetWebPartDirty(WebPart^)	When overridden, marks a Web Parts control as having changed.
	SetWebPartManagerDirty()	When overridden, marks the associated WebPartManager control as having changed.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	ValidateWebPart(WebPart^)	Verifies that the specified Web Parts control is valid.

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.

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.