This documentation is archived and is not being maintained.

ProfileEventArgs Class

Provides data for the Personalize event of the ProfileModule class.

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

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

public sealed class ProfileEventArgs : EventArgs

The ProfileEventArgs type exposes the following members.

  NameDescription
Public methodProfileEventArgsCreates an instance of the ProfileEventArgs class.
Top

  NameDescription
Public propertyContextGets the HttpContext for the current request.
Public propertyProfileGets or sets the user profile for the current request.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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