PersonalizationState Class

Definition

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

public ref class PersonalizationState abstract
public abstract class PersonalizationState
type PersonalizationState = class
Public MustInherit Class PersonalizationState
Inheritance
PersonalizationState

Remarks

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 Implementers

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

Constructors

PersonalizationState(WebPartManager)

Initializes a new instance of the PersonalizationState class.

Properties

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

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.

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.

Applies to

See also