Export (0) Print
Expand All

Login.LayoutTemplate Property

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

Gets or sets the template used to display the Login control.

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

[TemplateContainerAttribute(typeof(Login))] 
public virtual ITemplate LayoutTemplate { get; set; }
/** @property */
public ITemplate get_LayoutTemplate ()

/** @property */
public void set_LayoutTemplate (ITemplate value)

public function get LayoutTemplate () : ITemplate

public function set LayoutTemplate (value : ITemplate)

Property Value

An ITemplate that contains the template for displaying the Login control. The default value is a null reference (Nothing in Visual Basic).

The LayoutTemplate property contains the template that defines how the Login control is displayed to the user.

The following table lists the required and optional controls used in a Login control template.

ID or command name

Control type

Required/optional

UserName

Any control that implements IEditableTextControl, including TextBox, or a custom or third-party control.

Required

Password

Any control that implements IEditableTextControl, including TextBox, or a custom or third-party control.

Required

RememberMe

CheckBox

Optional

FailureText

Any control that implements ITextControl.

Optional

Login

Any control that causes event bubbling.

Optional

The Login control throws an HttpException exception if the layout template does not contain the required controls. No exception is thrown if you give an optional control ID to a control of the wrong type; however, the control is subsequently ignored by the Login control.

The login control can be any control that causes event bubbling, such as Button, LinkButton, or ImageButton. The control's command name property must be set to "Login".

When a template is used for the Login control, only the following properties affect the behavior of the control:

All other properties are inactive when a template is set for the Login control.

The following code example creates a template for the Login control.

<%@ 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>
    <BODY>
        <FORM runat="server">
            <asp:Login id="Login1" runat="server">
                <LayoutTemplate>
                    <table>
                        <tr>
                            <td colspan="2" align="center">
                                Login
                            </td>
                        </tr>
                        <tr>
                            <td colspan="2" align="center">
                                Enter your user name and password to log in.
                            </td>
                        </tr>
                        <tr>
                            <td>
                                <table>
                                    <tr>
                                        <td>
                                            User name:
                                        </td>
                                        <td>
                                            <asp:TextBox id="UserName" runat="server"></asp:TextBox>
                                            <asp:requiredfieldvalidator id="UserNameRequired" runat="server" ControlToValidate="UserName" Text="*"></asp:requiredfieldvalidator>
                                        </td>
                                    </tr>
                                    <tr>
                                        <td>Password:</td>
                                        <td>
                                            <asp:TextBox id="Password" runat="server" textMode="Password"></asp:TextBox>
                                            <asp:requiredfieldvalidator id="PasswordRequired" runat="server" ControlToValidate="Password" Text="*"></asp:requiredfieldvalidator>
                                        </td>
                                    </tr>
                                    <tr>
                                        <td colspan="2">
                                            <asp:Checkbox id="RememberMe" runat="server" Text="Remember my login"></asp:Checkbox>
                                        </td>
                                    </tr>
                                </table>
                            </td>
                            <td valign="center">
                                <ul>
                                    <li><a href="newAccount.aspx">Create a new account...</a></li>
                                    <li><a href="getPass.aspx">Forgot your password?</a></li>
                                    <li><a href="help.aspx">Get help logging in...</a></li>
                                </ul>
                            </td>
                        </tr>
                        <tr>
                            <td colspan="2" align="center">
                                <asp:button id="Login" CommandName="Login" runat="server" Text="Login"></asp:button>
                            </td>
                        </tr>
                        <tr>
                            <td colspan="2" align="center">
                                <asp:Literal id="FailureText" runat="server"></asp:Literal></td>
                        </tr>
                    </table>
                </LayoutTemplate>
            </asp:Login>
        </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

Community Additions

ADD
Show:
© 2014 Microsoft