-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
RoleManagerEventArgs.xml
154 lines (141 loc) · 11.1 KB
/
RoleManagerEventArgs.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<Type Name="RoleManagerEventArgs" FullName="System.Web.Security.RoleManagerEventArgs">
<TypeSignature Language="C#" Value="public sealed class RoleManagerEventArgs : EventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RoleManagerEventArgs extends System.EventArgs" />
<TypeSignature Language="DocId" Value="T:System.Web.Security.RoleManagerEventArgs" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class RoleManagerEventArgs
Inherits EventArgs" />
<TypeSignature Language="F#" Value="type RoleManagerEventArgs = class
 inherit EventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class RoleManagerEventArgs sealed : EventArgs" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.EventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides event data for the <see cref="E:System.Web.Security.RoleManagerModule.GetRoles" /> event of the <see cref="T:System.Web.Security.RoleManagerModule" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Security.RoleManagerEventArgs> object provides event information to the <xref:System.Web.Security.RoleManagerModule.GetRoles> event of the <xref:System.Web.Security.RoleManagerModule> class. The <xref:System.Web.Security.RoleManagerEventArgs> object provides access to the <xref:System.Web.HttpContext> of the current request, and a `Boolean` <xref:System.Web.Security.RoleManagerEventArgs.RolesPopulated%2A> property is used to enable or cancel creation of a <xref:System.Web.Security.RolePrincipal> by the <xref:System.Web.Security.RoleManagerModule>.
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/9ab2fxh0(v=vs.100)">Managing Authorization Using Roles</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RoleManagerEventArgs (System.Web.HttpContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Web.HttpContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Security.RoleManagerEventArgs.#ctor(System.Web.HttpContext)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (context As HttpContext)" />
<MemberSignature Language="F#" Value="new System.Web.Security.RoleManagerEventArgs : System.Web.HttpContext -> System.Web.Security.RoleManagerEventArgs" Usage="new System.Web.Security.RoleManagerEventArgs context" />
<MemberSignature Language="C++ CLI" Value="public:
 RoleManagerEventArgs(System::Web::HttpContext ^ context);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="context" Type="System.Web.HttpContext" />
</Parameters>
<Docs>
<param name="context">The <see cref="T:System.Web.HttpContext" /> of the current request.</param>
<summary>Creates an instance of the <see cref="T:System.Web.Security.RoleManagerEventArgs" /> class and sets the <see cref="P:System.Web.Security.RoleManagerEventArgs.Context" /> property to the specified <see cref="T:System.Web.HttpContext" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Security.RoleManagerEventArgs> object provides event information to the <xref:System.Web.Security.RoleManagerModule.GetRoles> event of the <xref:System.Web.Security.RoleManagerModule> class. The <xref:System.Web.Security.RoleManagerEventArgs> object provides access to the <xref:System.Web.HttpContext> of the current request, and a `Boolean` <xref:System.Web.Security.RoleManagerEventArgs.RolesPopulated%2A> property is used to enable or cancel creation of a <xref:System.Web.Security.RolePrincipal> by the <xref:System.Web.Security.RoleManagerModule>.
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/9ab2fxh0(v=vs.100)">Managing Authorization Using Roles</related>
</Docs>
</Member>
<Member MemberName="Context">
<MemberSignature Language="C#" Value="public System.Web.HttpContext Context { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.HttpContext Context" />
<MemberSignature Language="DocId" Value="P:System.Web.Security.RoleManagerEventArgs.Context" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Context As HttpContext" />
<MemberSignature Language="F#" Value="member this.Context : System.Web.HttpContext" Usage="System.Web.Security.RoleManagerEventArgs.Context" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::HttpContext ^ Context { System::Web::HttpContext ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.HttpContext</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Web.HttpContext" /> for the current request.</summary>
<value>The <see cref="T:System.Web.HttpContext" /> for the current request.</value>
<remarks>
<format type="text/markdown"><]
[!code-vb[System.Web.Security.RoleManagerModule#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.RoleManagerModule/VB/global.asax#1)]
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/9ab2fxh0(v=vs.100)">Managing Authorization Using Roles</related>
</Docs>
</Member>
<Member MemberName="RolesPopulated">
<MemberSignature Language="C#" Value="public bool RolesPopulated { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool RolesPopulated" />
<MemberSignature Language="DocId" Value="P:System.Web.Security.RoleManagerEventArgs.RolesPopulated" />
<MemberSignature Language="VB.NET" Value="Public Property RolesPopulated As Boolean" />
<MemberSignature Language="F#" Value="member this.RolesPopulated : bool with get, set" Usage="System.Web.Security.RoleManagerEventArgs.RolesPopulated" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool RolesPopulated { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether role information has been applied to the current user.</summary>
<value>
<see langword="true" /> if role information has been applied to the current user; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Security.RoleManagerEventArgs.RolesPopulated%2A> property is used to enable or cancel creation of a <xref:System.Web.Security.RolePrincipal> by the <xref:System.Web.Security.RoleManagerModule>.
If set to `true` in the <xref:System.Web.Security.RoleManagerModule.GetRoles> event, then the <xref:System.Web.Security.RoleManagerModule> assumes that role membership for the current user has been verified and any required role membership information has been set up for the current user. No action is taken by the <xref:System.Web.Security.RoleManagerModule> to create a <xref:System.Web.Security.RolePrincipal> object for the current user.
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/9ab2fxh0(v=vs.100)">Managing Authorization Using Roles</related>
</Docs>
</Member>
</Members>
</Type>