ProfileEventArgs Class

ProfileEventArgs Class

 

Provides data for the Personalize event of the ProfileModule class.

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

System.Object
  System.EventArgs
    System.Web.Profile.ProfileEventArgs

public sealed class ProfileEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodProfileEventArgs(HttpContext)

Creates an instance of the ProfileEventArgs class.

NameDescription
System_CAPS_pubpropertyContext

Gets the HttpContext for the current request.

System_CAPS_pubpropertyProfile

Gets or sets the user profile for the current request.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

You can use the ProfileEventArgs class during the Personalize event to specify a custom user profile. If, when the Personalize event completes, the ProfileEventArgs parameter of the ProfileEventHandler has its Profile property set to a value that’s not null, then the ProfileModule uses the value of the Profile property in the current HttpContext.

The following code example shows the Personalize event declared in the Global.asax file for an application. The event code loads a user profile based on role membership.

public void Profile_Personalize(object sender, ProfileEventArgs args)
{
  ProfileCommon userProfile;

  if (User == null) { return; }

  userProfile = (ProfileCommon)ProfileBase.Create(User.Identity.Name);

  if (User.IsInRole("Administrators"))
    userProfile = userProfile.GetProfile("Administrator");
  else
    if (User.IsInRole("Users"))
      userProfile = userProfile.GetProfile("User");
    else
      userProfile = userProfile.GetProfile("Guest");

  if (userProfile != null)
    args.Profile = userProfile;
}

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft