Microsoft.VisualStudio.Data.Schema.Package.Refactoring Namespace

  • Article

This namespace contains base classes that you can use to create your own database refactoring types and targets. For more information, see Create Custom Database Refactoring Types or Targets.

Classes

  Class Description
Public class ApplyChangesEventArgs Provides information to PreApply and PostApply methods so that RefactoringContributor instances and RefactoringOperation instances can perform actions. Input includes the change proposals that the user wants to apply. For more information, see Create Custom Database Refactoring Types or Targets.
Public class ChangeProposal Abstract base class of all kinds of change proposals for database refactoring operations. For more information, see Create Custom Database Refactoring Types or Targets.
Public class ContributorInput Represents the data input to each refactoring contributor. For each contributor type, a derived ContributorInput class will be created. Each ContributorInput has an associated RefactoringOperation. The refactoring operation class sets this property when it creates the initial ContributorInput. Then the refactoring manager passes this property to any ContributorInput instances that handle side effects. For more information, see Create Custom Database Refactoring Types or Targets.
Public class FileChange Represents changes for one file. Those changes can be from different refactoring contributors and can be from different refactoring preview groups. After the refactoring contributor manager returns a list of ChangeProposal, RefactoringOperation groups those changes to a list of FileChange. The refactoring operation uses this list of FileChange to apply change to each file. The refactoring operation also converts this list to a list of PreviewChangesNode, and displays the changes in the preview dialog box. For more information, see Create Custom Database Refactoring Types or Targets.
Public class PreviewWindowInfo This class contains all preview data for a RefactoringOperation. The preview dialog box uses the information in this class to populate the dialog box. For more information, see Create Custom Database Refactoring Types or Targets.
Public class RefactoringCommand Abstract base class for all refactoring commands that are available in database projects. For more information, see Create Custom Database Refactoring Types or Targets.
Public class RefactoringContributor The base class from which all RefactoringContributor classes derive. For more information, see Create Custom Database Refactoring Types or Targets.
Public class RefactoringContributor<TContributorInput> This class accepts a ContributorInput parameter, suggests change proposals, and creates additional ContributorInputs to be processed. This class performs most of the work of proposing and notifying the manager of changes. For more information, see Create Custom Database Refactoring Types or Targets.
Public class RefactoringError This class defines a database refactoring error. For more information, see Create Custom Database Refactoring Types or Targets.
Public class RefactoringFileNodeCommand Base class for all refactoring commands on Solution Explorer file nodes for database projects. For more information, see Create Custom Database Refactoring Types or Targets.
Public class RefactoringOperation Each database refactoring type has a class that is derived from RefactoringOperation. The RefactoringOperation class manages the complete life cycle of the refactoring operation. An instance of this class exists only for the duration of the refactoring operation. The RefactoringOperation base class drives the actual life cycle of the refactoring operation. The methods of the derived class are invoked by the base class methods. The RefactoringOperation serves as the launch point for a refactoring operation, and presents user interface (UI) to the user to gather required input for the refactoring operation. The base class provides services such as the preview user interface. For more information, see Create Custom Database Refactoring Types or Targets.
Public class RefactoringPreviewGroup Captures check-box settings, friendly name, and other information for a preview group. A RefactoringPreviewGroup contains only group information, and does not contain the list of changes. The contributor class of the operation contains RefactoringPreviewGroup and a list of changes. For more information, see Create Custom Database Refactoring Types or Targets.
Public class RefactoringProjectNodeCommand Base command for all refactoring commands on database project nodes. For more information, see Create Custom Database Refactoring Types or Targets.
Public class RefactoringSchemaViewNodeCommand Base class for all refactoring commands on a schema view node in a database project. For more information, see Create Custom Database Refactoring Types or Targets.
Public class TextChangeProposal The ChangeProposal class represents the changes returned from the contributors. These changes represent the file, offset, lengths, new value, and old value of a proposed change. For more information, see Create Custom Database Refactoring Types or Targets.

Enumerations

  Enumeration Description
Public enumeration QueryStatusResult Flags enumeration that represents RefactoringCommand status on a project or file node in Solution Explorer, or status on an element node in Schema View. For more information, see Create Custom Database Refactoring Types or Targets.
Public enumeration RefactoringErrorCategory Refactoring error category. Specifying a category determines where the error message will be shown, such as the Preview Changes dialog box or the event log. For more information, see Create Custom Database Refactoring Types or Targets.