バージョン

カスタム UndoUnit を作成するためのメソッドおよびプロパティ参照

トピックの概要

目的

このトピックは、Infragistics Undo/Redo Framework™ でカスタム UndoUnit を作成することに関連する使用可能なメソッドおよびプロパティをリストします。

前提条件

以下の表は、このトピックを理解するための前提条件として必要なトピックを示しています。

トピック 目的

このトピックは、UndoUnit クラスの派生クラスと重要なプロパティおよびメソッドをいくつかリストします。

このトピックの内容

このトピックは以下のセクションからなります。

カスタム UndoUnit を作成するためのメソッドおよびプロパティ参照

はじめに

UndoUnit は変更を元に戻す/やり直すために使用される抽象基本クラスです。

特定のタイプの変更の元に戻す/やり直しをサポートする必要がある場合、カスタム UndoUnit を作成する必要があります。このクラスは以下にリストされたいくつかの抽象メンバーを公開します。

Methods and Properties Reference for Creating Custom UndoUnit 1.png

メソッド参照の概要

以下の表で、UndoUnit クラスによって公開されるメソッドの目的と機能を簡単に説明します。

メソッド 解説

Execute

変更を元に戻す/やり直す操作を実行するのに使用されます。

このメソッドは UndoExecuteContext オブジェクトをパラメーターとして取得します。このパラメーターは以下に関する情報を提供します:

  • 実行される操作のタイプ (たとえば - Undo、Redo、Rollback)

  • 操作が実行される UndoManager への参照。

Note
注:

元に戻す/やり直し操作の間、オブジェクトは元に戻す/やり直しスタックから削除されますが、代替えのスタックに自動的に置かれません。

UndoUnit によって行われた変更は、AddChange メソッドを起動することにより (ヘルパー メソッドにより直接的または間接的に)、操作が元に戻す/やり直しスタックに追加されることが前提となります。

操作されるオブジェクトがこれを実行しない場合、カスタム UndoUnit が自分でこれを処理できます。

変更のタイプの文字列説明を返します。

このメソッドは以下の 2 つのパラメーターを取ります。

  • UndoHistoryItemType – どの履歴から説明が求められるのかを示す

  • 詳細な説明が必要かどうかを示すブール値。

Merge

UndoUnit を結合するためのカスタム サポートを提供するために使用されます。

プロパティ参照の概要

以下の表で、UndoUnit クラスによって公開されるプロパティの目的と機能を簡単に説明します。

プロパティ 解説

UndoUnit によって影響を受けるオブジェクトを識別します。

これは、メソッド ForEach または RemoveAll が使用されるときに主に情報のために使用される読み取り専用プロパティです。

関連コンテンツ

トピック

このトピックについては、以下のトピックも参照してください。

トピック 目的

このトピックは、UndoUnit 派生クラス オブジェクトを元に戻す履歴に追加するために使用可能なメソッドをリストします。

このトピックは、UndoUnit インスタンスを元に戻す/やり直し履歴から削除するために使用可能なメソッドをリストします。

このトピックは、UndoManager インスタンスに特定のオブジェクトを登録/登録解除するメソッドをリストします。

このトピックは、元に戻す/やり直し操作を実行するために使用可能なメソッドをリストします。

このトピックは、元に戻す/やり直しトランザクションを実行するための使用可能なメソッドおよびプロパティをリストします。

このトピックは、元に戻す/やり直し操作の結合に関係する使用可能なメソッドおよびプロパティをリストします。

このトピックは、履歴に元に戻す/やり直し操作を保存することを中断および再開するために使用可能なメソッドをリストします。