Login.FailureText Property (System.Web.UI.WebControls)

Switch View

FailureText Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

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

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

Syntax

Visual Basic (Declaration)

Public Overridable Property FailureText As String

Visual Basic (Usage)

Dim instance As Login
Dim value As String

value = instance.FailureText

instance.FailureText = value

public virtual string FailureText { get; set; }

Visual C++

public:
virtual property String^ FailureText {
    String^ get ();
    void set (String^ value);
}

JScript

public function get FailureText () : String
public function set FailureText (value : String)

ASP.NET

<asp:Login FailureText="String" />

Property Value

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

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

Examples

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

Visual Basic

<%@ 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  >
    <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="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  >
    <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>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

System.Web.UI.WebControls Namespace

FailureTextStyle

Other Resources

ASP.NET Login Controls Overview