UserName Property
Collapse the table of content
Expand the table of content

CreatingCookieEventArgs.UserName Property

 

Gets the name for the user.

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

public string UserName { get; }

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.

void AuthenticationService_CreatingCookie(object sender, 
    System.Web.ApplicationServices.CreatingCookieEventArgs e)
{
    FormsAuthenticationTicket ticket = new
          FormsAuthenticationTicket
            (1,
             e.UserName,
             DateTime.Now,
             DateTime.Now.AddMinutes(30),
             e.IsPersistent,
             e.CustomCredential,
             FormsAuthentication.FormsCookiePath);

    string encryptedTicket =
         FormsAuthentication.Encrypt(ticket);

    HttpCookie cookie = new HttpCookie
         (FormsAuthentication.FormsCookieName,
          encryptedTicket);
    cookie.Expires = DateTime.Now.AddMinutes(30);

    HttpContext.Current.Response.Cookies.Add(cookie);
    e.CookieIsSet = true;
}

.NET Framework
Available since 3.5
Return to top
Show:
© 2016 Microsoft