Login.FailureAction Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the action that occurs when a login attempt fails.

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

public virtual LoginFailureAction FailureAction { get; set; }

Property Value

Type: System.Web.UI.WebControls.LoginFailureAction

One of the LoginFailureAction enumeration values. The default is Refresh.

Exception Condition

The selected value is not one of the LoginFailureAction enumeration values.

The FailureAction property defines the behavior of the Login control when the user does not successfully log in to the Web site.

The default behavior reloads the page and displays the contents of the FailureText property to alert the user that the login attempt failed.

When FailureAction is set to RedirectToLoginPage, the user is redirected to the login page defined in the Web.config file.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

The following code example shows how to set the FailureAction property both declaratively and in code.

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

<script runat="server">
void Page_Load(Object sender, EventArgs e)
    Login1.FailureAction = LoginFailureAction.RedirectToLoginPage;


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

.NET Framework
Available since 2.0
Return to top