OnAuthenticate Method

Login.OnAuthenticate Method

Raises the Authenticate event to authenticate the user.

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

protected virtual void OnAuthenticate (
	AuthenticateEventArgs e
protected void OnAuthenticate (
	AuthenticateEventArgs e
protected function OnAuthenticate (
	e : AuthenticateEventArgs
Not applicable.



An AuthenticateEventArgs that contains the event data.

The OnAuthenticate method raises the Authenticate event. Use the Authenticate event to implement a custom authentication scheme.

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnAuthenticate method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors: When overriding OnAuthenticate in a derived class, be sure to call the base class's OnAuthenticate method so that registered delegates receive the event.

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

<%@ page language="C#"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">
    // This custom login control overloads the OnAuthenticate method
    // to call a site-specific authentication method.    
    class CustomLogin : Login
        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;
        override protected void OnAuthenticate(AuthenticateEventArgs e)
            bool Authenticated = false;
            Authenticated = SiteSpecificAuthenticationMethod(UserName, Password);

            e.Authenticated = Authenticated;
    // Add the custom login control to the page.
    void Page_Load(object sender, EventArgs e) 
        CustomLogin loginControl = new CustomLogin();
        loginControl.ID = "loginControl";

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
        <form id="form1" runat="server">
            <asp:placeholder id="Placeholder1" runat="server"></asp:placeholder>

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

© 2016 Microsoft