DeploymentPlanModifier Class

Represents a contributor that modifies a deployment plan.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.Build.DeploymentContributor
    Microsoft.Data.Schema.Build.DeploymentPlanContributor
      Microsoft.Data.Schema.Build.DeploymentPlanModifier
        Microsoft.Data.Schema.Refactoring.RefactoringDeploymentModifier

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

Syntax

'Declaration
Public MustInherit Class DeploymentPlanModifier _
    Inherits DeploymentPlanContributor _
    Implements IExtensionInformation, IExtension

public abstract class DeploymentPlanModifier : DeploymentPlanContributor, 
    IExtensionInformation, IExtension

public ref class DeploymentPlanModifier abstract : public DeploymentPlanContributor, 
    IExtensionInformation, IExtension

[<AbstractClass>]
type DeploymentPlanModifier =  
    class
        inherit DeploymentPlanContributor
        interface IExtensionInformation
        interface IExtension
    end

public abstract class DeploymentPlanModifier extends DeploymentPlanContributor implements IExtensionInformation, IExtension

The DeploymentPlanModifier type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Canceled	Gets a value that indicates whether the contributor was canceled. (Inherited from DeploymentContributor.)
	ExtensionHandle	Gets the handle for this extension.

Top

Methods

	Name	Description
	AddAfter	Adds a new deployment step to the plan after an existing step.
	AddBefore	Adds a new deployment step to the plan before an existing step.
	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.)
	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.)
	OnApplyDeploymentConfiguration	Called by the deployment process in Visual Studio to give your code an opportunity to collect configuration information from the provided files. (Inherited from DeploymentContributor.)
	OnEstablishDeploymentConfiguration	Called by the deployment process in Visual Studio to give your code an opportunity to modify deployment configuration. (Inherited from DeploymentContributor.)
	OnExecute	Called by the Visual Studio Application Lifecycle Management (ALM) deployment engine to allow custom contributors to execute their unique tasks. (Inherited from DeploymentPlanContributor.)
	OnPopulateArguments	Called by the Visual Studio Application Lifecycle Management (ALM) deployment engine to allow custom contributors to populate the command line arguments. (Inherited from DeploymentPlanContributor.)
	PublishMessage	Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers. (Inherited from DeploymentContributor.)
	Remove	Removes an existing step from the deployment plan.
	SetExtensionHandle	Sets the handle for this extension.
	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.Data.Schema.Build Namespace

IExtension

Other Resources

Extending the Database Features of Visual Studio