OleUndoEngine, classe

Article
08/01/2012

Fournit une implémentation par défaut de gestion de phase de restauration pour des générateurs.

Hiérarchie d'héritage

System.Object
System.ComponentModel.Design.UndoEngine
Microsoft.VisualStudio.Shell.Design.OleUndoEngine

Espace de noms : Microsoft.VisualStudio.Shell.Design
Assembly : Microsoft.VisualStudio.Shell.Design (dans Microsoft.VisualStudio.Shell.Design.dll)

Syntaxe

'Déclaration
Public Class OleUndoEngine _
    Inherits UndoEngine _
    Implements IVsLinkedUndoClient

public class OleUndoEngine : UndoEngine, 
    IVsLinkedUndoClient

Le type OleUndoEngine expose les membres suivants.

Constructeurs

	Nom	Description
	OleUndoEngine	Initialise une nouvelle instance d'OleUndoEngine.

Début

Propriétés

	Nom	Description
	Enabled	Active ou désactive UndoEngine. (Hérité de UndoEngine.)
	UndoInProgress	Indique si une opération d'annulation est en cours. (Hérité de UndoEngine.)

Début

Méthodes

	Nom	Description
	AddUndoUnit	Ajoute l'unité undo au gestionnaire d'unité undo. (Substitue UndoEngine.AddUndoUnit(UndoEngine.UndoUnit).)
	CreateUndoUnit	Crée une nouvelle unité undo. (Substitue UndoEngine.CreateUndoUnit(String, Boolean).)
	DiscardUndoUnit	Ferme cette unité si c'est une unité undo parente. (Substitue UndoEngine.DiscardUndoUnit(UndoEngine.UndoUnit).)
	Dispose()	Libère toutes les ressources utilisées par UndoEngine. (Hérité de UndoEngine.)
	Dispose(Boolean)	Supprime les ressources de cet objet. (Substitue UndoEngine.Dispose(Boolean).)
	Equals	Détermine si l'objet Object spécifié est égal à l'objet Object actuel. (Hérité de Object.)
	Finalize	Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
	GetHashCode	Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
	GetRequiredService	Obtient le service demandé. (Hérité de UndoEngine.)
	GetService	Obtient le service demandé. (Hérité de UndoEngine.)
	GetType	Obtient le Type de l'instance actuelle. (Hérité de Object.)
	MemberwiseClone	Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
	OnUndoing	Déclenche l'événement Undoing. (Hérité de UndoEngine.)
	OnUndone	Déclenche l'événement Undone. (Hérité de UndoEngine.)
	ToString	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)

Début

Événements

	Nom	Description
	Undoing	Se produit immédiatement avant l'exécution d'une opération d'annulation. (Hérité de UndoEngine.)
	Undone	Se produit immédiatement après l'exécution d'une opération d'annulation. (Hérité de UndoEngine.)

Début

Implémentations d'interface explicite

	Nom	Description
	IVsLinkedUndoClient.OnInterveningUnitBlockingLinkedUndo	Indique que le gestionnaire de phase de restauration se bloque un autre gestionnaire de phase de restauration d'exécuter une action liée.

Début

Remarques

La classe d'OleUndoEngine fournit une implémentation par défaut d'UndoEngine et IVsLinkedUndoClient interfaces utilisé pour gérer les opérations d'annulation, qui permettent à des utilisateurs pour inverser leurs modifications récentes en modifiant un élément de code.

[!REMARQUE]

En général, les générateurs implémentés sous Visual Studio et le .NET Framework sont selon Control et ont la prise en charge de phase de restauration automatiquement fournie par l'environnement.

Les générateurs doivent implémenter leur propre gestion de phase de restauration si l'un ou l'autre :

Le générateur utilise une interface utilisateur graphique, connue sous le nom de ViewAdapter, autre que celle fournie par Control.

Cela requerra le Registre d'ViewAdapter avec Visual Studio à l'aide de ProvideViewAdapterAttribute.

Un exemple de cela peut créer un produit avec une interface graphique basée sur le WEB de création plutôt qu'une interface graphique basée par .NET Framework.
Les générateurs n'utilisent pas le modèle de génération du code de Visual Studio fourni dans l'espace de nom d'System.CodeDom.

La classe d'OleUndoEngine prend en charge de façon transparente les unités undo enfantes, car elle utilise les unités undo personnalisées (sections atomiques de code qui peuvent être supprimées dans une opération d'annulation) UndoEngine.UndoUnit, qui implémentent entièrement IOleUndoUnit et IOleParentUndoUnit.

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.