This documentation is archived and is not being maintained.

Login.OnLoginError Method

Raises the LoginError event when a login attempt fails.

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

Protected Overridable Sub OnLoginError ( _
	e As EventArgs _


Type: System.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="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">
    ' This custom Login control displays help
    ' informatin if the user does not log in
    ' on the first attempt.
    Class CustomLogin
        Inherits Login

        Protected Overrides Sub OnLoginError(ByVal e As EventArgs)
            HelpPageText = "Help with logging in..."
            CreateUserText = "Create a new user..."
            PasswordRecoveryText = "Forgot your password?"
        End Sub

        Sub New()
            CreateUserUrl = "createUser.aspx"
            HelpPageUrl = "loginHelp.aspx"
            PasswordRecoveryUrl = "getPass.aspx"
        End Sub

    End Class
    ' Add the custom login control to the page.
    Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        Dim loginControl As New CustomLogin

        loginControl.ID = "loginControl"

    End Sub

<html xmlns="" >
<head runat="server">
    <title>ASP.NET Example</title>
<form id="Form1" runat="server">
    <asp:placeholder id="Placeholder1" runat="Server"></asp:placeholder>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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