Share via


RefactoringContributor<TContributorInput> Class

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.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.Schema.Package.Refactoring.RefactoringContributor
    Microsoft.VisualStudio.Data.Schema.Package.Refactoring.RefactoringContributor<TContributorInput>

Namespace:  Microsoft.VisualStudio.Data.Schema.Package.Refactoring
Assembly:  Microsoft.VisualStudio.Data.Schema.Package (in Microsoft.VisualStudio.Data.Schema.Package.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class RefactoringContributor(Of TContributorInput As ContributorInput) _
    Inherits RefactoringContributor
[CLSCompliantAttribute(false)]
public abstract class RefactoringContributor<TContributorInput> : RefactoringContributor
where TContributorInput : ContributorInput
[CLSCompliantAttribute(false)]
generic<typename TContributorInput>
where TContributorInput : ContributorInput
public ref class RefactoringContributor abstract : public RefactoringContributor
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type RefactoringContributor<'TContributorInput when 'TContributorInput : ContributorInput> =  
    class
        inherit RefactoringContributor
    end
JScript does not support generic types or methods.

Type Parameters

  • TContributorInput

The RefactoringContributor<TContributorInput> type exposes the following members.

Constructors

  Name Description
Protected method RefactoringContributor<TContributorInput> Initializes a new instance of the RefactoringContributor<TContributorInput> class.

Top

Properties

  Name Description
Public property PreviewGroup Gets or sets the refactoring preview group instance that is associated with the ChangeProposals that is returned by this contributor. (Inherited from RefactoringContributor.)

Top

Methods

  Name Description
Protected method ContributeChanges
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnBeforeAnalysis Enables the scenario where a different contributor might have to do some preparation work before analysis starts (for example, save dirty files).
Protected method OnPostApplyChanges Enables the contributor to take actions after the selected change proposals are applied.
Protected method OnPreApplyChanges OnPreApplyChanges allows the contributor to take actions prior to the application of the selected change proposals.
Protected method RegisterGeneratedInputType Registers any possible propagating input type that this contributor generates during analysis. (Inherited from RefactoringContributor.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

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