AuthenticateEventArgs Class
Provides data for the Authenticate event.
Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
The AuthenticateEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
 | AuthenticateEventArgs() | Initializes a new instance of the AuthenticateEventArgs class with the Authenticated property set to false. |
| AuthenticateEventArgs(Boolean) | Initializes a new instance of the AuthenticateEventArgs class. |
| Name | Description | |
|---|---|---|
| Authenticated | Gets or sets a value indicating whether a user's authentication attempt succeeded. |
| Name | Description | |
|---|---|---|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
The AuthenticateEventArgs class provides the data needed for the Authenticate event. Custom authentication schemes for a Web site use the Authenticated property to indicate whether a user's login attempt succeeded.
The following code example uses the AuthenticateEventArgs class to pass data to a custom authentication method.
<%@ Page Language="C#" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> private bool SiteSpecificAuthenticationMethod(string UserName, string Password) { // Insert code that implements a site-specific custom // authentication method here. // // This example implementation always returns false. return false; } private void OnAuthenticate(object sender, AuthenticateEventArgs e) { bool Authenticated = false; Authenticated = SiteSpecificAuthenticationMethod(Login1.UserName, Login1.Password); e.Authenticated = Authenticated; } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>ASP.NET Example</title> </head> <body> <form id="form1" runat="server"> <asp:Login id="Login1" runat="server" OnAuthenticate="OnAuthenticate"> </asp:Login> </form> </body> </html>
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
