Home Library Learn Downloads Support Community
Sign in | United States - English | |
3 out of 12 rated this helpful - Rate this topic

Login Class

.NET Framework 4

Provides user interface (UI) elements for logging in to a Web site.

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.CompositeControl
        System.Web.UI.WebControls.Login

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
C#
C++
F#
VB
Copy 
[BindableAttribute(false)]
public class Login : CompositeControl
ASP.NET
Copy 
<asp:Login />

The Login type exposes the following members.

  Name Description
Public method Login Creates a new instance of the Login control.
Top
  Name Description
Public property AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected property Adapter Gets the browser-specific adapter for the control. (Inherited from Control.)
Public property AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public property Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public property BackColor Gets or sets the background color of the Web server control. (Inherited from WebControl.)
Public property BindingContainer Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public property BorderColor Gets or sets the border color of the Web control. (Inherited from WebControl.)
Public property BorderPadding Gets or sets the amount of padding inside the borders of the Login control.
Public property BorderStyle Gets or sets the border style of the Web server control. (Inherited from WebControl.)
Public property BorderWidth Gets or sets the border width of the Web server control. (Inherited from WebControl.)
Public property CheckBoxStyle Gets a reference to a Style object that defines the settings for the Remember Me check box.
Protected property ChildControlsCreated Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public property ClientID Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public property ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected property ClientIDSeparator Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Protected property Context Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public property Controls Gets a ControlCollection object that represents the child controls in a CompositeControl. (Inherited from CompositeControl.)
Public property ControlStyle Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public property ControlStyleCreated Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.)
Public property CreateUserIconUrl Gets the location of an image to display next to the link to a registration page for new users.
Public property CreateUserText Gets or sets the text of a link to a registration page for new users.
Public property CreateUserUrl Gets or sets the URL of the new-user registration page.
Public property CssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public property DataItemContainer Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public property DataKeysContainer Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Protected property DesignMode Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public property DestinationPageUrl Gets or sets the URL of the page displayed to the user when a login attempt is successful.
Public property DisplayRememberMe Gets or sets a value indicating whether to display a check box to enable the user to control whether a persistent cookie is sent to their browser.
Public property Enabled Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public property EnableTheming Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public property EnableViewState Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.)
Protected property Events Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public property FailureAction Gets or sets the action that occurs when a login attempt fails.
Public property FailureText Gets or sets the text displayed when a login attempt fails.
Public property FailureTextStyle Gets a reference to a collection of properties that define the appearance of error text in the Login control.
Public property Font Gets the font properties associated with the Web server control. (Inherited from WebControl.)
Public property ForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public property HasAttributes Gets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected property HasChildViewState Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Public property Height Gets or sets the height of the Web server control. (Inherited from WebControl.)
Public property HelpPageIconUrl Gets the location of an image to display next to the link to the login Help page.
Public property HelpPageText Gets or sets the text of a link to the login Help page.
Public property HelpPageUrl Gets or sets the URL of the login Help page.
Public property HyperLinkStyle Gets a reference to a collection of properties that define the appearance of hyperlinks in the Login control.
Public property ID Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected property IdSeparator Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Public property InstructionText Gets or sets login instruction text for the user.
Public property InstructionTextStyle Gets a reference to a TableItemStyle object that defines the settings for instruction text in the Login control.
Protected property IsChildControlStateCleared Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected property IsEnabled Gets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected property IsTrackingViewState Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected property IsViewStateEnabled Gets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public property LabelStyle Gets a reference to a TableItemStyle object that defines the settings for Login control labels.
Public property LayoutTemplate Gets or sets the template used to display the Login control.
Protected property LoadViewStateByID Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public property LoginButtonImageUrl Gets or sets the URL of an image to use for the login button.
Public property LoginButtonStyle Gets a reference to the Style object that allows you to set the appearance of the login button in the Login control.
Public property LoginButtonText Gets or sets the text for the Login control's login button.
Public property LoginButtonType Gets or sets the type of button to use when rendering the Login button.
Public property MembershipProvider Gets or sets the name of the membership data provider used by the control.
Public property NamingContainer Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value. (Inherited from Control.)
Public property Orientation Gets or sets a value that specifies the position of the elements of the Login control on the page.
Public property Page Gets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public property Parent Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public property Password Gets the password entered by the user.
Public property PasswordLabelText Gets or sets the text of the label for the Password text box.
Public property PasswordRecoveryIconUrl Gets the location of an image to display next to the link to the password recovery page.
Public property PasswordRecoveryText Gets or sets the text of a link to the password recovery page.
Public property PasswordRecoveryUrl Gets or sets the URL of the password recovery page.
Public property PasswordRequiredErrorMessage Gets or sets the error message to display in a ValidationSummary control when the password field is left blank.
Public property RememberMeSet Gets or sets a value indicating whether to send a persistent authentication cookie to the user's browser.
Public property RememberMeText Gets or sets the text of the label for the Remember Me check box.
Public property RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Public property RenderOuterTable Gets or sets a value that indicates whether the control encloses rendered HTML in a table element in order to apply inline styles.
Public property Site Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public property SkinID Gets or sets the skin to apply to the control. (Inherited from WebControl.)
Public property Style Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.)
Public property SupportsDisabledAttribute Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Inherited from CompositeControl.)
Public property TabIndex Gets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected property TagKey Gets the HtmlTextWriterTag value that corresponds to a Login control. This property is used primarily by control developers. (Overrides WebControl.TagKey.)
Protected property TagName Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public property TemplateControl Gets or sets a reference to the template that contains this control. (Inherited from Control.)
Public property TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public property TextBoxStyle Gets a reference to a collection of properties that define the appearance of text boxes in the Login control.
Public property TextLayout Specifies the position of each label relative to its associated text box for the Login control.
Public property TitleText Gets or sets the title of the Login control.
Public property TitleTextStyle Gets a reference to a collection of properties that define the appearance of the title text in the Login control.
Public property ToolTip Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public property UniqueID Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public property UserName Gets the user name entered by the user.
Public property UserNameLabelText Gets or sets the text of the label for the UserName text box.
Public property UserNameRequiredErrorMessage Gets or sets the error message to display in a ValidationSummary control when the user name field is left blank.
Public property ValidatorTextStyle Gets a reference to a collection of Style properties that define the appearance of error messages associated with validators used by the Login control.
Protected property ViewState Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.)
Protected property ViewStateIgnoresCase Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public property ViewStateMode Gets or sets the view-state mode of this control. (Inherited from Control.)
Public property Visible Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public property VisibleWhenLoggedIn Gets or sets a value indicating whether to show the Login control after the user is authenticated.
Public property Width Gets or sets the width of the Web server control. (Inherited from WebControl.)
Top
  Name Description
Protected method AddAttributesToRender Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method AddedControl Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected method AddParsedSubObject Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.)
Public method ApplyStyle Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.)
Public method ApplyStyleSheetSkin Applies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected method BuildProfileTree Infrastructure. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.)
Protected method ClearCachedClientID Infrastructure. Sets the cached ClientID value to null. (Inherited from Control.)
Protected method ClearChildControlState Deletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected method ClearChildState Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearChildViewState Deletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearEffectiveClientIDMode Infrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.)
Public method CopyBaseAttributes Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method CreateChildControls Creates the individual controls that make up the Login control and associates event handlers with their events. (Overrides Control.CreateChildControls().)
Protected method CreateControlCollection Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
Protected method CreateControlStyle Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl.)
Public method DataBind() Binds a data source to the CompositeControl and all its child controls. (Inherited from CompositeControl.)
Protected method DataBind(Boolean) Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.)
Protected method DataBindChildren Binds a data source to the server control's child controls. (Inherited from Control.)
Public method Dispose Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected method EnsureChildControls Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected method EnsureID Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindControl(String) Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Protected method FindControl(String, Int32) Infrastructure. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.)
Public method Focus Sets input focus to a control. (Inherited from Control.)
Protected method GetDesignModeState Infrastructure. Gets design-time data for a control. (Inherited from Control.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetRouteUrl(Object) Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public method GetRouteUrl(RouteValueDictionary) Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public method GetRouteUrl(String, Object) Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public method GetRouteUrl(String, RouteValueDictionary) Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUniqueIDRelativeTo Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public method HasControls Determines if the server control contains any child controls. (Inherited from Control.)
Protected method HasEvents Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected method IsLiteralContent Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected method LoadControlState Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected method LoadViewState Infrastructure. Restores view-state information from a previous request that was saved with the SaveViewState method. (Overrides WebControl.LoadViewState(Object).)
Protected method MapPathSecure Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MergeStyle Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method OnAuthenticate Raises the Authenticate event to authenticate the user.
Protected method OnBubbleEvent Determines whether to pass an event up the page's user interface (UI) server control hierarchy. (Overrides Control.OnBubbleEvent(Object, EventArgs).)
Protected method OnDataBinding Raises the DataBinding event. (Inherited from Control.)
Protected method OnInit Raises the Init event. (Inherited from Control.)
Protected method OnLoad Raises the Load event. (Inherited from Control.)
Protected method OnLoggedIn Raises the LoggedIn event after the user logs in to the Web site and has been authenticated.
Protected method OnLoggingIn Raises the LoggingIn event when a user submits login information but before the authentication takes place.
Protected method OnLoginError Raises the LoginError event when a login attempt fails.
Protected method OnPreRender Implements the base Control.OnPreRender method. (Overrides Control.OnPreRender(EventArgs).)
Protected method OnUnload Raises the Unload event. (Inherited from Control.)
Protected method OpenFile Gets a Stream used to read a file. (Inherited from Control.)
Protected method RaiseBubbleEvent Assigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected method RecreateChildControls Recreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl.)
Protected method RemovedControl Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected method Render Infrastructure. Renders the login form using the specified HTML writer. (Overrides CompositeControl.Render(HtmlTextWriter).)
Public method RenderBeginTag Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method RenderChildren Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.)
Protected method RenderContents Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Public method RenderControl(HtmlTextWriter) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter) Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
Public method RenderEndTag Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method ResolveAdapter Gets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public method ResolveClientUrl Gets a URL that can be used by the browser. (Inherited from Control.)
Public method ResolveUrl Converts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected method SaveControlState Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected method SaveViewState Infrastructure. Saves any state that was modified after the TrackViewState method was invoked. (Overrides WebControl.SaveViewState().)
Protected method SetDesignModeState Sets design-time data for a control. (Overrides Control.SetDesignModeState(IDictionary).)
Public method SetRenderMethodDelegate Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method TrackViewState Overrides the base Control.TrackViewState method. (Overrides WebControl.TrackViewState().)
Top
  Name Description
Public event Authenticate Occurs when a user is authenticated.
Public event DataBinding Occurs when the server control binds to a data source. (Inherited from Control.)
Public event Disposed Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.)
Public event Init Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public event Load Occurs when the server control is loaded into the Page object. (Inherited from Control.)
Public event LoggedIn Occurs when the user logs in to the Web site and has been authenticated.
Public event LoggingIn Occurs when a user submits login information, before authentication takes place.
Public event LoginError Occurs when a login error is detected.
Public event PreRender Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public event Unload Occurs when the server control is unloaded from memory. (Inherited from Control.)
Top
  Name Description
Public Extension Method FindDataSourceControl Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension Method FindFieldTemplate Returns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension Method FindMetaTable Returns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Top
  Name Description
Public field Static member LoginButtonCommandName Represents the command name associated with the login button.
Top
  Name Description
Explicit interface implemetation Private method IAttributeAccessor.GetAttribute Infrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetation Private method IAttributeAccessor.SetAttribute Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetation Private method ICompositeControlDesignerAccessor.RecreateChildControls Enables a designer to recreate the composite control's collection of child controls in the design-time environment. (Inherited from CompositeControl.)
Explicit interface implemetation Private property IControlBuilderAccessor.ControlBuilder For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessor.GetDesignModeState For a description of this member, see IControlDesignerAccessor.GetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessor.SetDesignModeState For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessor.SetOwnerControl Infrastructure. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)
Explicit interface implemetation Private property IControlDesignerAccessor.UserData For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessor.DataBindings For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessor.HasDataBindings For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessor.Expressions For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessor.HasExpressions For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)
Explicit interface implemetation Private method IParserAccessor.AddParsedSubObject For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)
Top

In this topic:

Introduction

The Login control is a composite control that provides all the common UI elements needed to authenticate a user on a Web site. The following three elements are required for all login scenarios:

  • A unique user name to identify the user.

  • A password to verify the identity of the user.

  • A login button to send the login information to the server.

The Login control also provides the following optional UI elements that support additional functions:

  • A link for a password reminder.

  • A Remember Me checkbox for retaining the login information between sessions.

  • A Help link for users who are having trouble logging in.

  • A Register New User link that redirects users to a registration page.

  • Instruction text that appears on the login form.

  • Custom error text that appears when the user clicks the login button without filling in the user name or password fields.

  • Custom error text that appears if the login fails.

  • A custom action that occurs when login succeeds.

  • A way to hide the login control if the user is already logged in to the site.

For a table showing which controls are required and which are optional, see LayoutTemplate property.

Note Note

If you are not familiar with the set of login controls available in ASP.NET, see ASP.NET Login Controls Overview before continuing. For a list of other topics related to login controls and membership, see Managing Users by Using Membership.
Security note Security Note

Accepting user input is a potential security threat. Malicious users can send data that is intended to expose vulnerabilities or run programs that try generated passwords. To improve security when working with user input, you should use the validation features of your control and secure any data providers that are configured for your control. For more information, see Securing Login Controls, Basic Security Practices for Web Applications, and Securing Membership.

The Login control uses a membership provider to obtain user credentials. Unless you specify otherwise, the Login control uses the default membership provider defined in the Web.config file. To specify a different provider, set the MembershipProvider property to one of the membership provider names defined in your application's Web.config file. For more information, see Membership Providers.

If you want to use a custom authentication service, you can use the OnAuthenticate method to call the service.

Styles and Templates

The appearance of the Login control is fully customizable through templates and style settings. All UI text messages are also customizable through properties of the Login class. The default interface text is automatically localized based on the locale setting on the server.

If the Login control is customized with templates, then the AccessKey property and the TabIndex property are ignored. In this case, set the AccessKey property and the TabIndex property of each template child control directly.

Login control properties represented by text boxes, such as UserName and Password, are accessible during all phases of the page life cycle. The control will pick up any changes made by the end user by means of the TextChanged event triggered by the textboxes.

Note Note

If you embed the Login control in a WizardStep object, explicitly set the ActiveStepIndex property in a Page_Load event handler if the user is authenticated. The Wizard control does not automatically advance to the next WizardStep object in this scenario.

The following table lists the Login control style properties and explains which UI element each style property affects. For a list of which properties each style applies to, see the documentation for the individual style properties.

Style property

UI element affected

BorderPadding

The space between the control contents and the control's border.

CheckBoxStyle

Remember Me checkbox.

FailureTextStyle

Login failure text.

InstructionTextStyle

Instructional text on the page that tells users how to use the control.

LabelStyle

Labels for all input fields, such as text boxes.

TextBoxStyle

Text entry input fields.

TitleTextStyle

Title text.

ValidatorTextStyle

Text displayed to the user when a login attempt is unsuccessful due to validation errors.

HyperLinkStyle

Links to other pages.

LoginButtonStyle

Login button.

Validation Groupings

The UserName and Password properties have RequiredFieldValidator controls associated with them to prevent users from submitting the page without providing required information.

The Login control uses a validation group so that other fields on the same page as the Login control can be validated separately. By default, the ID property of the Login control is used as the name of the validation group. For example, a Login control with the ID "Login1" will use a validation group name of "Login1". If you want to set the validation group that the Login control is part of, you must template the control and change the validation group name.

Applying CSS Styles

The Login control lets you specify CSS style rules in markup. If you use templates to customize the appearance of the Login control, you can specify CSS styles in the markup in the templates. In that case, no extra outer table is required. You can prevent the table from being rendered by setting the RenderOuterTable property to false.

Accessibility

For information about how to configure this control so that it generates markup that conforms to accessibility standards, see Accessibility in Visual Studio and ASP.NET and ASP.NET Controls and Accessibility.

Declarative Syntax

Copy 
<asp:Login
    AccessKey="string"
    BackColor="color name|#dddddd"
    BorderColor="color name|#dddddd"
    BorderPadding="integer"
    BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
        Inset|Outset"
    BorderWidth="size"
    CreateUserIconUrl="uri"
    CreateUserText="string"
    CreateUserUrl="uri"
    CssClass="string"
    DestinationPageUrl="uri"
    DisplayRememberMe="True|False"
    Enabled="True|False"
    EnableTheming="True|False"
    EnableViewState="True|False"
    FailureAction="Refresh|RedirectToLoginPage"
    FailureText="string"
    Font-Bold="True|False"
    Font-Italic="True|False"
    Font-Names="string"
    Font-Overline="True|False"
    Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
               Large|X-Large|XX-Large"
    Font-Strikeout="True|False"
    Font-Underline="True|False"
    ForeColor="color name|#dddddd"
    Height="size"
    HelpPageIconUrl="uri"
    HelpPageText="string"
    HelpPageUrl="uri"
    ID="string"
    InstructionText="string"
    LoginButtonImageUrl="uri"
    LoginButtonText="string"
    LoginButtonType="Button|Image|Link"
    MembershipProvider="string"
    OnAuthenticate="Authenticate event handler"
    OnDataBinding="DataBinding event handler"
    OnDisposed="Disposed event handler"
    OnInit="Init event handler"
    OnLoad="Load event handler"
    OnLoggedIn="LoggedIn event handler"
    OnLoggingIn="LoggingIn event handler"
    OnLoginError="LoginError event handler"
    OnPreRender="PreRender event handler"
    OnUnload="Unload event handler"
    Orientation="Horizontal|Vertical"
    PasswordLabelText="string"
    PasswordRecoveryIconUrl="uri"
    PasswordRecoveryText="string"
    PasswordRecoveryUrl="uri"
    PasswordRequiredErrorMessage="string"
    RememberMeSet="True|False"
    RememberMeText="string"
    runat="server"
    SkinID="string"
    Style="string"
    TabIndex="integer"
    TextLayout="TextOnLeft|TextOnTop"
    TitleText="string"
    ToolTip="string"
    UserName="string"
    UserNameLabelText="string"
    UserNameRequiredErrorMessage="string"
    Visible="True|False"
    VisibleWhenLoggedIn="True|False"
    Width="size"
>
        <CheckBoxStyle />
        <FailureTextStyle />
        <HyperLinkStyle />
        <InstructionTextStyle />
        <LabelStyle />
        <LayoutTemplate>
            <!-- child controls -->
        </LayoutTemplate>
        <LoginButtonStyle />
        <TextBoxStyle />
        <TitleTextStyle />
        <ValidatorTextStyle />
</asp:Login>

The following code example uses a Login control to provide a UI for logging in to a Web site.

C#
VB
Copy 

