Export (0) Print
Expand All

PersonalizationProvider Class

Note: This class is new in the .NET Framework version 2.0.

Implements the basic functionality for a personalization provider.

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

public abstract class PersonalizationProvider : ProviderBase
public abstract class PersonalizationProvider extends ProviderBase
public abstract class PersonalizationProvider extends ProviderBase

This is the abstract base class that defines the required functionality of a personalization provider. A personalization provider both loads and stores personalization data on behalf of a WebPartPersonalization instance.

The base class defines standard behavior for a number of methods; only those methods that specifically deal with the underlying data store are marked abstract. This allows a developer to write a custom provider to interact with a specific data store, without needing to re-implement standard functionality used by the WebPartPersonalization class.

Notes to Inheritors You can derive from PersonalizationProvider and provide implementations for only the abstract methods defined in this class. The abstract methods deal specifically with saving and loading data to a physical data store, and with data store administration. A custom provider must be capable of manipulating personalization information in a manner that distinguishes Shared data from User data. Furthermore, a provider must segment personalization data by page as well as by application. Implementations of PersonalizationProvider are tightly coupled to implementations of PersonalizationState because some personalization provider methods return instances of PersonalizationState-derived classes. To ease development of custom providers, the PersonalizationProvider base class includes a default implementation of the personalization logic and serialization/deserialization logic that is used directly by the WebPartPersonalization class. As a result, authoring a custom provider solely for the purpose of working with a different data store only requires implementation of the following abstract methods:

  • GetCountOfState - This method needs to be able to count the number of rows of personalization data in the database for the supplied query parameters.

  • LoadPersonalizationBlobs - Given the path and user name, this method loads two BLOBs from the database: one BLOB for shared data and one for user data. If you supply the user name and path, then you do not need the WebPartManager control to access the page information that can provide the user name/path information.

  • ResetPersonalizationBlob - Given the path and user name, this method deletes the corresponding row in the database. If you supply the user name and path, then you do not need the WebPartManager control to access the page information that can provide the user name/path information.

  • SavePersonalizationBlob - Given the path and user name, this method saves the supplied BLOB to the database. If you supply the user name and path, then you do not need the WebPartManager control to access the page information that can provide the user name/path information.

In all of these methods, if only a path is supplied, that indicates the shared personalization data for the page is being operated upon. If both a path and a username are passed to a method, then the user personalization data for the page should be acted upon. In the case of LoadPersonalizationBlobs, the shared data for the specified path should always be loaded, and optionally the user personalization data for the path should also be loaded if the username is not a null reference (Nothing in Visual Basic). All other abstract methods are intended for use only in administrative applications and are not used by the Web Parts infrastructure at run time. For an example of an implementation of a personalization provider, see the SqlPersonalizationProvider class.

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

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft