LoginName Class (System.Web.UI.WebControls)

MSDN Library
.NET Development
.NET Framework 3.5
.NET Framework Class Library
System.Web.UI.WebControls Namespace

LoginName Class

LoginName Members
LoginName Constructor
LoginName Methods
LoginName Properties
LoginName Events

Related Links

LoginName Class
This page is specific to:.NET Framework Version:2.0 3.03.54.0

.NET Framework Class Library

LoginName Class

Displays the value of the System.Web.UI.Page.User.Identity.Name property.

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

Syntax

C++

JScript

Copy to Clipboard Print

'Usage

Dim instance As LoginName

'Declaration

<BindableAttribute(False)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class LoginName _
    Inherits WebControl

ASP.NET

<asp:LoginName />

Remarks

By default, the LoginName control displays the name contained in the User property of the Page class. If the System.Web.UI.Page.User.Identity.Name property is empty, the control is not rendered.

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.

To change the text displayed by the LoginName control, set the FormatString property.

Note:
The LoginName control cannot be used outside the <form> tag on a Web page. Specifically, the LoginName cannot be used to put the user's name in the title of a page.

Accessibility

The markup rendered by default for this control might not conform to accessibility standards such as the Web Content Accessibility Guidelines 1.0 (WCAG) priority 1 guidelines. For details about accessibility support for this control, see ASP.NET Controls and Accessibility.

Topic	Location
How to: Display the Name of the Current User	Building ASP .NET Web Applications
How to: Display the Name of the Current User	Building ASP .NET Web Applications
How to: Display the Name of the Current User	Building ASP .NET Web Applications in Visual Studio
How to: Display the Name of the Current User	Building ASP .NET Web Applications in Visual Studio
Walkthrough: Managing Web Site Users with Roles	Building ASP .NET Web Applications in Visual Studio
Walkthrough: Managing Web Site Users with Roles	Building Applications with Visual Web Developer
Walkthrough: Managing Web Site Users with Roles	Building ASP .NET Web Applications in Visual Studio

Examples

The following code example shows how to use the LoginName class on a page. Clicking the button changes the display format.

C++

JScript

Copy to Clipboard Print

<%@ Page Language="VB" 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">

    Sub Button1_Click(sender As Object, e As EventArgs) 
        LoginName1.FormatString = "Welcome to our Web site, {0}"
         Button1.Visible = false
    End Sub

</script>
<html  >
<head>
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
        <p>
            <asp:LoginName id="LoginName1" runat="server" 
               FormatString="Welcome, {0}" />
        </p>
        <p>
            <asp:Button id="Button1" onclick="Button1_Click" runat="server" 
               Text="Change Format" />
        </p>
    </form>
</body>
</html>

.NET Framework Security

AspNetHostingPermission
for operating in a hosted environment. Demand value: LinkDemand; Permission value: Minimal.
AspNetHostingPermission
for operating in a hosted environment. Demand value: InheritanceDemand; Permission value: Minimal.

Inheritance Hierarchy

System..::.Object
  System.Web.UI..::.Control
    System.Web.UI.WebControls..::.WebControl
      System.Web.UI.WebControls..::.LoginName

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

LoginName Members

System.Web.UI.WebControls Namespace

Other Resources

ASP.NET Login Controls Overview

Community Content

page will still compile and run

Added by:PTIHT

"The LoginName control cannot be used outside the "><form> tag on a Web page."

see somebody point out that the page will still compile and run.