This documentation is archived and is not being maintained.

PersonalizationState::GetAuthorizationFilter Method

Retrieves the authorization filter for the specified Web Parts control.

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

public:
virtual String^ GetAuthorizationFilter(
	String^ webPartID
) abstract

Parameters

webPartID
Type: System::String

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

Return Value

Type: System::String
The authorization filter string for a Web Parts control.

This method returns the AuthorizationFilter string for a WebPart control before an instance of it is created. This method should return nullptr 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.

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

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: