This documentation is archived and is not being maintained.

Login.FailureText Property

Note: This property is new in the .NET Framework version 2.0.

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

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

[LocalizableAttribute(true)] 
public virtual string FailureText { get; set; }
/** @property */
public String get_FailureText ()

/** @property */
public void set_FailureText (String value)

public function get FailureText () : String

public function set FailureText (value : String)

Property Value

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

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.

NoteNote

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 ASP.NET Globalization and Localization.

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>
    <BODY>
        <FORM 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>

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Show: