WebPartManager.AuthorizeWebPart イベント

.NET Framework クラス ライブラリ リファレンス

WebPartManager.AuthorizeWebPart イベント

メモ : このイベントは、.NET Framework version 2.0 で新しく追加されたものです。

IsAuthorized メソッドを呼び出すと発生し、WebPart コントロールまたはサーバー コントロールをページに追加できるかどうかを判断します。

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Event AuthorizeWebPart As
 WebPartAuthorizationEventHandler

Visual Basic (使用法)

Dim instance As WebPartManager
Dim handler As WebPartAuthorizationEventHandler

AddHandler instance.AuthorizeWebPart, handler

C#

public event WebPartAuthorizationEventHandler AuthorizeWebPart

C++

public:
event WebPartAuthorizationEventHandler^ AuthorizeWebPart {
    void add (WebPartAuthorizationEventHandler^ value);
    void remove (WebPartAuthorizationEventHandler^ value);
}

J#

/** @event */
public void add_AuthorizeWebPart (WebPartAuthorizationEventHandler
 value)

/** @event */
public void remove_AuthorizeWebPart (WebPartAuthorizationEventHandler
 value)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

AuthorizeWebPart イベントは、WebPart コントロールがページに追加されるたびに発生します。コントロールをページに追加する場合、一般的なシナリオが多数存在します。これらのシナリオの詳細については、IsAuthorized メソッドの「解説」を参照してください。コントロールを追加する場合、その AuthorizationFilter プロパティが設定されているかどうか、設定されているときはページへのコントロールの追加が承認されているかどうかを確認する必要があります。

開発者は、AuthorizeWebPart イベントのイベント ハンドラを作成して、コントロールのフィルタ処理を提供できます。コントロールの AuthorizationFilter プロパティ値がイベント ハンドラ コードの条件を満たさない場合、そのコントロールはページに追加されません。

使用例

AuthorizeWebPart イベントのカスタム イベント ハンドラを設定し、既定の OnAuthorizeWebPart メソッドを自動的にオーバーライドする方法を次のコード例に示します。

mgr1_AuthorizeWebPart メソッドのコードは、ページ上のコントロールが user に設定された AuthorizationFilter プロパティ値を持っているかどうかをチェックし、持っている場合は true を返します。これは、こうしたコントロールが承認され、ページに追加されることを示します。これは、ユーザーが既定の方法でユーザー パーソナル化スコープのページにコントロールを表示できることを前提にしています。ただし、この例では、コントロールの 1 つが、admin に設定された AuthorizationFilter プロパティ値を持っています。開発者は、管理者権限を持つユーザーに対してのみ表示されるようにデザインされた専用コントロールにこのフィルタを配置できます。このコントロールは、AuthorizeWebPart イベント発生時に承認チェックに失敗するため、表示されません。このプロパティ セットを持たないコントロールは表示されます。AuthorizationFilter プロパティが設定されていないため、これらはフィルタ処理の対象外と見なされます。

Visual Basic

<%@ Page Language="vb" %>

<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
      Else
        e.IsAuthorized = False
      End If
    End If

  End Sub
</script>

<html  >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="mgr1" runat="server"
 
        OnAuthorizeWebPart="mgr1_AuthorizeWebPart"
 />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:BulletedList 
            ID="BulletedList1" 
            Runat="server"
            DisplayMode="HyperLink" 
            Title="Favorite Links"
            AuthorizationFilter="admin">
            <asp:ListItem Value="http://msdn.microsoft.com">
              MSDN
            </asp:ListItem>
            <asp:ListItem Value="http://www.asp.net">
              ASP.NET
            </asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">
              MSN
            </asp:ListItem>
          </asp:BulletedList>
          <asp:Label ID="Label1" runat="server"
 
            Text="Hello World"
            Title="Filter Test"
            AuthorizationFilter="admin" />
          <asp:Calendar ID="Calendar1" runat="server"
 
            Title="My Calendar"/>
        </ZoneTemplate>
      </asp:WebPartZone>
    </div>
    </form>
</body>
</html>

C#

<%@ Page Language="C#" %>

<script runat="server">
  
  protected void mgr1_AuthorizeWebPart(object
 sender, 
    WebPartAuthorizationEventArgs e)
  {
    if (!String.IsNullOrEmpty(e.AuthorizationFilter))
    {
      if (e.AuthorizationFilter == "user")
        e.IsAuthorized = true;
      else
        e.IsAuthorized = false;
    }
  }
  
</script>

<html  >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="mgr1" runat="server"
        OnAuthorizeWebPart="mgr1_AuthorizeWebPart" />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:BulletedList 
            ID="BulletedList1" 
            Runat="server"
            DisplayMode="HyperLink" 
            Title="Favorite Links"
            AuthorizationFilter="admin">
            <asp:ListItem Value="http://msdn.microsoft.com">
              MSDN
            </asp:ListItem>
            <asp:ListItem Value="http://www.asp.net">
              ASP.NET
            </asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">
              MSN
            </asp:ListItem>
          </asp:BulletedList>
          <asp:Label ID="Label1" runat="server" 
            Text="Hello World"
            Title="Filter Test"
            AuthorizationFilter="admin" />
          <asp:Calendar ID="Calendar1" runat="server" 
            Title="My Calendar"/>
        </ZoneTemplate>
      </asp:WebPartZone>
    </div>
    </form>
</body>
</html>

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebPartManager クラス
WebPartManager メンバ
System.Web.UI.WebControls.WebParts 名前空間
OnAuthorizeWebPart
IsAuthorized
その他の技術情報
ASP.NET Web パーツ ページ