DataObjectChangeEvents.EndEventGroup メソッド
StartEventGroup のメソッドを呼び出すことにより開始イベントのグループを終了します。
名前空間: Microsoft.VisualStudio.Data
アセンブリ: Microsoft.VisualStudio.Data (Microsoft.VisualStudio.Data.dll 内)
構文
'宣言
Public MustOverride Sub EndEventGroup ( _
groupId As Integer _
)
public abstract void EndEventGroup(
int groupId
)
public:
virtual void EndEventGroup(
int groupId
) abstract
abstract EndEventGroup :
groupId:int -> unit
public abstract function EndEventGroup(
groupId : int
)
パラメーター
- groupId
型 : System.Int32
指定したイベントのグループの ID 番号。
例外
| 例外 | 条件 |
|---|---|
| ArgumentOutOfRangeException | groupId のパラメーターは、以下のまたは割り当てられているグループの数より大きい。 |
| ArgumentException | groupId パラメーターが無効です。 |
解説
場合によっては、複数の変更イベントには、グループ化される必要があるため、分割不可能なトランザクションとして扱われます。
通常、イベントのリスナーはイベントにイベント通知のグループのグループ内で発生するイベント キューの構築によって動作します; また、後でのみイベント通知のグループが終了、トランザクション的な方法で処理されるイベントである (つまり、すべてのイベントが適用されます。またイベントにも適用されません)。
通知に、イベントのグループは、イベントのグループ階層構造、グループ ID で識別されるそれぞれの指定を有効にすることによって実装されます。通知者は StartEventGroupグループの ID を返すを呼び出すことで始まります。次に、通知 RaiseObjectAdded者は、RaiseObjectChangedとグループ ID を渡す RaiseObjectRemoved のメソッドを呼び出します。(必要に応じて、通知者は、現在のグループ ID の StartEventGroup をもう一度呼び出すことによって、埋め込みイベントのグループを開始できます)。
最後に通知者は、グループ ID を使用して EndEventGroupを呼び出します。一度最上位のグループ (ゼロのパラメーターの StartEventGroup の呼び出しで作成されたグループ) を一つのイベントのグループのリスナーに、そのグループに対して発生するすべてのイベントがディスパッチ終了します。
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。