UndoEngine

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

UndoEngine イベント

パブリック イベント

	名前	説明
	Undoing	元に戻す操作が実行される直前に発生します。
	Undone	元に戻す操作が実行された直後に発生します。

参照

関連項目

UndoEngine クラス
System.ComponentModel.Design 名前空間
UndoEngine.UndoUnit
ComponentSerializationService
IDesignerHost インターフェイス
IComponentChangeService インターフェイス
IServiceProvider

UndoEngine クラス

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

標準の元に戻したりやり直したりする機能を指定します。

名前空間: System.ComponentModel.Design
アセンブリ: System.Design (system.design.dll 内)
構文

Visual Basic (宣言)

Public MustInherit Class
 UndoEngine
    Implements IDisposable

Visual Basic (使用法)

Dim instance As UndoEngine

C#

public abstract class UndoEngine : IDisposable

C++

public ref class UndoEngine abstract : IDisposable

J#

public abstract class UndoEngine implements
 IDisposable

JScript

public abstract class UndoEngine implements
 IDisposable

解説

UndoEngine 抽象クラスは、元に戻す機能の既定の実装を提供します。取り消し単位は、元に戻すことのできる処理の単位を表します。この単位はスタックに追加されるため、ユーザーはこのスタックをウォークして各操作を元に戻すことができます。取り消し単位は通常、切り替えを行うように設計されています。つまり、元に戻す操作を 2 回呼び出すと、アプリケーションが最初の状態に戻ります。

UndoEngine クラスは、デザイナ内で実行されているオブジェクトの次の特性を利用します。

• すべての関連オブジェクトは、デザイナ ローダーによって何らかの形式に永続化できます。

• すべてのオブジェクトは、プロパティが変更されると、プロパティ変更通知を発生させます。

• IDesignerHost はトランザクションの概念を提供するため、複数の小さな操作にまたがる元に戻す操作を生成するために使用できます。

これらの特性を使用して、UndoEngine は、必要な任意の取り消し単位を自動的に生成できます。UndoEngine は変更通知を監視して取り消し単位を作成し、単位自体はシリアル化されたオブジェクトの状態で構成されています。UndoEngine の作成時に使用できるサービスを次の表に示します。

ComponentSerializationService

変更前と変更後の、コンポーネントのプロパティ値とオブジェクト値を保存します。

IComponentChangeService

コンポーネントに加えられた変更をアンドゥ エンジンに通知します。

IDesignerHost

トランザクションの追跡に使用されます。

アンドゥ エンジンは、トランザクションを追跡し、トランザクションを含む単一の取り消し単位を作成します。このため、アンドゥ エンジンは、元に戻すことのできる操作の存続期間を制御できます。また、トランザクションには名前を付けることができるため、元に戻すことのできる操作は、現在のトランザクションから名前を継承します。使用できるトランザクションがないときに変更が報告された場合、アンドゥ エンジンは、変更の種類に基づいて元に戻す操作の名前を作成します ("Change property 'Text'" など)。

継承階層

System.Object
  System.ComponentModel.Design.UndoEngine

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
UndoEngine メンバ
System.ComponentModel.Design 名前空間
UndoEngine.UndoUnit
ComponentSerializationService
IDesignerHost インターフェイス
IComponentChangeService インターフェイス
IServiceProvider

UndoEngine コンストラクタ

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

UndoEngine クラスの新しいインスタンスを初期化します。

名前空間: System.ComponentModel.Design
アセンブリ: System.Design (system.design.dll 内)
構文

Visual Basic (宣言)

Protected Sub New ( _
    provider As IServiceProvider _
)

Visual Basic (使用法)

Dim provider As IServiceProvider

Dim instance As New UndoEngine(provider)

C#

protected UndoEngine (
    IServiceProvider provider
)

C++

protected:
UndoEngine (
    IServiceProvider^ provider
)

J#

protected UndoEngine (
    IServiceProvider provider
)

JScript

protected function UndoEngine (
    provider : IServiceProvider
)

パラメータ

provider

親サービス プロバイダ。

例外

例外の種類	条件
ArgumentNullException	provider が null 参照 (Visual Basic では Nothing) です。
NotSupportedException	必要なサービスが見つかりません。必要なサービスについては、UndoEngine のトピックを参照してください。このサービスが削除されている場合は、必ず代わりのサービスを提供します。

解説

UndoEngine を使用するときは、provider パラメータの複数のサービスを必要とします。

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
UndoEngine クラス
UndoEngine メンバ
System.ComponentModel.Design 名前空間
UndoEngine.UndoUnit
IDesignerHost インターフェイス
IServiceProvider

UndoEngine プロパティ

パブリック プロパティ

	名前	説明
	Enabled	UndoEngine を有効または無効にします。
	UndoInProgress	元に戻す操作が実行中であることを示します。

参照

関連項目

UndoEngine クラス
System.ComponentModel.Design 名前空間
UndoEngine.UndoUnit
ComponentSerializationService
IDesignerHost インターフェイス
IComponentChangeService インターフェイス
IServiceProvider

UndoEngine メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Dispose	オーバーロードされます。 UndoEngine によって使用されているリソースを解放します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	AddUndoUnit	UndoEngine.UndoUnit を、元に戻すスタックに追加します。
	CreateUndoUnit	新しい UndoEngine.UndoUnit を作成します。
	DiscardUndoUnit	UndoEngine.UndoUnit を破棄します。
	Dispose	オーバーロードされます。 UndoEngine によって使用されているリソースを解放します。
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	GetRequiredService	要求したサービスを取得します。
	GetService	要求したサービスを取得します。
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	OnUndoing	Undoing イベントを発生させます。
	OnUndone	Undone イベントを発生させます。

参照

関連項目

UndoEngine クラス
System.ComponentModel.Design 名前空間
UndoEngine.UndoUnit
ComponentSerializationService
IDesignerHost インターフェイス
IComponentChangeService インターフェイス
IServiceProvider

UndoEngine メンバ

標準の元に戻したりやり直したりする機能を指定します。

UndoEngine データ型で公開されるメンバを以下の表に示します。

プロテクト コンストラクタ

	名前	説明
	UndoEngine	UndoEngine クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	Enabled	UndoEngine を有効または無効にします。
	UndoInProgress	元に戻す操作が実行中であることを示します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Dispose	オーバーロードされます。 UndoEngine によって使用されているリソースを解放します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	AddUndoUnit	UndoEngine.UndoUnit を、元に戻すスタックに追加します。
	CreateUndoUnit	新しい UndoEngine.UndoUnit を作成します。
	DiscardUndoUnit	UndoEngine.UndoUnit を破棄します。
	Dispose	オーバーロードされます。 UndoEngine によって使用されているリソースを解放します。
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	GetRequiredService	要求したサービスを取得します。
	GetService	要求したサービスを取得します。
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	OnUndoing	Undoing イベントを発生させます。
	OnUndone	Undone イベントを発生させます。

パブリック イベント

	名前	説明
	Undoing	元に戻す操作が実行される直前に発生します。
	Undone	元に戻す操作が実行された直後に発生します。

参照

関連項目

UndoEngine クラス
System.ComponentModel.Design 名前空間
UndoEngine.UndoUnit
ComponentSerializationService
IDesignerHost インターフェイス
IComponentChangeService インターフェイス
IServiceProvider