Login::FailureText Property

 
System_CAPS_noteNote

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 text displayed when a login attempt fails.

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

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

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."

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.

System_CAPS_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.".

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: