Edit

Share via

Login.FailureAction Property

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

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

public:
 virtual property System::Web::UI::WebControls::LoginFailureAction FailureAction { System::Web::UI::WebControls::LoginFailureAction get(); void set(System::Web::UI::WebControls::LoginFailureAction value); };
[System.Web.UI.Themeable(false)]
public virtual System.Web.UI.WebControls.LoginFailureAction FailureAction { get; set; }
[<System.Web.UI.Themeable(false)>]
member this.FailureAction : System.Web.UI.WebControls.LoginFailureAction with get, set
Public Overridable Property FailureAction As LoginFailureAction

Property Value

LoginFailureAction

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

Attributes
ThemeableAttribute

Exceptions

ArgumentOutOfRangeException

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

Examples

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;
}

</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:Login id="Login1" runat="server" FailureAction="RedirectToLoginPage"></asp:Login>
        </form>
    </body>
</html>

<%@ Page Language="VB" 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">
Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    Login1.FailureAction = LoginFailureAction.RedirectToLoginPage
End Sub

</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:Login id="Login1" runat="server" FailureAction="RedirectToLoginPage"></asp:Login>
        </form>
    </body>
</html>

Remarks

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.

Applies to

See also