Class MySqlPersonalizationProvider

Implementation for Personalization Provider to use web parts in ASP.NET websites.

Inheritance

System.Object

System.Configuration.Provider.ProviderBase

System.Web.UI.WebControls.WebParts.PersonalizationProvider

MySqlPersonalizationProvider

Namespace: MySql.Web.Personalization

Assembly: MySql.Web.dll

Version: 9.3.0

Syntax

public class MySqlPersonalizationProvider : PersonalizationProvider

Properties

ApplicationName

Gets or sets the application name.

Declaration

public override string ApplicationName { get; set; }

Property Value

Type	Description
System.String

Overrides

System.Web.UI.WebControls.WebParts.PersonalizationProvider.ApplicationName

Methods

FindState(PersonalizationScope, PersonalizationStateQuery, Int32, Int32, out Int32)

Returns a collection of PersonalizationStateInfo objects containing administrative information regarding records in the database that match the specified criteria.

Declaration

public override PersonalizationStateInfoCollection FindState(PersonalizationScope scope, PersonalizationStateQuery query, int pageIndex, int pageSize, out int totalRecords)

Parameters

Type	Name	Description
System.Web.UI.WebControls.WebParts.PersonalizationScope	scope	The personalization scope.
System.Web.UI.WebControls.WebParts.PersonalizationStateQuery	query	The set of query parameters.
System.Int32	pageIndex	The index of the page.
System.Int32	pageSize	The size of the page.
System.Int32	totalRecords	The total number of records to return.

Returns

Type	Description
System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection

Overrides

System.Web.UI.WebControls.WebParts.PersonalizationProvider.FindState(System.Web.UI.WebControls.WebParts.PersonalizationScope, System.Web.UI.WebControls.WebParts.PersonalizationStateQuery, System.Int32, System.Int32, System.Int32)

Remarks

For example, records corresponding to users named Jeff* that have been modified since January 1, 2005. Wildcard support is provider-dependent.

GetCountOfState(PersonalizationScope, PersonalizationStateQuery)

Returns the number of records in the database that match the specified criteria.

Declaration

public override int GetCountOfState(PersonalizationScope scope, PersonalizationStateQuery query)

Parameters

Type	Name	Description
System.Web.UI.WebControls.WebParts.PersonalizationScope	scope	The personalization scope.
System.Web.UI.WebControls.WebParts.PersonalizationStateQuery	query	The set of query parameters.

Returns

Type	Description
System.Int32

Overrides

System.Web.UI.WebControls.WebParts.PersonalizationProvider.GetCountOfState(System.Web.UI.WebControls.WebParts.PersonalizationScope, System.Web.UI.WebControls.WebParts.PersonalizationStateQuery)

Remarks

For example, records corresponding to users named Jeff* that haven't been modified since January 1, 2005. Wildcard support is provider-dependent.

Initialize(String, NameValueCollection)

Initializes settings values for Personalization Provider.

Declaration

public override void Initialize(string name, NameValueCollection config)

Parameters

Type	Name	Description
System.String	name	The name of the provider.
System.Collections.Specialized.NameValueCollection	config	A named value collection representing the configurations for this provider.

Overrides

System.Configuration.Provider.ProviderBase.Initialize(System.String, System.Collections.Specialized.NameValueCollection)

LoadPersonalizationBlobs(WebPartManager, String, String, ref Byte[], ref Byte[])

Retrieves personalization state as opaque blobs from the data source.

Declaration

protected override void LoadPersonalizationBlobs(WebPartManager webPartManager, string path, string userName, ref byte[] sharedDataBlob, ref byte[] userDataBlob)

Parameters

Type	Name	Description
System.Web.UI.WebControls.WebParts.WebPartManager	webPartManager	The web part manager.
System.String	path	The path indicating where to save the data.
System.String	userName	The user name.
System.Byte[]	sharedDataBlob	A byte array containing the user shared data to loaded.
System.Byte[]	userDataBlob	A byte array containing the user data to be loaded.

Overrides

System.Web.UI.WebControls.WebParts.PersonalizationProvider.LoadPersonalizationBlobs(System.Web.UI.WebControls.WebParts.WebPartManager, System.String, System.String, System.Byte[], System.Byte[])

Remarks

Retrieves both shared and user personalization state corresponding to a specified user and a specified page.

ResetPersonalizationBlob(WebPartManager, String, String)

Deletes personalization state corresponding to a specified user and a specified page from the database.

Declaration

protected override void ResetPersonalizationBlob(WebPartManager webPartManager, string path, string userName)

Parameters

Type	Name	Description
System.Web.UI.WebControls.WebParts.WebPartManager	webPartManager	The web part manager.
System.String	path	The path indicating where to save the data.
System.String	userName	The user name.

Overrides

System.Web.UI.WebControls.WebParts.PersonalizationProvider.ResetPersonalizationBlob(System.Web.UI.WebControls.WebParts.WebPartManager, System.String, System.String)

ResetState(PersonalizationScope, String[], String[])

Deletes personalization state corresponding to the specified users and specified pages from the database.

Declaration

public override int ResetState(PersonalizationScope scope, string[] paths, string[] usernames)

Parameters

Type	Name	Description
System.Web.UI.WebControls.WebParts.PersonalizationScope	scope	The personalization scope.
System.String[]	paths	The paths indicating where to save the data.
System.String[]	usernames	The user names.

Returns

Type	Description
System.Int32

Overrides

System.Web.UI.WebControls.WebParts.PersonalizationProvider.ResetState(System.Web.UI.WebControls.WebParts.PersonalizationScope, System.String[], System.String[])

ResetUserState(String, DateTime)

Deletes user personalization state corresponding to the specified pages and that hasn't been updated since a specified date from the database.

Declaration

public override int ResetUserState(string path, DateTime userInactiveSinceDate)

Parameters

Type	Name	Description
System.String	path	The path indicating where to retrieve the user state from.
System.DateTime	userInactiveSinceDate	A time and date indicating since when the user has been inactive.

Returns

Type	Description
System.Int32

Overrides

System.Web.UI.WebControls.WebParts.PersonalizationProvider.ResetUserState(System.String, System.DateTime)

SavePersonalizationBlob(WebPartManager, String, String, Byte[])

Writes personalization state corresponding to a specified user and a specified page as an opaque blob to the database.

Declaration

protected override void SavePersonalizationBlob(WebPartManager webPartManager, string path, string userName, byte[] dataBlob)

Parameters

Type	Name	Description
System.Web.UI.WebControls.WebParts.WebPartManager	webPartManager	The web part manager.
System.String	path	The path indicating where to save the data.
System.String	userName	The user name.
System.Byte[]	dataBlob	A byte array containing the data to be saved.

Overrides

System.Web.UI.WebControls.WebParts.PersonalizationProvider.SavePersonalizationBlob(System.Web.UI.WebControls.WebParts.WebPartManager, System.String, System.String, System.Byte[])

Remarks

If userName is null, then the personalization state is shared state and is not keyed by user name.