Edit

Login Constructor

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

Creates a new instance of the Login control.

public:
 Login();
public Login ();
Public Sub New ()

Examples

The following code example uses the Login constructor to create a new instance of the Login control and add that instance to the Controls collection of a PlaceHolder control.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.ComponentModel" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
bool IsValidEmail(string strIn)
{
    // Return true if strIn is in valid email format.
    return Regex.IsMatch(strIn, @"^([\w-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$"); 
}

void OnLoggingIn(object sender, System.Web.UI.WebControls.LoginCancelEventArgs e)
{
    Login loginControl = (Login)PlaceHolder1.FindControl("loginControl");

    if (!IsValidEmail(loginControl.UserName))
    {
        loginControl.InstructionText = "You must enter a valid email address.";
        e.Cancel = true;
    }
    else
    {
        loginControl.InstructionText = String.Empty;
    }
}

void Page_Load(object sender, EventArgs e) 
{
    Login loginControl = new Login();

    loginControl.ID = "loginControl";

    loginControl.HelpPageText = "Help logging in...";
    loginControl.HelpPageUrl = "help.aspx";

    loginControl.PasswordRecoveryText = "Forgot your password?";
    loginControl.PasswordRecoveryUrl = "getPass.aspx";

    loginControl.LoggingIn += new LoginCancelEventHandler(OnLoggingIn);

    PlaceHolder1.Controls.Add(loginControl);

}
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="form1" runat="server">
            <asp:PlaceHolder id="PlaceHolder1" runat="server"></asp:PlaceHolder>
        </form>
    </body>
</html>

<%@ Page Language="VB" %>
<%@ Import Namespace="System.ComponentModel" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
Function IsValidEmail(ByVal strIn As String) As Boolean
    ' Return true if strIn is in valid email format.
    Return Regex.IsMatch(strIn, ("^([\w-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$"))
End Function

Sub OnLoggingIn(ByVal sender As Object, ByVal e As System.Web.UI.WebControls.LoginCancelEventArgs)

    Dim loginControl As Login

    loginControl = CType(PlaceHolder1.FindControl("loginControl"), Login)

    If Not IsValidEmail(loginControl.UserName) Then
        loginControl.InstructionText = "You must enter a valid email address."
        e.Cancel = True
    Else
        loginControl.InstructionText = String.Empty
    End If
End Sub

Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim loginControl As New Login

    loginControl.ID = "loginControl"

    loginControl.HelpPageText = "Help loggin in..."
    loginControl.HelpPageUrl = "help.aspx"

    loginControl.PasswordRecoveryText = "Forgot your password?"
    loginControl.PasswordRecoveryUrl = "getPass.aspx"

    AddHandler loginControl.LoggingIn, AddressOf OnLoggingIn

    PlaceHolder1.Controls.Add(loginControl)

End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="form1" runat="server">
            <asp:PlaceHolder id="PlaceHolder1" runat="server"></asp:PlaceHolder>
        </form>
    </body>
</html>

Remarks

The Login constructor creates a new instance of the Login control that can be programmatically inserted into a Web page.

The following table shows the initial property values for a new instance of Login.

Property Initial value
RememberMeSet true
VisibleWhenLoggedIn true
FailureAction true
FailureText "Your login attempt has failed. Please try again."
MembershipProvider "Default"
Orientation Vertical
PasswordLabelText "Password:"
PasswordRequiredErrorMessage "Password."
RememberMeSet false
RememberMeText "Remember me next time."
LoginButtonText "Login"
TextLayout TextOnLeft
TitleText "Login"
UserNameLabelText "User Name:"
UserNameRequiredErrorMessage "User Name."

Applies to

See also