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

Si desea realizar otras tareas adicionales al implementar o retirar un proyecto de SharePoint, puede controlar los eventos que Visual Studio genera.Para obtener más información, vea Extender el empaquetado e implementación de SharePoint.

Para ejecutar código cuando se implementa o retira un proyecto de SharePoint

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, obtenga acceso al objeto ISharePointProjectService.Para obtener más información, vea Cómo: Recuperar el servicio de proyecto de SharePoint.

3. Controle los eventos DeploymentCompleted y DeploymentStarted del servicio del proyecto.

4. En los controladores de eventos, use el parámetro DeploymentEventArgs para obtener información sobre la sesión de implementación actual.Por ejemplo, puede determinar qué proyecto está en la sesión de implementación actual y si se está implementando o retirando.

En el siguiente ejemplo de código se muestra cómo se controlan los eventos DeploymentStarted y DeploymentCompleted de una extensión de proyecto.Esta extensión escribe un mensaje adicional en la Ventana de salida cuando la implementación se inicia y se completa en un proyecto de SharePoint.

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

Namespace Contoso.ProjectDeploymentExtension

    <Export(GetType(ISharePointProjectExtension))> _
    Friend Class ExampleProjectDeploymentExtension
        Implements ISharePointProjectExtension

        Private Sub Initialize(ByVal projectService As ISharePointProjectService) _
            Implements ISharePointProjectExtension.Initialize
            AddHandler projectService.DeploymentStarted, AddressOf DeploymentStarted
            AddHandler projectService.DeploymentCompleted, AddressOf DeploymentCompleted
        End Sub

        Private Sub DeploymentStarted(ByVal Sender As Object, ByVal e As DeploymentEventArgs)
            If e.DeploymentContext.IsDeploying Then
                Dim message As String = String.Format("Deployment started for the {0} project.", 
                     e.Project.Name)
                e.DeploymentContext.Logger.WriteLine(message, LogCategory.Status)
            End If
        End Sub

        Private Sub DeploymentCompleted(ByVal Sender As Object, ByVal e As DeploymentEventArgs)
            If e.DeploymentContext.IsDeploying Then
                Dim message As String = String.Format("Deployment completed for the {0} project.", 
                    e.Project.Name)
                e.DeploymentContext.Logger.WriteLine(message, 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.ProjectDeploymentExtension
{
    [Export(typeof(ISharePointProjectExtension))]
    internal class ExampleProjectDeploymentExtension : ISharePointProjectExtension
    {
        public void Initialize(ISharePointProjectService projectService)
        {
            projectService.DeploymentStarted += ProjectService_DeploymentStarted;
            projectService.DeploymentCompleted += ProjectService_DeploymentCompleted;
        }

        void ProjectService_DeploymentStarted(object sender, DeploymentEventArgs e)
        {
            if (e.DeploymentContext.IsDeploying)
            {
                string message = String.Format("Deployment started for the {0} project.",
                     e.Project.Name);
                e.DeploymentContext.Logger.WriteLine(message, LogCategory.Status);
            }
        }

        void ProjectService_DeploymentCompleted(object sender, DeploymentEventArgs e)
        {
            if (e.DeploymentContext.IsDeploying)
            {
                string message = String.Format("Deployment completed for the {0} project.",
                     e.Project.Name);
                e.DeploymentContext.Logger.WriteLine(message, 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

Conceptos

Extender el empaquetado e implementación de SharePoint

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