CreatingCookieEventArgs.UserName Property

 

Gets the name for the user.

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

Public ReadOnly Property UserName As String

Property Value

Type: System.String

The name that is provided by the user for authentication.

You use the UserName property to retrieve the authentication name when you set custom values in the authentication ticket. Typically, you set the Name property of the FormsAuthenticationTicket object to the UserName value.

The following example shows an event handler for the CreatingCookie event. The handler retrieves user values from the CreatingCookieEventArgs object to customize the authentication cookie. The Name property is set to the values of the UserName property.

Sub AuthenticationService_CreatingCookie(ByVal sender As Object, _
                 ByVal e As System.Web.ApplicationServices.CreatingCookieEventArgs)
    Dim ticket As FormsAuthenticationTicket = New _
       FormsAuthenticationTicket _
        (1, _
         e.Username, _
         DateTime.Now, _
         DateTime.Now.AddMinutes(30), _
         e.IsPersistent, _
         e.CustomCredential, _
         FormsAuthentication.FormsCookiePath)

    Dim encryptedTicket As String = FormsAuthentication.Encrypt(ticket)

    Dim cookie As HttpCookie = New _
        HttpCookie(FormsAuthentication.FormsCookieName, encryptedTicket)
    cookie.Expires = DateTime.Now.AddMinutes(30)

    HttpContext.Current.Response.Cookies.Add(cookie)
    e.CookieIsSet = True
End Sub

.NET Framework
Available since 3.5
Return to top
Show: