Export (0) Print
Expand All

Login.UserNameRequiredErrorMessage Property

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)

public virtual string UserNameRequiredErrorMessage { get; set; }

Property Value

Type: System.String
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.

Both the PasswordRequiredErrorMessage and UserNameRequiredErrorMessage values are wrapped in a validation group within the Login control. For these values to display, the ValidationGroup property of the ValidationSummary control must be set to the ID property of the Login control.

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 xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="form1" 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" ValidationGroup="Login1" >
                        </asp:ValidationSummary>
                    </td>
                </tr>
            </table>
        </form>
    </body>
</html>

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0
Show:
© 2015 Microsoft