RefactoringOperation, classe
Chaque type de refactorisation de base de données comporte une classe dérivée de RefactoringOperation. La classe RefactoringOperation gère le cycle de vie complet de l'opération de refactorisation. Une instance de cette classe existe uniquement pendant la durée de l'opération de refactorisation. La classe de base RefactoringOperation contrôle le cycle de vie réel de l'opération de refactorisation. Les méthodes de la classe dérivée sont appelées par les méthodes de la classe de base. Le RefactoringOperation sert de point de lancement pour une opération de refactorisation et présente l'interface utilisateur à l'utilisateur pour collecter les entrées nécessaires à l'opération de refactorisation. La classe de base fournit des services tels que l'interface utilisateur d'aperçu. Pour plus d'informations, consultez Créer des types ou cibles de refactorisation de base de données personnalisés.
Cette API n'est pas conforme CLS.
Hiérarchie d'héritage
System.Object
Microsoft.VisualStudio.Data.Schema.Package.Refactoring.RefactoringOperation
Espace de noms : Microsoft.VisualStudio.Data.Schema.Package.Refactoring
Assembly : Microsoft.VisualStudio.Data.Schema.Package (dans Microsoft.VisualStudio.Data.Schema.Package.dll)
Syntaxe
'Déclaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class RefactoringOperation
[CLSCompliantAttribute(false)]
public abstract class RefactoringOperation
[CLSCompliantAttribute(false)]
public ref class RefactoringOperation abstract
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type RefactoringOperation = class end
public abstract class RefactoringOperation
Le type RefactoringOperation expose les membres suivants.
Constructeurs
Nom | Description | |
---|---|---|
RefactoringOperation |
Début
Propriétés
Nom | Description | |
---|---|---|
ContributorInput | Obtient le ContributorInput initial pour ce RefactoringOperation. | |
CurrentDataSchemaModel | Obtient le DataSchemaModel pour le projet actif. | |
CurrentProject | Obtient le IDatabaseProjectNode du projet de base de données sur lequel cette opération a été appelée. | |
CurrentProjectHierarchy | Obtient le IVsUIHierarchy du projet de base de données sur lequel cette opération a été appelée. | |
GenerateRefactoringLog | Obtient ou définit une valeur qui indique si une entrée de journal est créée dans un fichier journal de refactorisation. | |
HasPreviewWindow | Obtient ou définit une valeur qui indique si la fenêtre d'aperçu standard est affichée. | |
OperationName | Obtient le nom de cette opération. | |
PreviewWindowInfo | Obtient les informations de la fenêtre d'aperçu. | |
UndoDescription | Obtient la description d'annulation qui est utilisée dans la pile des opérations d'annulation/rétablissement pour ce RefactoringOperation. |
Début
Méthodes
Nom | Description | |
---|---|---|
AddError | Ajoute une erreur de refactorisation à l'opération. | |
CancelOperation | Active les classes dérivées de RefactoringOperation pour annuler l'opération en fonction de l'entrée d'utilisateur. | |
DoOperation | La méthode DoOperation démarre le processus de refactorisation entier. | |
Equals | Détermine si l'Object spécifié est égal à l'Object en cours. (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.) | |
GetRefactoringLogProperties | En cas de substitution, cette méthode retourne les paires (nom de propriété, valeur de propriété) de toutes les propriétés que cette opération écrira dans le journal de refactorisation. | |
GetType | Obtient le Type de l'instance actuelle. (Hérité de Object.) | |
MemberwiseClone | Crée une copie superficielle de l'objet Object actif. (Hérité de Object.) | |
OnError | Affiche un message d'erreur. | |
OnGetContributorInput | Collecte toutes les entrées nécessaires de l'utilisateur et retourne la classe ContributorInput appropriée, qui est ensuite traitée par tous les collaborateurs compatibles. | |
ToString | Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.) | |
WriteOperationLogData | Écrit toutes les données de l'opération dans un fichier journal de refactorisation. |
Début
Champs
Nom | Description | |
---|---|---|
AppliedChanges | Déclenché après l'application des modifications. | |
ApplyingChanges | Déclenché avant l'application des modifications. |
Début
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.
Voir aussi
Référence
Microsoft.VisualStudio.Data.Schema.Package.Refactoring, espace de noms