ProfileAutoSaveEventArgs クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

ProfileAutoSaveEventArgs クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

ProfileModule クラスの ProfileAutoSaving イベントのデータを提供します。

名前空間: System.Web.Profile
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 ProfileAutoSaveEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As ProfileAutoSaveEventArgs

public sealed class ProfileAutoSaveEventArgs
 : EventArgs

C++

public ref class ProfileAutoSaveEventArgs sealed
 : public EventArgs

public final class ProfileAutoSaveEventArgs
 extends EventArgs

JScript

public final class ProfileAutoSaveEventArgs
 extends EventArgs

解説

ProfileAutoSaveEventHandler デリゲートは、ProfileModule クラスの ProfileAutoSaving イベントに対して定義されています。ASP.NET アプリケーションの Global.asax ファイルの ProfileModule クラスの ProfileAutoSaving イベントには、このトピックの例に示されている方法によってアクセスできます。ProfileAutoSaving イベントは、ProfileManager.AutomaticSaveEnabled プロパティが true の場合、ページ実行の終了時に発生します。

Save メソッドは、プリミティブ型、文字列、または DateTime オブジェクトで構成されたプロパティ値が変更されたかどうかを、ユーザープロファイル内の各 SettingsPropertyValue の IsDirty プロパティ値をチェックすることで、自動的に判断します。Save メソッドは、カスタムクラスが変更されたかどうかを明示的に判断することはできません。カスタムオブジェクトが変更されたかどうかは、ProfileAutoSaving イベントを使用して判断できます。その上で、オブジェクトが変更されている場合は自動保存を続行し、変更されていない場合は自動保存をキャンセルできます。

プロファイルの自動保存処理をキャンセルする場合は、ProfileAutoSaving イベント内の ContinueWithProfileAutoSave プロパティを false に設定します。それ以外の場合は、ContinueWithProfileAutoSave プロパティを true に設定します。

ProfileAutoSaving イベントに対しては複数のサブスクライバが存在する場合があります。ProfileModule は、ContinueWithProfileAutoSave プロパティに最後に設定された値を使用します。したがって、ProfileAutoSaving イベント内では、自動保存をキャンセルするか続行するかにかかわらず ContinueWithProfileAutoSave プロパティを明示的に設定して、以前のサブスクライバの設定した値が上書きされるようにすることをお勧めします。

使用例

ASP.NET アプリケーションの Global.asax ファイルに含まれる ProfileAutoSaving イベントを次のコード例に示します。

Visual Basic

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

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