Page.User Property (System.Web.UI)

User Property

Switch on low bandwidth view

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

Page..::.User Property

Gets information about the user making the page request.

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

Syntax

Visual Basic (Declaration)

<BrowsableAttribute(False)> _
Public ReadOnly Property User As IPrincipal

Visual Basic (Usage)

Dim instance As Page
Dim value As IPrincipal

value = instance.User

[BrowsableAttribute(false)]
public IPrincipal User { get; }

Visual C++

[BrowsableAttribute(false)]
public:
property IPrincipal^ User {
    IPrincipal^ get ();
}

JScript

public function get User () : IPrincipal

Property Value

Type: System.Security.Principal..::.IPrincipal
An IPrincipal that represents the user making the page request.

Remarks

An IPrincipal object represents the security context of the user on whose behalf the code is running, including that user's identity and any roles to which they belong.

This property uses the HttpContext object's User property to determine where the request originates.

Examples

The following code example uses the User property to access authentication and identity information for the current user. If the user is not authenticated, it redirects them to a login page.

Visual Basic

Sub UserInfo(sender As Object, e As EventArgs)         
   Dim myPrincipal As IPrincipal = Me.User
   Dim tableString As  String 
        tableString = "<table border=""1""><tr><td>Name</td><td>"
   tableString &= Server.HtmlEncode(myPrincipal.Identity.Name) + "</td></tr><tr><td>"
   tableString &= "AuthenticationType</td><td>" + myPrincipal.Identity.AuthenticationType
   tableString &= "</td></tr><tr><td>IsAuthenticated</td><td>"
   tableString &= myPrincipal.Identity.IsAuthenticated.ToString() + "</td></tr></table>"
   Response.Write(tableString)
End Sub

void UserInfo(Object sender, EventArgs e) 
{
   IPrincipal myPrincipal = this.User;
   String tableString = "<table border=\"1\"><tr><td>Name</td><td>";
   tableString += Server.HtmlEncode(myPrincipal.Identity.Name) + "</td></tr><tr><td>";
   tableString += "AuthenticationType</td><td>" + myPrincipal.Identity.AuthenticationType;
   tableString += "</td></tr><tr><td>IsAuthenticated</td><td>";
   tableString += myPrincipal.Identity.IsAuthenticated + "</td></tr></table>";
   Response.Write(tableString);
}

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

Page Class

Page Members

System.Web.UI Namespace

HttpContext

IPrincipal