PersonalizationState.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 for the specified Web Parts control.

public:
 abstract System::String ^ GetAuthorizationFilter(System::String ^ webPartID);

public abstract string GetAuthorizationFilter (string webPartID);

abstract member GetAuthorizationFilter : string -> string

Public MustOverride Function GetAuthorizationFilter (webPartID As String) As String

Parameters

webPartID: String

The ID of the Web Parts control from which the AuthorizationFilter is retrieved.

Returns

String

The authorization filter string for a Web Parts control.

Remarks

This method returns the AuthorizationFilter string for a WebPart control before an instance of it is created. This method should return null if there is no personalized value for the AuthorizationFilter property.

The Web Parts control set does not implement any default behavior for the AuthorizationFilter property. The property is provided so that a developer can assign an arbitrary string value to a custom WebPart control; this property can be checked by subscribing to the AuthorizeWebPart event on the WebPartManager control on a page to determine whether the control can be added to the page.

Applies to