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
public abstract String GetAuthorizationFilter (
	String webPartID
)
public abstract function GetAuthorizationFilter (
	webPartID : String
) : String
Not applicable.

Parameters

webPartID

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

Return Value

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 a null reference (Nothing in Visual Basic) 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 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: