Login.Authenticate Event (System.Web.UI.WebControls)

Authenticate Event

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Updated: November 2007

Occurs when a user is authenticated.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic (Declaration)

Public Event Authenticate As AuthenticateEventHandler

Visual Basic (Usage)

Dim instance As Login
Dim handler As AuthenticateEventHandler

AddHandler instance.Authenticate, handler

public event AuthenticateEventHandler Authenticate

Visual C++

public:
 event AuthenticateEventHandler^ Authenticate {
    void add (AuthenticateEventHandler^ value);
    void remove (AuthenticateEventHandler^ value);
}

/** @event */
public void add_Authenticate (AuthenticateEventHandler value)
/** @event */
public void remove_Authenticate (AuthenticateEventHandler value)

JScript

JScript does not support events.

ASP.NET

<asp:Login OnAuthenticate="AuthenticateEventHandler" />

Remarks

The Authenticate event is raised when a user uses the Login control to log in to a Web site. Custom authentication schemes can use the Authenticate event to authenticate users.

Note:
When a user uses the Login control to log in to a Web site, all data in the view state and all post data is lost. Do not perform actions in the Authenticate event that rely on the view state.

For more information about handling events, see Handling and Raising Events.

Notes to Implementers:

Custom authentication schemes should set the Authenticated property to true to indicate that a user has been authenticated.

When a user submits his or her login information, the Login control first raises the LoggingIn event, then the Authenticate event, and finally the LoggedIn event.

Examples

The following code example uses the Authenticate event to call site-specific custom authentication code.

Visual Basic

<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
Function SiteSpecificAuthenticationMethod(ByVal UserName As String, ByVal Password As String) As Boolean
    ' Insert code that implements a site-specific custom 
    ' authentication method here.
    '
    ' This example implementation always returns false.
    Return False
End Function

Sub OnAuthenticate(ByVal sender As Object, ByVal e As AuthenticateEventArgs)
    Dim Authenticated As Boolean
    Authenticated = SiteSpecificAuthenticationMethod(Login1.UserName, Login1.Password)

    e.Authenticated = Authenticated
End Sub


</script>

<html  >
    <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>

<%@ 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  >
    <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>

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, 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.

Version Information