SALES: 1-800-867-1380
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ProfileAutoSaveEventArgs Class

Provides data for the ProfileAutoSaving event of the ProfileModule class.

System.Object
  System.EventArgs
    System.Web.Profile.ProfileAutoSaveEventArgs

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

public sealed class ProfileAutoSaveEventArgs : EventArgs

The ProfileAutoSaveEventArgs type exposes the following members.

  NameDescription
Public methodProfileAutoSaveEventArgsCreates an instance of the ProfileAutoSaveEventArgs class.
Top

  NameDescription
Public propertyContextGets the HttpContext for the current request.
Public propertyContinueWithProfileAutoSaveGets or sets a value indicating whether the ProfileModule will automatically save the user profile.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The ProfileAutoSaveEventHandler delegate is defined for the ProfileAutoSaving event of the ProfileModule class. You can access the ProfileAutoSaving event of the ProfileModule class in the Global.asax file for your ASP.NET application, as shown in the example for this topic. The ProfileAutoSaving event is raised at the end of page execution if the ProfileManager.AutomaticSaveEnabled property is true.

The Save method automatically determines whether properties that are made up of primitive types, strings, or DateTime objects have been changed, by checking the IsDirty property value for each SettingsPropertyValue in the user profile. The Save method cannot explicitly determine whether a custom class has changed. You can use the ProfileAutoSaving event to determine whether a custom object has been modified and then either continue with the automatic save if the object has been modified or cancel the automatic save if the object has not been modified.

To cancel the automatic profile save operation, set the ContinueWithProfileAutoSave property to false in the ProfileAutoSaving event; otherwise, set the ContinueWithProfileAutoSave property to true.

There may be multiple subscribers to the ProfileAutoSaving event. The ProfileModule will use the last value that the ContinueWithProfileAutoSave property is set to. As a result, it is recommended that you explicitly set the ContinueWithProfileAutoSave property in the ProfileAutoSaving event regardless of whether you are canceling or continuing with the automatic save, as you may need to overwrite the value set by an earlier subscriber.

The following code example shows the ProfileAutoSaving event included in the Global.asax file for an ASP.NET application.

public void Profile_ProfileAutoSaving(object sender, ProfileAutoSaveEventArgs args)
{
  if (Profile.Cart.HasChanged)
    args.ContinueWithProfileAutoSave = true;
  else
    args.ContinueWithProfileAutoSave = false;
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft