This documentation is archived and is not being maintained.

Login.OnLoginError Method

Note: This method is new in the .NET Framework version 2.0.

Raises the LoginError event when a login attempt fails.

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

protected virtual void OnLoginError (
	EventArgs e
protected void OnLoginError (
	EventArgs e
protected function OnLoginError (
	e : EventArgs



An EventArgs that contains the event data.

The OnLoginError method raises the LoginError event. Use the LoginError event to provide additional processing, such as error logging, when a user's login attempt fails.

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

The OnLoginError 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 OnLoginError in a derived class, be sure to call the base class's OnLoginError method so that registered delegates receive the event.

The following code example uses the LoginError event to display Help links to the user when a login attempt fails.

<%@ page language="C#" %>

<script runat="server">
// This custom Login control displays help
// information if the user does not log in
// on the first attempt.
class CustomLogin : Login
    override protected void OnLoginError(EventArgs e)
        HelpPageText = "Help with logging in...";
        CreateUserText = "Create a new user...";
        PasswordRecoveryText = "Forgot your password?";
    public CustomLogin() 
        CreateUserUrl = "createUser.aspx";
        HelpPageUrl = "loginHelp.aspx";
        PasswordRecoveryUrl = "getPass.aspx";
    // Add the custom login control to the page.
    void Page_Load(object sender, EventArgs e) 
        CustomLogin loginControl = new CustomLogin();
        loginControl.ID = "loginControl";

        <form id="Form1" runat="server">
            <asp:placeholder id="Placeholder1" runat="server"></asp:placeholder>

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0