Cómo: Ejecutar código cuando se ejecutan los pasos de implementación

Si desea realizar tareas adicionales en un paso de implementación de un proyecto SharePoint, puede controlar los eventos que provocan los elementos de proyecto de SharePoint antes y después de que Visual Studio ejecute cada paso de implementación.Para obtener más información, vea Extender el empaquetado e implementación de SharePoint.

Para ejecutar código cuando se ejecutan los pasos de implementación

1. Cree una extensión de elemento de proyecto, una extensión de proyecto o una definición de un nuevo tipo de elemento de proyecto.Para obtener más información, vea los temas siguientes:

   • Cómo: Crear una extensión de elemento de proyecto de SharePoint

   • Cómo: Crear una extensión de proyecto de SharePoint

   • Cómo: Definir un tipo de elemento de proyecto de SharePoint

2. En la extensión, controle los eventos DeploymentStepCompleted y DeploymentStepStarted de un objeto ISharePointProjectItemType (en una extensión de elemento de proyecto o extensión de proyecto) o un objeto ISharePointProjectItemTypeDefinition (en una definición de un nuevo tipo de elemento de proyecto).

3. En los controladores de eventos, utilice los parámetros DeploymentStepCompletedEventArgs y DeploymentStepStartedEventArgs para obtener información sobre el paso de implementación.Por ejemplo, puede determinar qué paso de implementación se está ejecutando y si la solución se implementa o se retracta.

Ejemplo

En el ejemplo de código siguiente se muestra cómo controlar eventos DeploymentStepCompleted y DeploymentStepStarted en una extensión para el elemento de proyecto Instancia de lista.Esta extensión escribe un mensaje adicional en el Ventana de salida cuando Visual Studio recicla el grupo de aplicaciones mientras implementa y retracta la solución.

Imports System
Imports Microsoft.VisualStudio.SharePoint
Imports Microsoft.VisualStudio.SharePoint.Deployment
Imports System.ComponentModel.Composition

Namespace Contoso.ListInstanceDeploymentExtension

    <Export(GetType(ISharePointProjectItemTypeExtension))> _
    <SharePointProjectItemType("Microsoft.VisualStudio.SharePoint.ListInstance")> _
    Friend Class ExampleDeploymentStepExtension
        Implements ISharePointProjectItemTypeExtension

        Private Sub Initialize(ByVal projectItemType As ISharePointProjectItemType) _
            Implements ISharePointProjectItemTypeExtension.Initialize
            AddHandler projectItemType.DeploymentStepStarted, AddressOf DeploymentStepStarted
            AddHandler projectItemType.DeploymentStepCompleted, AddressOf DeploymentStepCompleted
        End Sub

        Private Sub DeploymentStepStarted(ByVal Sender As Object, ByVal e As DeploymentStepStartedEventArgs)
            If e.DeploymentStepInfo.Id = DeploymentStepIds.RecycleApplicationPool AndAlso
                e.DeploymentContext.IsDeploying Then
                e.DeploymentContext.Logger.WriteLine("The application pool is about to be " &
                    "recycled while the solution is being deployed.", LogCategory.Status)
            End If
        End Sub

        Private Sub DeploymentStepCompleted(ByVal Sender As Object, ByVal e As DeploymentStepCompletedEventArgs)
            If e.DeploymentStepInfo.Id = DeploymentStepIds.RecycleApplicationPool AndAlso
                e.DeploymentContext.IsRetracting Then
                e.DeploymentContext.Logger.WriteLine("The application pool was " &
                    "recycled while the solution is being retracted.", LogCategory.Status)
            End If
        End Sub
    End Class
End Namespace

using System;
using Microsoft.VisualStudio.SharePoint;
using Microsoft.VisualStudio.SharePoint.Deployment;
using System.ComponentModel.Composition;

namespace Contoso.ListInstanceDeploymentExtension
{
    [Export(typeof(ISharePointProjectItemTypeExtension))]
    [SharePointProjectItemType("Microsoft.VisualStudio.SharePoint.ListInstance")]
    internal class ExampleDeploymentStepExtension : ISharePointProjectItemTypeExtension
    {
        public void Initialize(ISharePointProjectItemType projectItemType)
        {
            projectItemType.DeploymentStepStarted += DeploymentStepStarted;
            projectItemType.DeploymentStepCompleted += DeploymentStepCompleted;
        }

        private void DeploymentStepStarted(object sender, DeploymentStepStartedEventArgs e)
        {
            if (e.DeploymentStepInfo.Id == DeploymentStepIds.RecycleApplicationPool &&
                e.DeploymentContext.IsDeploying)
            {
                e.DeploymentContext.Logger.WriteLine("The application pool is about to be " +
                    "recycled while the solution is being deployed.", LogCategory.Status);
            }
        }

        private void DeploymentStepCompleted(object sender, DeploymentStepCompletedEventArgs e)
        {
            if (e.DeploymentStepInfo.Id == DeploymentStepIds.RecycleApplicationPool &&
                e.DeploymentContext.IsRetracting)
            {
                e.DeploymentContext.Logger.WriteLine("The application pool was " +
                    "recycled while the solution is being retracted.", LogCategory.Status);
            }
        }
    }
}

Compilar el código

Para este ejemplo se requieren referencias a los siguientes ensamblados:

• Microsoft.VisualStudio.SharePoint

• System.ComponentModel.Composition

Implementar la extensión

Para implementar la extensión, cree un paquete de extensión (VSIX) de Visual Studio para el ensamblado y el resto de archivos que desee distribuir con la extensión.Para obtener más información, vea Extensiones de implementación para las Herramientas de SharePoint en Visual Studio.

Vea también

Tareas

Tutorial: Crear un paso de implementación personalizado para proyectos de SharePoint

Conceptos

Extender el empaquetado e implementación de SharePoint

Cómo: Ejecutar código cuando se implementa o retracta un proyecto de SharePoint