HttpContext.User Property (System.Web)

User Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

HttpContext..::.User Property

Gets or sets security information for the current HTTP request.

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

Syntax

Visual Basic (Declaration)

Public Property User As IPrincipal

Visual Basic (Usage)

Dim instance As HttpContext
Dim value As IPrincipal

value = instance.User

instance.User = value

public IPrincipal User { get; set; }

Visual C++

public:
property IPrincipal^ User {
    IPrincipal^ get ();
    void set (IPrincipal^ value);
}

JScript

public function get User () : IPrincipal
public function set User (value : IPrincipal)

Property Value

Type: System.Security.Principal..::.IPrincipal
Security information for the current HTTP request.

Remarks

Setting the User property requires the ControlPrincipal flag to be set.

The User property provides programmatic access to the properties and methods of the IPrincipal interface. Because ASP.NET pages contain a default reference to the System.Web namespace (which contains the HttpContext class), you can reference the members of HttpContext on an .aspx page without using the fully qualified class reference to HttpContext. For example, you can use User.Identity.Name to get the name of the user on whose behalf the current process is running. However, if you want to use the members of IPrincipal from an ASP.NET code-behind module, you must include a reference to the System.Web namespace in the module and a fully qualified reference to both the currently active request/response context and the class in System.Web that you want to use. For example, in a code-behind page you must specify the fully qualified name HttpContext.Current.User.Identity.Name.

Topic	Location
How to: Implement Passport Authentication in ASP.NET Applications	Building ASP .NET Web Applications
How to: Implement Passport Authentication in ASP.NET Applications	Building ASP .NET Web Applications
How to: Implement Passport Authentication in ASP.NET Applications	Building ASP .NET Web Applications in Visual Studio

Examples

The following example shows how to access properties about the current user through the User property. Those properties are used to set the title of the Web page.

Visual Basic

Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
    If (User.Identity.IsAuthenticated) Then
        Page.Title = "Home page for " + User.Identity.Name
    Else
        Page.Title = "Home page for guest user."
    End If
End Sub

protected void Page_Load(object sender, EventArgs e)
{
    if (User.Identity.IsAuthenticated)
    {
        Page.Title = "Home page for " + User.Identity.Name;
    }
    else
    {
        Page.Title = "Home page for guest user.";
    }
}

.NET Framework Security

SecurityPermission
for setting the User property. Demand value: Demand. Permission value: ControlPrincipal

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, 1.1, 1.0

Reference

HttpContext Class

HttpContext Members

System.Web Namespace