This documentation is archived and is not being maintained.

WebPartAuthorizationEventArgs Class

Provides data for the AuthorizeWebPart event.


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

public class WebPartAuthorizationEventArgs : EventArgs

The WebPartAuthorizationEventArgs type exposes the following members.

Public methodWebPartAuthorizationEventArgsInitializes a new instance of the WebPartAuthorizationEventArgs class.

Public propertyAuthorizationFilterGets the string value assigned to the AuthorizationFilter property of a WebPart control, used for authorizing whether a control can be added to a page.
Public propertyIsAuthorizedGets or sets the value indicating whether a Web Parts control can be added to a page.
Public propertyIsSharedGets a value that indicates whether a Web Parts control is visible to all users of a Web Parts page.
Public propertyPathGets the relative application path to the source file for the control being authorized, if the control is a user control.
Public propertyTypeGets the Type of the Web Parts control being checked for authorization.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The AuthorizeWebPart event occurs before a WebPart control is added to a page. There are a number of common scenarios where a control can be added to a page. For a full description of these, see the Remarks section for the WebPartManager.IsAuthorized method.

The WebPartAuthorizationEventArgs class provides access to properties about the Web Parts control being added to the page. When a control is added, it must be checked to see whether its AuthorizationFilter property has been set and, if so, whether the control is authorized to be added to the page.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.