ProfileAutoSaveEventArgs.ContinueWithProfileAutoSave Property

Definition

Namespace:

System.Web.Profile

Assembly:

System.Web.dll

Gets or sets a value indicating whether the ProfileModule will automatically save the user profile.

public:
 property bool ContinueWithProfileAutoSave { bool get(); void set(bool value); };

public bool ContinueWithProfileAutoSave { get; set; }

member this.ContinueWithProfileAutoSave : bool with get, set

Public Property ContinueWithProfileAutoSave As Boolean

Property Value

Boolean

true if the ProfileModule will automatically save the user profile; otherwise, false. The default is true.

Examples

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;
}

Public Sub Profile_ProfileAutoSaving(sender As Object, args As ProfileAutoSaveEventArgs)
  If Profile.Cart.HasChanged Then
    args.ContinueWithProfileAutoSave = True
  Else
    args.ContinueWithProfileAutoSave = False
  End If
End Sub

Remarks

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 whether you are canceling or continuing with the automatic save, as you may need to overwrite the value set by an earlier subscriber.

See also

• ASP.NET Profile Properties Overview