LoginView Class
Displays the appropriate content template for a given user, based on the user's authentication status and role membership.
Assembly: System.Web (in System.Web.dll)
The LoginView type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) |
![]() | AnonymousTemplate | Gets or sets the template to display to users who are not logged in to the Web site. |
![]() | AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) |
![]() | BindingContainer | Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.) |
![]() | ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) |
![]() | ClientID | Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.) |
![]() | ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.) |
![]() | ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) |
![]() | Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) |
![]() | Controls | Gets the ControlCollection object that contains the child controls for the LoginView control. (Overrides Control.Controls.) |
![]() | DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) |
![]() | DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.) |
![]() | DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) |
![]() | EnableTheming | Gets or sets a value indicating whether themes can be applied to the LoginView control. (Overrides Control.EnableTheming.) |
![]() | 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.) |
![]() | Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) |
![]() | HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) |
![]() | ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) |
![]() | IdSeparator | Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.) |
![]() | IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) |
![]() | IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) |
![]() | IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) |
![]() | LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) |
![]() | LoggedInTemplate | Gets or sets the template to display to Web site users who are logged in to the Web site but are not members of one of the role groups specified in the RoleGroups 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.) |
![]() | Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) |
![]() | Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) |
![]() | RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) |
![]() | RoleGroups | Gets a collection of role groups that associate content templates with particular roles. |
![]() | Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) |
![]() | SkinID | Gets or sets the skin to apply to the LoginView control. (Overrides Control.SkinID.) |
![]() | TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) |
![]() | TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) |
![]() | UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) |
![]() | 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.) |
![]() | ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) |
![]() | ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from Control.) |
![]() | Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) |
| Name | Description | |
|---|---|---|
![]() | AddedControl | Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.) |
![]() | 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.) |
![]() | ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) |
![]() | 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.) |
![]() | ClearCachedClientID | Infrastructure. Sets the cached ClientID value to a null reference (Nothing in Visual Basic). (Inherited from Control.) |
![]() | ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) |
![]() | ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) |
![]() | ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) |
![]() | ClearEffectiveClientIDMode | Infrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.) |
![]() | CreateChildControls | Creates the child controls that make up the LoginView control. (Overrides Control.CreateChildControls().) |
![]() | CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.) |
![]() | DataBind() | Binds a data source to LoginView and all its child controls. (Overrides Control.DataBind().) |
![]() | 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.) |
![]() | DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) |
![]() | Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) |
![]() | EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) |
![]() | EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | FindControl(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) |
![]() | 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.) |
![]() | Focus | Sets input focus to a control. (Overrides Control.Focus().) |
![]() | GetDesignModeState | Infrastructure. Gets design-time data for a control. (Inherited from Control.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) |
![]() | GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) |
![]() | GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) |
![]() | GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) |
![]() | HasControls | Determines if the server control contains any child controls. (Inherited from Control.) |
![]() | HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) |
![]() | IsLiteralContent | Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.) |
![]() | LoadControlState | This method implements LoadControlState. (Overrides Control.LoadControlState(Object).) |
![]() | LoadViewState | Restores view-state information from a previous page request that was saved by the SaveViewState method. (Inherited from Control.) |
![]() | MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) |
![]() | OnDataBinding | Raises the DataBinding event. (Inherited from Control.) |
![]() | OnInit | Raises the Init event. (Overrides Control.OnInit(EventArgs).) |
![]() | OnLoad | Raises the Load event. (Inherited from Control.) |
![]() | OnPreRender | Determines which role-group template to display, based on the roles of the logged-in user. (Overrides Control.OnPreRender(EventArgs).) |
![]() | OnUnload | Raises the Unload event. (Inherited from Control.) |
![]() | OnViewChanged | Raises the ViewChanged event after the LoginView control switches views. |
![]() | OnViewChanging | Raises the ViewChanging event before the LoginView control switches views. |
![]() | OpenFile | Gets a Stream used to read a file. (Inherited from Control.) |
![]() | RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) |
![]() | RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.) |
![]() | Render | Infrastructure. Renders the Web server control content to the client's browser using the specified System.Web.UI.HtmlTextWriter object. (Overrides Control.Render(HtmlTextWriter).) |
![]() | 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.) |
![]() | 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.) |
![]() | RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) |
![]() | ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) |
![]() | ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) |
![]() | ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) |
![]() | SaveControlState | This method implements SaveControlState. (Overrides Control.SaveControlState().) |
![]() | SaveViewState | Saves any server control view-state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) |
![]() | SetDesignModeState | Sets design-time data for a control. (Overrides Control.SetDesignModeState(IDictionary).) |
![]() | SetRenderMethodDelegate | Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | TrackViewState | Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the Control.ViewState property. (Inherited from Control.) |
| Name | Description | |
|---|---|---|
![]() | DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) |
![]() | 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.) |
![]() | Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) |
![]() | Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) |
![]() | PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) |
![]() | Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
![]() | ViewChanged | Occurs after the view is changed. |
![]() | ViewChanging | Occurs before the view is changed. |
| Name | Description | |
|---|---|---|
![]() | EnableDynamicData(Type) | Overloaded. Enables Dynamic Data behavior for the specified data control. (Defined by DataControlExtensions.) |
![]() | EnableDynamicData(Type, Object) | Overloaded. Enables Dynamic Data behavior for the specified data control. (Defined by DataControlExtensions.) |
![]() | EnableDynamicData(Type, IDictionary(String, Object)) | Overloaded. Enables Dynamic Data behavior for the specified data control. (Defined by DataControlExtensions.) |
![]() | FindDataSourceControl | Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.) |
![]() | FindFieldTemplate | Returns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.) |
![]() | FindMetaTable | Returns the metatable object for the containing data control. (Defined by DynamicDataExtensions.) |
![]() | GetDefaultValues | Gets the collection of the default values for the specified data control. (Defined by DynamicDataExtensions.) |
![]() | GetMetaTable | Gets the table metadata for the specified data control. (Defined by DynamicDataExtensions.) |
![]() | SetMetaTable(MetaTable) | Overloaded. Sets the table metadata for the specified data control. (Defined by DynamicDataExtensions.) |
![]() | SetMetaTable(MetaTable, IDictionary(String, Object)) | Overloaded. Sets the table metadata and default value mapping for the specified data control. (Defined by DynamicDataExtensions.) |
![]() | SetMetaTable(MetaTable, Object) | Overloaded. Sets the table metadata and default value mapping for the specified data control. (Defined by DynamicDataExtensions.) |
![]() | TryGetMetaTable | Determines whether table metadata is available. (Defined by DynamicDataExtensions.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IControlBuilderAccessor.ControlBuilder | For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor.GetDesignModeState | For a description of this member, see IControlDesignerAccessor.GetDesignModeState. (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor.SetDesignModeState | For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor.SetOwnerControl | Infrastructure. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor.UserData | For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.) |
![]() ![]() | IDataBindingsAccessor.DataBindings | For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.) |
![]() ![]() | IDataBindingsAccessor.HasDataBindings | For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.) |
![]() ![]() | IExpressionsAccessor.Expressions | For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.) |
![]() ![]() | IExpressionsAccessor.HasExpressions | For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.) |
![]() ![]() | IParserAccessor.AddParsedSubObject | For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.) |
In this topic:
Introduction
The LoginView control displays different Web site content templates (or "views") for different users, based on whether the user is authenticated and, if so, which Web site roles he or she belongs to.
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. |
The template stored in the AnonymousTemplate property is displayed to any visitor to the Web site who has not logged in. Once a user is logged in, the site displays either a template associated with one of the user's roles in the RoleGroups property or the default template specified in the LoggedInTemplate property.
The LoginView control manages switching among the various templates once you assign templates to any of the three template properties of the LoginView class:
AnonymousTemplate - Specifies the template to display to users who are not logged in to the Web site. Users who are logged in will never see this template.
LoggedInTemplate - Specifies the default template to display to users who are logged in to the Web site but do not belong to any role groups with defined templates.
RoleGroups - Specifies the template to display to logged-in users who are members of roles with defined role-group templates. Content templates are associated with particular sets of roles in RoleGroup instances.
Role-group templates are searched in the order they are defined in the source. The first matching role-group template is displayed to the user. If a user is a member of more than one role, the first role-group template that matches any of the user's roles is used. If more than one template is associated with a single role, only the first defined template is used.
The following table describes the behavior of the LoginView control when various combinations of templates are used.
LoggedIn Template Property | Anonymous Template Property | RoleGroups Property | LoginView behavior |
|---|---|---|---|
Not set | Not set | Not set | Displays no content. |
Set | Not set | Not set | Displays content only when the user is logged in. |
Not set | Set | Not set | Displays content only when the user is not logged in. |
Not set | Not set | Set | Displays the first template in the RoleGroups collection that matches one of the user's roles. If no match is found, displays no content. |
Set | Set | Not set | If the user is logged in, displays the template specified in the LoggedInTemplate property. If the user in not logged in, displays the template specified in the AnonymousTemplate property. |
Set | Set | Set | If the user is logged in, displays the first template in the RoleGroups collection that matches one of the user's roles. If no match is found, displays the template specified in the LoggedInTemplate property. If the user is not logged in, displays the template specified in the AnonymousTemplate property. |
Set | Not set | Set | If the user is logged in, displays the first template in the RoleGroups collection that matches one of the user's roles. If no match is found, displays the template specified in the LoggedInTemplate property. If the user is not logged in, nothing is displayed. |
Not set | Set | Set | If the user is logged in, displays the first template in the RoleGroups collection that matches one of the user's roles. If no match is found, nothing is displayed. If the user is not logged in, displays the template specified in the AnonymousTemplate property. |
The AnonymousTemplate and LoggedInTemplate can be used with any authentication scheme that sets the Name property of the Page object's User property. You must configure role management to use the RoleGroups property to define templates base on the user's role on the Web site. For more information, see Understanding Role Management.
The Focus method does not set the initial focus of the Web page to the LoginView control, or any of its child controls. Controls contained in the LoginView control are created after the PreRender event. To set the focus to a child control contained by the LoginView, handle the On_PreRender and call its Focus method. You can also use the ViewChanging and ViewChanged events to programmatically access the controls in the LoginView control templates.
Declarative Syntax
<asp:LoginView
EnableTheming="True|False"
EnableViewState="True|False"
ID="string"
OnDataBinding="DataBinding event handler"
OnDisposed="Disposed event handler"
OnInit="Init event handler"
OnLoad="Load event handler"
OnPreRender="PreRender event handler"
OnUnload="Unload event handler"
OnViewChanged="ViewChanged event handler"
OnViewChanging="ViewChanging event handler"
runat="server"
SkinID="string"
Visible="True|False"
>
<AnonymousTemplate>
<!-- child controls -->
</AnonymousTemplate>
<LoggedInTemplate>
<!-- child controls -->
</LoggedInTemplate>
<RoleGroups>
<asp:RoleGroup
Roles="string"
>
<ContentTemplate>
<!-- child controls -->
</ContentTemplate>
</asp:RoleGroup>
</RoleGroups>
</asp:LoginView>
| Topic | Location |
|---|---|
| How to: Display Different Information to Anonymous and Logged-in Users | Building ASP .NET Web Applications |
| How to: Display Different Information to Anonymous and Logged-in Users | Building ASP .NET Web Applications |
| Walkthrough: Creating and Using ASP.NET Master Pages in Visual Web Developer | Building ASP .NET Web Applications in Visual Studio |
| How to: Display Different Information to Anonymous and Logged In Users (Visual Studio) | Building ASP .NET Web Applications in Visual Studio |
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.

