Page.User Property

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets information about the user making the page request.

public:
 property System::Security::Principal::IPrincipal ^ User { System::Security::Principal::IPrincipal ^ get(); };

[System.ComponentModel.Browsable(false)]
public System.Security.Principal.IPrincipal User { get; }

[<System.ComponentModel.Browsable(false)>]
member this.User : System.Security.Principal.IPrincipal

Public ReadOnly Property User As IPrincipal

Property Value

IPrincipal

An IPrincipal that represents the user making the page request.

Attributes: BrowsableAttribute

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.

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);
}

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

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.

Applies to

Product	Versions
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via