Export (0) Print
Expand All

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 virtual void OnLoginError(
	EventArgs e
)

Parameters

e
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="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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";
        Placeholder1.Controls.Add(loginControl);
    }

</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:placeholder id="Placeholder1" runat="server"></asp:placeholder>
        </form>
    </body>
</html>

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0
Show:
© 2015 Microsoft