Edit

Login.FailureText Property

  • Reference

Definition

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

Gets or sets the text displayed when a login attempt fails.

public:
 virtual property System::String ^ FailureText { System::String ^ get(); void set(System::String ^ value); };
public virtual string FailureText { get; set; }
member this.FailureText : string with get, set
Public Overridable Property FailureText As String

Property Value

String

The text to display to the user when a login attempt fails. The default is "Your login attempt has failed. Please try again."

Examples

The following code example sets the FailureText property to "There was an error while logging you in. Please try again.".

<%@ 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">
</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" FailureText="There was an error while logging you in. Please try again.">
                <FailureTextStyle ForeColor="White" BackColor="Red"></FailureTextStyle>
            </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">
</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" FailureText="There was an error while logging you in. Please try again.">
                <FailureTextStyle ForeColor="White" BackColor="Red"></FailureTextStyle>
            </asp:Login>

        </form>
    </body>
</html>

Remarks

The FailureText property specifies the string that is displayed when a login attempt fails.

If you define a template for the Login control, you can indicate where on the template to display the FailureText property by using a Literal control and giving that control the ID "FailureText". When you use a template, the FailureTextStyle property is not applied to the text specified in the FailureText property.

The default text for the property is localized based on the server's current locale.

Note

For security reasons, the login failure text should not include a specific reason for the failure. For example, an error message such as "Password not valid for user <username>" reveals to a potential attacker that <username> is a user on the system. For more information, see How to: Display Safe Error Messages.

The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and Globalization and Localization.

Applies to

See also