StartTransaction(String,String) メソッド

1 つ以上の UndoUnit アクションをグループ化する新しいトランザクションを開始するために使用します。

シンタックス

Visual Basic

'宣言
 
Public Overloads Function StartTransaction( _
   ByVal description As String, _
   ByVal detailedDescription As String _
) As UndoTransaction

C#

public UndoTransaction StartTransaction( 
   string description,
   string detailedDescription
)

パラメータ

description

トランザクションの一般記述。

detailedDescription

トランザクションの詳細記述。

戻り値の型

作成されたトランザクション。

解説

トランザクションを使用して、元に戻す/やり直し履歴内で、1 つ以上の UndoUnit インスタンスを 1 つの項目にグループ化します。StartTransaction メソッドを使用して、新しいトランザクションを開始します。トランザクションが開始していない、または全てのトランザクションが閉じている場合、RootTransaction を通して公開される、新しいルート レベルのトランザクションが作成されます。トランザクションが既に開始しており、そのため RootTransaction が非 null を返す場合、新しいトランザクションは、その UndoTransaction 内のリーフ オープン トランザクションのネスト化されたトランザクションになります。メソッドは新しく開始されたトランザクションを返します。

注: トランザクションが開いている間は Undo および Redo メソッドを呼び出すことはできませんが、元に戻す/やり直し操作の実行中にトランザクションを作成し、複数の操作を 1 つのユニットにまとめることができます。