RefactoringDeploymentContributor Class

Article
11/05/2012

Provides a base class that preserves the intent of a refactoring change at deployment time by providing deployment steps that correspond to actions in the refactor log file. This class must be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.Build.DeploymentContributor
    Microsoft.Data.Schema.Build.TargetModelModifier
      Microsoft.Data.Schema.Refactoring.RefactoringDeploymentContributor

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

Syntax

'Declaration
Public MustInherit Class RefactoringDeploymentContributor _
    Inherits TargetModelModifier

public abstract class RefactoringDeploymentContributor : TargetModelModifier

public ref class RefactoringDeploymentContributor abstract : public TargetModelModifier

[<AbstractClass>]
type RefactoringDeploymentContributor =  
    class
        inherit TargetModelModifier
    end

public abstract class RefactoringDeploymentContributor extends TargetModelModifier

The RefactoringDeploymentContributor type exposes the following members.

Constructors

	Name	Description
	RefactoringDeploymentContributor	Initializes a new instance of the RefactoringDeploymentContributor class.

Top

Properties

	Name	Description
	Canceled	Gets a value that indicates whether the contributor was canceled. (Inherited from DeploymentContributor.)

Top

Methods

	Name	Description
	Cancel	Cancels execution of the contributor. (Inherited from DeploymentContributor.)
	Dispose()	Releases resources. (Inherited from DeploymentContributor.)
	Dispose(Boolean)	Releases resources, as specified. (Inherited from DeploymentContributor.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FilterDeployedTransactionRecords	Returns a list of transaction records that are selected by filtering the provided transactions based on the provided context.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MergeTransactionRecords	Merges the provided records into the current list.
	OnApplyDeploymentConfiguration	Called when the deployment configuration has been applied to the contributor. (Overrides DeploymentContributor.OnApplyDeploymentConfiguration(DeploymentContributorContext, ICollection<DeploymentContributorConfigurationFile>).)
	OnEstablishDeploymentConfiguration	Called during the build process to output a configuration file that is created when existing configuration files that have refactoring extensions are merged. (Overrides DeploymentContributor.OnEstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup).)
	ProposeTargetOperations	Returns this object after the method resets the enumeration by using the provided context. (Overrides TargetModelModifier.ProposeTargetOperations(DeploymentContributorContext).)
	ProvideDeploymentModifier	Returns a deployment modifier that is based on the provided context. (Overrides TargetModelModifier.ProvideDeploymentModifier(DeploymentContributorContext).)
	ProvideDeploymentStep	When overridden in a derived class, returns a deployment step that is based on the provided context.
	PublishMessage	Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers. (Inherited from DeploymentContributor.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Notes to Inheritors

When you inherit from RefactoringDeploymentContributor, you must override the following members:

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.

Share via