This documentation is archived and is not being maintained.
Provides data for the
FormsAuthentication_OnAuthenticate event. This class cannot be inherited.
public final class FormsAuthenticationEventArgs extends EventArgs
class is used to supply event values to the FormsAuthenticationEventArgs FormsAuthentication_OnAuthenticate event and to enable you to specify a custom identity for the current request.
constructs a FormsAuthenticationModule object using the current FormsAuthenticationEventArgs and passes it to the HttpContext FormsAuthentication_OnAuthenticate event.
You can use the
property to set the User property of the current User to a custom HttpContext object. IPrincipal
If you do not specify a value for the
property during the User FormsAuthentication_OnAuthenticate event, the identity supplied by the forms authentication ticket in the cookie or URL is used.
FormsAuthentication_OnAuthenticate event is only raised when the authentication is set to Mode and the Forms is an active HTTP module for the application. FormsAuthenticationModule
The following code example uses the
FormsAuthentication_OnAuthenticate event to set the property of the current User to a HttpContext object with a custom GenericPrincipal . Identity
No code example is currently available or this language may not be supported.
in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
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.
Supported in: 3.5, 3.0, 2.0, 1.1, 1.0