FormsAuthenticationEventArgs Class
Provides data for the FormsAuthentication_OnAuthenticate event. This class cannot be inherited.
Assembly: System.Web (in System.Web.dll)
The FormsAuthenticationEventArgs class is used to supply event values to the FormsAuthentication_OnAuthenticate event and to enable you to specify a custom identity for the current request.
The FormsAuthenticationModule constructs a FormsAuthenticationEventArgs object using the current HttpContext and passes it to the FormsAuthentication_OnAuthenticate event.
You can use the User property to set the User property of the current HttpContext to a custom IPrincipal object.
If you do not specify a value for the User property during the FormsAuthentication_OnAuthenticate event, the identity supplied by the forms authentication ticket in the cookie or URL is used.
The FormsAuthentication_OnAuthenticate event is only raised when the authentication Mode is set to Forms and the FormsAuthenticationModule is an active HTTP module for the application.
The following code example uses the FormsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a GenericPrincipal object with a custom Identity.
Public Sub FormsAuthentication_OnAuthenticate(sender As Object, _ args As FormsAuthenticationEventArgs) If FormsAuthentication.CookiesSupported Then If Not Request.Cookies(FormsAuthentication.FormsCookieName) Is Nothing Then Try Dim ticket As FormsAuthenticationTicket = FormsAuthentication.Decrypt( _ Request.Cookies(FormsAuthentication.FormsCookieName).Value) args.User = New System.Security.Principal.GenericPrincipal( _ New Samples.AspNet.Security.MyFormsIdentity(ticket), _ New String(0) {}) Catch e As HttpException ' Decrypt method failed. End Try End If Else Throw New Exception("Cookieless Forms Authentication is not " & _ "supported for this application.") End If End Sub
- AspNetHostingPermission
for using the FormsAuthenticationEventArgs class in a hosted environment. Demand value: LinkDemand. Permission value: Minimal.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.