RoleManagerModule.GetRoles イベント

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

RoleManagerModule.GetRoles イベント

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

RoleManagerModule が現在のユーザーを表す RolePrincipal の作成準備を整えたときに発生するグローバル アプリケーション イベント。

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

Visual Basic (宣言)

Public Event GetRoles As
 RoleManagerEventHandler

Visual Basic (使用法)

Dim instance As RoleManagerModule
Dim handler As RoleManagerEventHandler

AddHandler instance.GetRoles, handler

C#

public event RoleManagerEventHandler GetRoles

C++

public:
event RoleManagerEventHandler^ GetRoles {
    void add (RoleManagerEventHandler^ value);
    void remove (RoleManagerEventHandler^ value);
}

J#

/** @event */
public void add_GetRoles (RoleManagerEventHandler
 value)

/** @event */
public void remove_GetRoles (RoleManagerEventHandler
 value)

JScript

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

解説

GetRoles イベントは、RoleManagerModule が RolePrincipal オブジェクトを作成して、このオブジェクトを CurrentHttpContext の User プロパティに代入する前に発生します。このイベントを使用すると、ロール情報を適用する時期を監査したり、RoleManagerModule による RolePrincipal の作成を独自のコードに置き換えたりできます。

GetRoles イベントで RoleManagerEventArgs の RolesPopulated プロパティを true に設定すると、RoleManagerModule によるロール情報の適用をキャンセルできます。

GetRoles イベント ハンドラで RolesPopulated を true に設定すると、RoleManagerModule によって現在の HttpContext の User プロパティが RolePrincipal オブジェクトに設定されなくなります。

使用例

次に、ASP.NET アプリケーションの Global.asax ファイルに含まれる GetRoles イベントの例を示します。GetRoles イベントは、Web.config ファイルでトレースが有効になっている場所にアプリケーションのトレース通知を追加します。

Visual Basic

Public Sub RoleManager_OnGetRoles(sender As
 Object, args As RoleManagerEventArgs)
  args.Context.Trace.Write("Roles", "Applying
 Role Information")
End Sub

C#

public void RoleManager_OnGetRoles(object sender,
 RoleManagerEventArgs args)
{
  args.Context.Trace.Write("Roles", "Applying Role Information");
}

プラットフォーム

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

参照

関連項目
RoleManagerModule クラス
RoleManagerModule メンバ
System.Web.Security 名前空間
その他の技術情報
ロールを使用した承認の管理