<%@ 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 e-mail 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)
{
    if (!IsValidEmail(Login1.UserName))
    {
        Login1.InstructionText = "Enter a valid e-mail address.";
        Login1.InstructionTextStyle.ForeColor = System.Drawing.Color.RosyBrown;
        e.Cancel = true;
    }
    else
    {
        Login1.InstructionText = String.Empty;
    }
}

void OnLoginError(object sender, EventArgs e)
{
    Login1.HelpPageText = "Help with logging in...";
    Login1.PasswordRecoveryText = "Forgot your password?";
}
</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:Login id="Login1" runat="server" 
                BorderStyle="Solid" 
                BackColor="#F7F7DE" 
                BorderWidth="1px"
                BorderColor="#CCCC99" 
                Font-Size="10pt" 
                Font-Names="Verdana" 
                CreateUserText="Create a new user..."
                CreateUserUrl="newUser.aspx" 
                HelpPageUrl="help.aspx"
                PasswordRecoveryUrl="getPass.aspx" 
                UserNameLabelText="E-mail address:" 
                OnLoggingIn="OnLoggingIn"
                OnLoginError="OnLoginError" >
                <TitleTextStyle Font-Bold="True" 
                    ForeColor="#FFFFFF" 
                    BackColor="#6B696B">
                </TitleTextStyle>
            </asp:Login>

        </form>
    </body>
</html>

The following code example demonstrates how you can extend the Login control. The CustomLogin control includes a DropDownList control that lets users choose which membership provider they are authenticated with. (These providers are configured in Web.config.) In the OnLoggingIn method, the MembershipProvider property is set to the selected value of the DropDownList control.

Security note Security Note

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.
C#
VB
Copy 

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

namespace Samples.AspNet.Controls
{
    public sealed class CustomLogin : Login
    {
        public CustomLogin() { }

        protected override void OnLoggingIn(LoginCancelEventArgs e)
        {
            // Set the Membership provider for the Login control from a DropDownList.
            DropDownList list = (DropDownList)this.FindControl("domain");
            this.MembershipProvider = list.SelectedValue;
            base.OnLoggingIn(e);
        }

        protected override void CreateChildControls()
        {
            LayoutTemplate = new MyTemplate();
            base.CreateChildControls();
        }
    }

    // A Template that contains the child controls.
    public class MyTemplate : ITemplate
    {
        void ITemplate.InstantiateIn(Control container)
        {
            // A TextBox for the user name.
            TextBox username = new TextBox();
            username.ID = "username";

            // A TextBox for the password.
            TextBox password = new TextBox();
            password.ID = "password";

            // A CheckBox to remember the user on subsequent visits.
            CheckBox remember = new CheckBox();
            remember.ID = "RememberMe";
            remember.Text = "Don't forget me!";

            // Failure Text.
            Literal failure = new Literal();
            failure.ID = "FailureText";

            // A DropDownList to choose the Membership provider.
            DropDownList domain = new DropDownList();
            domain.ID = "Domain";
            domain.Items.Add(new ListItem("SqlMembers"));
            domain.Items.Add(new ListItem("SqlMembers2"));

            // A Button to log in.
            Button submit = new Button();
            submit.CommandName = "login";
            submit.Text = "LOGIN";

            container.Controls.Add(new LiteralControl("UserName:"));
            container.Controls.Add(username);
            container.Controls.Add(new LiteralControl("<br>Password:"));
            container.Controls.Add(password);
            container.Controls.Add(new LiteralControl("<br>"));
            container.Controls.Add(remember);
            container.Controls.Add(new LiteralControl("<br>Domain:"));
            container.Controls.Add(domain);
            container.Controls.Add(new LiteralControl("<br>"));
            container.Controls.Add(failure);
            container.Controls.Add(new LiteralControl("<br>"));
            container.Controls.Add(submit);
        }
    }    
}

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