WebPartPersonalization.GetAuthorizationFilter(String) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieves the authorization filter, if any, associated with the specified Web Parts control.

protected public:
 virtual System::String ^ GetAuthorizationFilter(System::String ^ webPartID);

protected internal virtual string GetAuthorizationFilter (string webPartID);

abstract member GetAuthorizationFilter : string -> string
override this.GetAuthorizationFilter : string -> string

Protected Friend Overridable Function GetAuthorizationFilter (webPartID As String) As String

Parameters

webPartID: String

The ID of the Web Parts control associated with the filter to be retrieved.

Returns

String

The authorization filter for the specified Web Parts control.

Exceptions

InvalidOperationException

An attempt was made to retrieve an authorization filter when IsEnabled is false by calling this method too early in the page life cycle.

-or-

An attempt was made to retrieve an authorization filter and no personalization state has been loaded.

-or

The personalization state returned from the data store was null.

ArgumentException

webPartID is null or an empty string ("").

Remarks

This method retrieves the authorization filter, if any, associated with the Web Parts control identified by webPartID. Each Web Parts control that is serialized and managed by personalization is associated with a webPartID parameter. At run time, a page's WebPartManager control can filter the controls displayed on a page by determining whether each Web Parts control is authorized. This authorization information is stored as a string in the data associated with each Web Parts control.

Applies to