This documentation is archived and is not being maintained.

WebPartManager.AuthorizeWebPart Event

Occurs when the IsAuthorized method is called to determine whether a WebPart or server control can be added to a page.

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

Public Event AuthorizeWebPart As WebPartAuthorizationEventHandler
<asp:WebPartManager OnAuthorizeWebPart="WebPartAuthorizationEventHandler" />

The AuthorizeWebPart event occurs whenever a WebPart control is being 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 IsAuthorized method. 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.

Developers can create event handlers for the AuthorizeWebPart event, to provide filtering for controls. If a control's AuthorizationFilter property value does not meet the criteria in the event handler code, the control is not added to the page.

The following code example demonstrates how to set a custom event handler for the AuthorizeWebPart event, which automatically overrides the default OnAuthorizeWebPart method.

The code in the mgr1_AuthorizeWebPart method checks whether the controls on the page have their respective AuthorizationFilter property values set to user and, if so, returns true, which means that they will be authorized and added to the page. This assumes the default approach is to allow users to view controls with a page in user personalization scope. Notice, however, that in the example one of the controls has its AuthorizationFilter property value set to admin. Developers might place this filter on a specialized control that was designed for only administrative users to see. This control will fail the authorization check during the AuthorizeWebPart event, and will not be displayed. Note that controls that do not have the property set are displayed as well; they are assumed not to be part of a filtering scenario because their AuthorizationFilter properties are not set.

<%@ Page Language="vb" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">

  Protected Sub mgr1_AuthorizeWebPart(ByVal sender As Object, _
    ByVal e As WebPartAuthorizationEventArgs)

    If Not String.IsNullOrEmpty(e.AuthorizationFilter) Then
      If e.AuthorizationFilter = "user" Then
        e.IsAuthorized = True
        e.IsAuthorized = False
      End If
    End If

  End Sub

<html xmlns="" >
<head runat="server">
    <title>Untitled Page</title>
    <form id="form1" runat="server">
      <asp:WebPartManager ID="mgr1" runat="server" 
        OnAuthorizeWebPart="mgr1_AuthorizeWebPart" />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
            Title="Favorite Links"
            <asp:ListItem Value="">
            <asp:ListItem Value="">
            <asp:ListItem Value="">
          <asp:Label ID="Label1" runat="server" 
            Text="Hello World"
            Title="Filter Test"
            AuthorizationFilter="admin" />
          <asp:Calendar ID="Calendar1" runat="server" 
            Title="My Calendar"/>

.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.