This documentation is archived and is not being maintained.

Login.UserNameRequiredErrorMessage Property

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

Gets or sets the error message to display in a ValidationSummary control when the user name field is left blank.

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

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

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

public function get UserNameRequiredErrorMessage () : String

public function set UserNameRequiredErrorMessage (value : String)

Property Value

The error message to display in a ValidationSummary control when the user name field is left blank. The default is "User Name."

The UserNameRequiredErrorMessage property contains the error message displayed in a ValidationSummary control on the login page.

The UserNameRequiredErrorMessage property value is displayed only when both the following conditions are true:

  • A ValidationSummary control is present on the page.

  • The User name text box is left blank by the user.

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

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 demonstrates using a ValidationSummary control to display the error message specified in the UserNameRequiredErrorMessage property.

<%@ Page Language="C#"%>
<!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">
            <table>
                <tr>
                    <td>
                        <asp:Login id="Login1" runat="server" 
                            PasswordRequiredErrorMessage="You must enter a password."
                            UserNameRequiredErrorMessage="You must enter a user name.">
                        </asp:Login>
                    </td>
                    <td>
                        <asp:ValidationSummary id="ValidationSummary1" runat="server">
                        </asp:ValidationSummary>
                    </td>
                </tr>
            </table>
        </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: