Procedura: eseguire codice quando un progetto SharePoint viene distribuito o ritratto

Se si desidera eseguire attività aggiuntive quando un progetto SharePoint viene distribuito o ritratto, è possibile gestire eventi generati da Visual Studio. Per ulteriori informazioni, vedere Estensione della creazione di pacchetti e della distribuzione di SharePoint.

Per eseguire codice quando un progetto SharePoint viene distribuito o ritratto

1. Creare un'estensione di elemento del progetto, un'estensione di progetto o una definizione di un nuovo tipo di elemento di progetto. Per ulteriori informazioni, vedere i seguenti argomenti:

   • Procedura: creare un'estensione di elemento del progetto SharePoint

   • Procedura: creare un'estensione di progetto SharePoint

   • Procedura: definire un tipo di elemento di progetto SharePoint

2. Nell'estensione accedere all'oggetto ISharePointProjectService. Per ulteriori informazioni, vedere Procedura: recuperare il servizio di progetto SharePoint.

3. Gestire gli eventi DeploymentStarted e DeploymentCompleted del servizio di progetto.

4. Nei gestori eventi utilizzare il parametro DeploymentEventArgs per ottenere informazioni sulla sessione di distribuzione corrente. È ad esempio possibile determinare quale progetto si trova nella sessione di distribuzione corrente e se ne è in corso la distribuzione o la ritrazione.

Nell'esempio di codice seguente viene illustrato come gestire gli eventi DeploymentStarted e DeploymentCompleted in un'estensione di progetto. Tale estensione scrive un messaggio aggiuntivo nella finestra Output quando viene avviata e completata la distribuzione di un progetto 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);
            }
        }
    }
}

Compilazione del codice

In questo esempio sono richiesti riferimenti agli assembly seguenti:

• Microsoft.VisualStudio.SharePoint

• System.ComponentModel.Composition

Distribuzione dell'estensione

Per distribuire l'estensione, creare un pacchetto Visual Studio Extension (VSIX) per l'assembly e qualsiasi altro file che si desidera distribuire con l'estensione. Per ulteriori informazioni, vedere Distribuzione di estensioni per gli strumenti di SharePoint in Visual Studio.

Vedere anche

Attività

Procedura: eseguire codice all'esecuzione dei passaggi di distribuzione

Altre risorse

Estensione della creazione di pacchetti e della distribuzione di SharePoint