チュートリアル: SharePoint プロジェクトに対するカスタムの配置手順の作成

SharePointプロジェクトを配置する場合、Visual Studioは、特定の順序で一連の配置手順が実行されます。Visual Studio には、さまざまな組み込みの配置手順が用意されていますが、配置手順を独自に作成することもできます。

このチュートリアルでは、SharePointで実行しているサーバーのソリューションをアップグレードするカスタムの配置手順を作成します。Visual Studioは、多くのタスク、このような取り消すか、または追加ソリューションの組み込みの配置手順が含まれますが、ソリューションをアップグレードするための配置手順が含まれていません。SharePointソリューションを配置すると、既定では、Visual Studioは、まずソリューション (既に配置されている場合) 取り消し、ソリューション全体を再配置します。組み込みの配置手順の詳細については、「SharePoint ソリューションのパッケージの配置、発行、アップグレード」を参照してください。

このチュートリアルでは、次のタスクを実行します。

次の 2 つの主要タスクを実行する Visual Studio の拡張機能を作成する。
- 拡張機能では、SharePointソリューションのアップグレードするカスタムの配置手順を定義します。
- 拡張子は、特定のプロジェクトについて実行される一連の配置手順ですが、新しい配置構成を定義する、プロジェクトの拡張機能を作成します。新しい配置構成には、カスタムの配置手順と、いくつかの組み込みの配置手順が含まれます。
拡張機能アセンブリが呼び出す2とおりのカスタムSharePointコマンドを作成します。SharePointコマンドは、SharePointのサーバーオブジェクトモデルのAPIを使用する拡張機能のアセンブリから呼び出すことのできるメソッドです。詳細については、「SharePoint オブジェクトモデルの呼び出し」を参照してください。
両方のアセンブリを配置するための Visual Studio Extension (VSIX) パッケージを構築する。
新しい配置手順をテストする。

必須コンポーネント

このチュートリアルを実行するには、開発コンピューターに次のコンポーネントが必要です。

Windows SharePoint、およびサポートされるVisual Studioのエディション。詳細については、「SharePoint ソリューションの開発要件」を参照してください。
Visual Studio SDK。このチュートリアルでは、拡張機能を配置するための VSIX パッケージを、SDK の VSIX プロジェクト テンプレートを使用して作成します。詳細については、「Visual Studio の SharePoint ツールの拡張」を参照してください。

次の概念に関する知識があると役に立ちますが、チュートリアルを実行するうえで必須というわけではありません。

SharePointのサーバーオブジェクトモデルの使用。詳細については、「Using the SharePoint Foundation Server-Side Object Model (SharePoint Foundation Server 側オブジェクトモデルの使用)」を参照してください。
SharePoint ソリューション。詳細については、「Solutions Overview (ソリューションの概要)」を参照してください。
SharePoint ソリューションのアップグレード。詳細については、「Upgrading a Solution (ソリューションのアップグレード)」を参照してください。

プロジェクトの作成

このチュートリアルを完了するには、3種類のプロジェクトを作成する必要があります:

拡張機能を配置するために VSIX パッケージを作成する VSIX プロジェクト。
プロジェクトの拡張機能を実装するクラスライブラリプロジェクト。このプロジェクトが.NET Framework 4.5を対象とする必要があります。
カスタムの SharePoint コマンドを定義するクラスライブラリプロジェクト。このプロジェクトが.NET Framework 3.5を対象とする必要があります。

この 2 つのプロジェクトを作成することから始めます。

VSIX プロジェクトを作成するには

Visual Studio を起動します。
メニューバーで [ファイル]、[新規]、[プロジェクト] の順にクリックします。
[新しいプロジェクト] のダイアログボックスで、[Visual C#] または [Visual Basic] のノードを展開し、[機能拡張] のノードを選択します。

[!メモ]

[機能拡張] のノードは、Visual Studio SDKをインストールするときだけです。詳細については、このトピックで前に説明した「前提条件」を参照してください。
ダイアログボックスの上部に、.NET Frameworkのバージョンの [.NET Framework 4.5] リストのを選択します。
[VSIX プロジェクト] テンプレートを選択し、プロジェクト [UpgradeDeploymentStep]を付けておくと、[OK] のボタンをクリックします。

Visual Studio のソリューションエクスプローラーに UpgradeDeploymentStep プロジェクトが追加されます。

拡張機能プロジェクトを作成するには

**[ソリューションエクスプローラー]では、UpgradeDeploymentStepソリューションノードのショートカットメニューを開き、[追加]**を選択し、を **[新しいプロジェクト]**を選択します。

[!メモ]

Visual Basic プロジェクトでソリューションエクスプローラーにソリューションノードが表示されるのは、General, Projects and Solutions, Options Dialog Boxの [常にソリューションを表示] チェックボックスがオンになっている場合だけです。
[新しいプロジェクト] のダイアログボックスで、[Visual C#] または [Visual Basic] のノードを展開し、[ウィンドウ] のノードを選択します。
ダイアログボックスの上部に、.NET Frameworkのバージョンの [.NET Framework 4.5] リストのを選択します。
[クラスライブラリ] のプロジェクトテンプレートを選択し、プロジェクト [DeploymentStepExtension]を付けておくと、[OK] のボタンをクリックします。

Visual Studio によって、DeploymentStepExtension プロジェクトがソリューションに追加され、既定の Class1 コードファイルが開きます。
Class1 コードファイルをプロジェクトから削除します。

SharePoint コマンドプロジェクトを作成するには

**[ソリューションエクスプローラー]では、UpgradeDeploymentStepソリューションノードのショートカットメニューを開き、[追加]**を選択し、を **[新しいプロジェクト]**を選択します。

[!メモ]

Visual Basic プロジェクトでソリューションエクスプローラーにソリューションノードが表示されるのは、General, Projects and Solutions, Options Dialog Boxの [常にソリューションを表示] チェックボックスがオンになっている場合だけです。
[新しいプロジェクト] のダイアログボックスで、[Visual C#] か [Visual Basic]を展開し、[ウィンドウ] のノードを選択します。
ダイアログボックスの上部に、.NET Frameworkのバージョンの [.NET Framework 3.5] リストのを選択します。
[クラスライブラリ] のプロジェクトテンプレートを選択し、プロジェクト [SharePointCommands]を付けておくと、[OK] のボタンをクリックします。

ソリューションに SharePointCommands プロジェクトが追加され、既定の Class1 コードファイルが開きます。
Class1 コードファイルをプロジェクトから削除します。

プロジェクトの構成

カスタムの配置手順を作成するためのコードを記述する前に、コードファイルおよびアセンブリ参照を追加してプロジェクトを構成する必要があります。

DeploymentStepExtension プロジェクトを構成するには

[DeploymentStepExtension] のプロジェクトでは、次の名前を持つ2種類のコードファイルを追加します:
- UpgradeStep
- DeploymentConfigurationExtension
DeploymentStepExtensionプロジェクトのショートカットメニューを開き、**[参照の追加]**を選択します。
[Framework] のタブで、System.ComponentModel.Compositionアセンブリのチェックボックスをオンにします。
[拡張機能] のタブで、Microsoft.VisualStudio.SharePointアセンブリのチェックボックスをオンにし、[OK] のボタンをクリックします。

SharePointCommands プロジェクトを構成するには

[SharePointCommands] のプロジェクトでは、Commandsという名前のコードファイルを追加します。
[ソリューションエクスプローラー]では、[SharePointCommands] のプロジェクトノードのショートカットメニューを開き、**[参照の追加]**を選択します。
[拡張機能] のタブで、次のアセンブリのチェックボックスをオンにし、を選択します [OK] のボタンをクリックします。
- Microsoft.SharePoint
- Microsoft.VisualStudio.SharePoint.Commands

カスタムの配置手順の定義

アップグレードの配置手順を定義するクラスを作成します。配置手順を定義するため、このクラスに IDeploymentStep インターフェイスを実装します。このインターフェイスは、カスタムの配置手順を定義する場合に必ず実装します。

カスタムの配置手順を定義するには

[DeploymentStepExtension] のプロジェクトでは、UpgradeStepコードファイルを開き、そのファイルに次のコードを貼り付けます。

[!メモ]

このコードを追加すると、いくつかのコンパイルエラーがありますが、後の手順のコードを追加すると解消されます。

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

Namespace Contoso.DeploymentSteps.Upgrade

    ' Export attribute: Enables Visual Studio to discover and load this deployment step.
    ' DeploymentStep attribute: Specifies the ID for this new deployment step.
    ' UpgradeStep class: Defines a new deployment step that can be used to upgrade a solution 
    '     on a SharePoint site.
    <Export(GetType(IDeploymentStep))> _
    <DeploymentStep("Contoso.DeploymentSteps.UpgradeSolution")> _
    Friend Class UpgradeStep
        Implements IDeploymentStep

        Private solutionName As String
        Private solutionFullPath As String

        Private Sub Initialize(ByVal stepInfo As IDeploymentStepInfo) _
            Implements IDeploymentStep.Initialize
            stepInfo.Name = "Upgrade solution"
            stepInfo.StatusBarMessage = "Upgrading solution..."
            stepInfo.Description = "Upgrades the solution on the local machine."
        End Sub

        ' Specifies whether the solution can be upgraded.
        Private Function CanExecute(ByVal context As IDeploymentContext) As Boolean _
            Implements IDeploymentStep.CanExecute

            ' SharePoint returns all the installed solutions names in lower case.
            solutionName = (context.Project.Package.Model.Name & ".wsp").ToLower()
            solutionFullPath = context.Project.Package.OutputPath
            Dim solutionExists As Boolean = _
                context.Project.SharePointConnection.ExecuteCommand(Of String, Boolean)(
                "Contoso.Commands.IsSolutionDeployed", solutionName)

            ' Throw exceptions in error cases because deployment cannot proceed.
            If context.Project.IsSandboxedSolution = True Then
                Dim sandboxMessage As String = "Cannot upgrade the solution. Upgrade deployment " & _
                    "configuration does not support Sandboxed solutions."
                context.Logger.WriteLine(sandboxMessage, LogCategory.Error)
                Throw New InvalidOperationException()
            ElseIf solutionExists = False Then
                Dim notDeployedMessage As String = String.Format("Cannot upgrade the solution. The IsSolutionDeployed " & _
                    "command cannot find the following solution on the SharePoint site: {0}.", solutionName)
                context.Logger.WriteLine(notDeployedMessage, LogCategory.Error)
                Throw New InvalidOperationException(notDeployedMessage)
            End If

            ' Execute step and continue with deployment.
            Return True
        End Function

        Private Sub Execute(ByVal context As IDeploymentContext) _
            Implements IDeploymentStep.Execute
            context.Logger.WriteLine("Upgrading solution: " & solutionName, LogCategory.Status)
            context.Project.SharePointConnection.ExecuteCommand("Contoso.Commands.UpgradeSolution", _
                solutionFullPath)
        End Sub

    End Class
End Namespace

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

namespace Contoso.DeploymentSteps.Upgrade
{
    // Enables Visual Studio to discover and load this deployment step.
    [Export(typeof(IDeploymentStep))]

    // Specifies the ID for this new deployment step.
    [DeploymentStep("Contoso.DeploymentSteps.UpgradeSolution")]

    // Defines a new deployment step that can be used to upgrade a solution on a SharePoint site.
    internal class UpgradeStep : IDeploymentStep
    {
        private string solutionName;
        private string solutionFullPath;

        // Implements IDeploymentStep.Initialize.
        public void Initialize(IDeploymentStepInfo stepInfo)
        {
            stepInfo.Name = "Upgrade solution";
            stepInfo.StatusBarMessage = "Upgrading solution...";
            stepInfo.Description = "Upgrades the solution on the local machine.";
        }

        // Implements IDeploymentStep.CanExecute. Specifies whether the solution can be upgraded.
        public bool CanExecute(IDeploymentContext context)
        {
            // SharePoint returns all the installed solutions names in lower case.
            solutionName = (context.Project.Package.Model.Name + ".wsp").ToLower();
            solutionFullPath = context.Project.Package.OutputPath;
            bool solutionExists = context.Project.SharePointConnection.ExecuteCommand<string, bool>(
                "Contoso.Commands.IsSolutionDeployed", solutionName);

            // Throw exceptions in error cases because deployment cannot proceed.
            if (context.Project.IsSandboxedSolution)
            {
                string sandboxMessage = "Cannot upgrade the solution. The upgrade deployment configuration " +
                    "does not support Sandboxed solutions.";
                context.Logger.WriteLine(sandboxMessage, LogCategory.Error);
                throw new InvalidOperationException(sandboxMessage);
            }
            else if (!solutionExists)
            {
                string notDeployedMessage = string.Format("Cannot upgrade the solution. The IsSolutionDeployed " +
                    "command cannot find the following solution: {0}.", solutionName);
                context.Logger.WriteLine(notDeployedMessage, LogCategory.Error);
                throw new InvalidOperationException(notDeployedMessage);
            }

            // Execute step and continue with deployment.
            return true;
        }

        // Implements IDeploymentStep.Execute.
        public void Execute(IDeploymentContext context)
        {
            context.Logger.WriteLine("Upgrading solution: " + solutionName, LogCategory.Status);
            context.Project.SharePointConnection.ExecuteCommand("Contoso.Commands.UpgradeSolution",
                solutionFullPath);
        }
    }
}

カスタムの配置手順を含んだ配置構成の作成

いくつかの組み込みの配置手順と新しいアップグレードの配置手順を含んだ新しい配置構成のプロジェクトの拡張機能を作成します。この拡張機能を作成することにより、SharePoint開発者がSharePointプロジェクトにアップグレードの配置手順を使用できます。

配置構成を作成するため、このクラスに ISharePointProjectExtension インターフェイスを実装します。このインターフェイスは、SharePoint プロジェクトの拡張機能を作成する場合に必ず実装します。

配置構成を作成するには

[DeploymentStepExtension] のプロジェクトでは、DeploymentConfigurationExtensionコードファイルを開き、そのファイルに次のコードを貼り付けます。

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

Namespace Contoso.DeploymentSteps.Upgrade

    ' Export attribute: Enables Visual Studio to discover and load this project-level extension.
    ' DeploymentConfigurationExtension class: Defines a project-level extension. The extension creates 
    '     a new deployment configuration that includes the upgrade deployment step.
    <Export(GetType(ISharePointProjectExtension))> _
    Friend Class DeploymentConfigurationExtension
        Implements ISharePointProjectExtension

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

        ' Creates the new deployment configuration.
        Private Sub ProjectInitialized(ByVal Sender As Object, ByVal e As SharePointProjectEventArgs)
            Dim deploymentSteps As String() = New String() _
            {
                DeploymentStepIds.PreDeploymentCommand, _
                DeploymentStepIds.RecycleApplicationPool, _
                "Contoso.DeploymentSteps.UpgradeSolution", _
                DeploymentStepIds.PostDeploymentCommand _
            }
            Dim retractionSteps As String() = New String() _
            {
                DeploymentStepIds.RecycleApplicationPool, _
                DeploymentStepIds.RetractSolution
            }
            Dim configuration As IDeploymentConfiguration = e.Project.DeploymentConfigurations.Add( _
                "Upgrade", deploymentSteps, retractionSteps)
            configuration.Description = "This is the upgrade deployment configuration"
        End Sub

    End Class
End Namespace

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

namespace Contoso.DeploymentSteps.Upgrade
{
    // Enables Visual Studio to discover and load this project-level extension.
    [Export(typeof(ISharePointProjectExtension))]

    // Defines a project-level extension. The extension creates a new deployment configuration that includes the
    // upgrade deployment step.
    internal class DeploymentConfigurationExtension : ISharePointProjectExtension
    {
        // Implements ISharePointProjectExtension.Initialize.
        public void Initialize(ISharePointProjectService projectService)
        {
            projectService.ProjectInitialized += ProjectInitialized;
        }

        // Creates the new deployment configuration.
        private void ProjectInitialized(object sender, SharePointProjectEventArgs e)
        {
            string[] deploymentSteps = new string[] 
            {
                DeploymentStepIds.PreDeploymentCommand,
                DeploymentStepIds.RecycleApplicationPool,
                "Contoso.DeploymentSteps.UpgradeSolution",
                DeploymentStepIds.PostDeploymentCommand 
            };

            string[] retractionSteps = new string[] 
            {
                DeploymentStepIds.RecycleApplicationPool,
                DeploymentStepIds.RetractSolution                
            };

            IDeploymentConfiguration configuration = e.Project.DeploymentConfigurations.Add(
                "Upgrade", deploymentSteps, retractionSteps);
            configuration.Description = "This is the upgrade deployment configuration";
        }
    }
}

カスタム SharePoint コマンドの作成

SharePointのサーバーオブジェクトモデルを呼び出す2とおりのカスタムコマンドを作成します。1 つはソリューションが配置済みかどうかを判断するコマンドで、もう 1 つはソリューションをアップグレードするコマンドです。

SharePoint コマンドを定義するには

[SharePointCommands] のプロジェクトのCommandsコードファイルを開き、そのファイルに次のコードを貼り付けます。

Imports System
Imports System.IO
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Administration
Imports Microsoft.VisualStudio.SharePoint.Commands

Namespace Contoso.DeploymentSteps.Upgrade

    Friend Class Commands

        ' Determines whether the specified solution has been deployed to the local SharePoint server.
        <SharePointCommand("Contoso.Commands.IsSolutionDeployed")> _
        Private Function IsSolutionDeployed(ByVal context As ISharePointCommandContext, ByVal solutionName As String) As Boolean
            Dim solution As SPSolution = SPFarm.Local.Solutions(solutionName)
            Return solution IsNot Nothing
        End Function

        ' Upgrades the specified solution to the local SharePoint server.
        <SharePointCommand("Contoso.Commands.UpgradeSolution")> _
        Private Sub UpgradeSolution(ByVal context As ISharePointCommandContext, ByVal fullWspPath As String)
            Dim solution As SPSolution = SPFarm.Local.Solutions(Path.GetFileName(fullWspPath))
            If solution Is Nothing Then
                Throw New InvalidOperationException("The solution has not been deployed.")
            End If
            solution.Upgrade(fullWspPath)
        End Sub

    End Class
End Namespace

using System;
using System.IO;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Administration;
using Microsoft.VisualStudio.SharePoint.Commands;

namespace Contoso.DeploymentSteps.Upgrade
{
    internal class Commands
    {
        // Determines whether the specified solution has been deployed to the local SharePoint server.
        [SharePointCommand("Contoso.Commands.IsSolutionDeployed")]
        private bool IsSolutionDeployed(ISharePointCommandContext context, string solutionName)
        {
            SPSolution solution = SPFarm.Local.Solutions[solutionName];
            return solution != null;
        }

        // Upgrades the specified solution to the local SharePoint server.
        [SharePointCommand("Contoso.Commands.UpgradeSolution")]
        private void UpgradeSolution(ISharePointCommandContext context, string fullWspPath)
        {
            SPSolution solution = SPFarm.Local.Solutions[Path.GetFileName(fullWspPath)];

            if (solution == null)
            {
                throw new InvalidOperationException("The solution has not been deployed.");
            }

            solution.Upgrade(fullWspPath);
        }
    }
}

チェックポイント

この段階で、カスタムの配置手順および SharePoint コマンドに必要なすべてのコードがプロジェクトに揃ったことになります。これらはコンパイルエラーが発生しないことを確認するために、それらをビルドします。

プロジェクトをビルドするには

[ソリューションエクスプローラー]では、[DeploymentStepExtension] のプロジェクトのショートカットメニューを開き、**[ビルド]**を選択します。
[SharePointCommands] のプロジェクトのショートカットメニューを開き、**[ビルド]**を選択します。

拡張機能を配置するための VSIX パッケージの作成

拡張機能を配置するには、ソリューションで VSIX プロジェクトを使用して VSIX パッケージを作成します。まず、VSIXプロジェクトのsource.extension.vsixmanifestファイルを変更して、VSIXパッケージを構成します。ソリューションをビルドしてVSIXパッケージを作成します。

VSIX パッケージを構成および作成するには

[ソリューションエクスプローラー]では、[UpgradeDeploymentStep] のプロジェクトの下で、を開き、[source.extension.vsixmanifest] ファイルのショートカットメニューで、を **[開く]**を選択します。

Visual Studio によってマニフェストエディターでファイルが開きます。source.extension.vsixmanifestファイルは、すべてのVSIXパッケージが必要とするextension.vsixmanifestファイルの基礎です。このファイルの詳細については、「VSIX 拡張機能のスキーマに関するリファレンス」を参照してください。
[製品名] ボックスに、[Upgrade Deployment Step for SharePoint Projects]を入力します。
[作成者] ボックスに、[Contoso]を入力します。
[説明] ボックスに、SharePointプロジェクトで使用できるカスタムアップグレードの配置手順が用意されています。を入力します。
エディターの [資産] のタブで、[新規作成] のボタンをクリックします。

[新しい資産の追加] のダイアログボックスが表示されます。
[種類] の一覧で、**[Microsoft.VisualStudio.MefComponent]**を選択します。

[!メモ]

この値は、extension.vsixmanifest ファイル内の MefComponent 要素に対応します。この要素は、VSIX パッケージ内の拡張機能アセンブリの名前を指定します。詳細については、「MEFComponent Element」を参照してください。
[ソース] の一覧で、**[現在のソリューション内のプロジェクト]**を選択します。
[プロジェクト] の一覧で、[DeploymentStepExtension]を選択し、[OK] のボタンをクリックします。
マニフェストエディターで、[新規作成] のボタンをもう一度クリックします。

[新しい資産の追加] のダイアログボックスが表示されます。
[種類] の一覧で、[SharePoint.Commands.v4]を入力します。

[!メモ]

Visual Studio の拡張機能に追加するカスタム拡張機能は、この要素によって指定されます。詳細については、「資産の要素 (VSX スキーマ)」を参照してください。
[ソース] の一覧で、**[現在のソリューション内のプロジェクト]**を選択します。
[プロジェクト] の一覧で、[SharePointCommands]を選択し、[OK] のボタンをクリックします。
メニューバーで、[ビルド]、**[ソリューションのビルド]**を選択し、次に、ソリューションのエラーなしでコンパイルしてください。
UpgradeDeploymentStepプロジェクトのビルド出力フォルダーにUpgradeDeploymentStep.vsixファイルが含まれていることを確認します。

既定では、プロジェクトファイルに格納されているフォルダーの ..\bin\Debug フォルダーがビルド出力フォルダーです。

アップグレードの配置手順をテストする準備

アップグレードの配置手順をテストするために、まず、SharePoint サイトにサンプルソリューションを配置する必要があります。まず、Visual Studio の実験用インスタンスで拡張機能のデバッグを開始します。次に、リスト定義を作成し、配置手順をテストするようにインスタンスを示します。次に、SharePointサイトに配置します。次に、リスト定義を変更して、そのインスタンスが一覧表示され、既定の配置プロセスではSharePointサイトのソリューションにどのように上書きするかを示すには、変更を加えて再配置します。

このチュートリアルで後で、リスト定義とリストインスタンスを変更し、SharePointサイトでアップグレードします。

拡張機能のデバッグを開始するには

管理資格情報を使用してVisual Studioを再起動し、UpgradeDeploymentStepソリューションを開きます。
DeploymentStepExtensionプロジェクトで、UpgradeStepコードファイルを開き、CanExecute と Execute のメソッドのコードの先頭行にブレークポイントを追加します。
F5キーのまたはを選択する [デバッグ]、メニューバーのをクリックしてデバッグを開始した [デバッグの開始]。
Visual Studioは、SharePoint Projects\1.0の%UserProfile%\AppData\Local\Microsoft\VisualStudio\11.0Exp\Extensions\Contoso\Upgradeの配置手順に拡張機能をインストール、Visual Studioの実験用インスタンスを起動します。Visual Studioのアップグレードの配置手順をテストします。この場合

リスト定義とリストでSharePointプロジェクトを作成するには、この例に付けます。

Visual Studioの実験用インスタンスで、メニューバーで、[ファイル]、[新規作成]、**[プロジェクト]**を選択します。
[新しいプロジェクト] のダイアログボックスで、[Visual C#] の [Visual Basic] のノードまたはノードを展開し、[SharePoint] のノードを展開し、を [2010] のノードを選択します。
ダイアログボックスの上部に、[.NET Framework 3.5] が.NET Framework Versionの一覧に表示されることを確認します。

Microsoft SharePoint Foundation 2010 および Microsoft SharePoint Server 2010 のプロジェクトには、このバージョンの .NET Framework が必要です。
プロジェクトテンプレートの一覧で、**[SharePoint 2010 プロジェクト]**を選択し、プロジェクト [EmployeesListDefinition]を付けておくと、[OK] のボタンをクリックします。
**[SharePoint カスタマイズウィザード]**で、デバッグに使用するサイトのURLを入力します。
[What is the trust level for this SharePoint solution]の下に、[ファームソリューションとして配置する] のオプションボタンを選択します。

[!メモ]

アップグレードの配置手順がサンドボックスソリューションをサポートしていません。
[完了] のボタンをクリックします。

Visual Studio はEmployeesListDefinitionプロジェクトを作成します。
EmployeesListDefinitionプロジェクトのショートカットメニューを開き、**[追加]**を選択し、を **[新しい項目]**を選択します。
[新しい項目– EmployeesListDefinitionを追加します。] のダイアログボックスで、[SharePoint] のノードを展開し、[2010] のノードを選択します。
[一覧] の項目テンプレートを選択し、項目 [Employees List]を付けておくと、[追加] のボタンをクリックします。

SharePointカスタマイズウィザードが表示されます
[リストの設定を選択] のページに次の設定を確認し、[完了] のボタンを選択する:
1. [Employees List] は [リストに表示する名前] ボックスに表示されます。
2. [Create a customizable list based on:] のオプションボタンが選択されます。
3. [既定値 (null)] は [Create a customizable list based on:] の一覧で選択されます。
Visual Studio はタイトル列を持つ従業員一覧の項目を作成し、単一インスタンスはデザイナーで開くリストを空にします。
リストのデザイナーで、[列] のタブで、[新規または既存の列名を入力します] の行を選択し、[列の表示名] の一覧の次の列を追加します:
1. [名]
2. [会社]
3. [会社電話番号]
4. [電子メール]
すべてのファイルを保存し、リストのデザイナーを閉じます。
[ソリューションエクスプローラー]では、[Employees List] のノードを展開し、[Employees List Instance] の子ノードを展開します。

Elements.xmlファイルで、次のXMLにこのファイルの既定XMLに置き換えます。このXMLは [従業員] にリストの名前を変更し、Jim Hanceの従業員の情報を追加します。

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
  <ListInstance Title="Employees"
                OnQuickLaunch="TRUE"
                TemplateType="10000"
                Url="Lists/Employees"
                Description="Simple list to test upgrade deployment step">
    <Data>
      <Rows>
        <Row>
          <Field Name="Title">Hance</Field>
          <Field Name="FirstName">Jim</Field>
          <Field Name="Company">Contoso</Field>
          <Field Name="Business Phone">555-555-5555</Field>
          <Field Name="E-Mail">jim@contoso.com</Field>
        </Row>
      </Rows>
    </Data>
  </ListInstance>
</Elements>

Elements.xmlファイルを保存して閉じます。
EmployeesListDefinitionプロジェクトのショートカットメニューを開き、[開く] か **[プロパティ]**を選択します。

プロパティのデザイナーが開きます。
[SharePoint] のタブで、[デバッグ後に自動取り消し] のチェックボックスをオフにし、プロパティを保存します。

リスト定義とリストインスタンスを配置するには

[ソリューションエクスプローラー]では、[EmployeesListDefinition] のプロジェクトノードを選択します。
[プロパティ] ウィンドウで、[アクティブな配置構成] プロパティが [既定] に設定されていることを確認します。
F5キーをまたはで、メニューバーのをクリックするか、[デバッグ]、**[デバッグの開始]**を選択します。
のクイック起動バーの [リスト] の項目が [従業員] の新しいリストを含むこと、および [従業員] の一覧がJim Hanceのエントリが含まれることをWebブラウザーがSharePointサイトに開くとプロジェクトが正常にビルドして確認してください。
Webブラウザーを閉じます。

リスト定義とリストインスタンスに変更を加えて再配置するには

EmployeesListDefinitionプロジェクトで、[Employee List Instance] プロジェクト項目の子であるElements.xmlファイルを開きます。

Data 要素とその子を削除し、リストから Jim Hance のエントリを削除します。

終了すると、ファイルは次のXMLを含める必要があります。

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
  <ListInstance Title="Employees"
                OnQuickLaunch="TRUE"
                TemplateType="10000"
                Url="Lists/Employees"
                Description="Simple list to test upgrade deployment step">
  </ListInstance>
</Elements>

Elements.xmlファイルを保存して閉じます。
[Employees List] プロジェクト項目に対するショートカットメニューを開き、[開く] か **[プロパティ]**を選択します。
リストのデザイナーで、[ビュー] のタブをクリックします。
[選択された列] の一覧で、**[添付ファイル]**を選択し、< [使用可能な列] の一覧に移動キー列を選択します。
[選択された列] の一覧から [使用可能な列] の一覧に [会社電話番号] の列を移動するには、前の手順を繰り返します。

SharePoint サイトの Employees リストの既定の表示から、これらのフィールドが削除されます。
F5キーのまたはを選択する [デバッグ]、メニューバーのをクリックしてデバッグを開始した [デバッグの開始]。
[配置競合] ダイアログボックスが表示されます。

このダイアログボックスは、Visual Studioがそのソリューションが配置されているSharePointサイトにソリューション (リストインスタンス) を配置しようとすると表示されます。このダイアログボックスでは、このチュートリアルのアップグレードの配置手順を実装するされません。
[配置競合] のダイアログボックスで、[自動的に解決] のオプションボタンを選択します。

Visual Studioは、SharePointサイトのリストインスタンスを削除し、プロジェクトリスト項目を展開して、SharePointサイトが開きます。
のクイック起動バーの [リスト] のセクションでは、[従業員] のリストをクリックし、次の事項を確認する:
- [添付ファイル] とは [自宅電話番号] の列がこのリストのビューに表示されません。
- リストは空です。既定の配置構成を使用してソリューションを再配置した場合、Employees リストが、プロジェクト内の新しい空のリストに置き換えられます。

配置手順のテスト

これで、アップグレードの配置手順をテストする準備ができました。まず、SharePoint でリストインスタンスに項目を追加します。次に、リスト定義を変更して、インスタンスを一覧し、SharePointサイトでアップグレードし、アップグレードの配置手順が新しい項目が上書きします。

リストに手動で項目を追加するには

SharePointサイトのリボンで、[リストツール] のタブで、[項目] のタブをクリックします。
[新規作成] のグループで、**[新しい項目]**を選択します。

別の方法として、項目のリストの [新しい項目の追加] 自体のリンクを選択できます。
[従業員–の新しい項目] のペインで、[タイトル] ボックスに、機能マネージャーを入力します。
[名] ボックスに、アンディーを入力します。
[会社] ボックスに、[Contoso]を入力します。
[保存] のボタンを選択し、新しい項目がリストに表示される確認し、Webブラウザーを閉じます。

後の手順で、アップグレードの配置手順では、このリストの内容を上書きしないことを確認するために、この項目を使用します。

アップグレードの配置手順をテストするには

Visual Studioの実験用インスタンスで、[ソリューションエクスプローラー]で、を開き、[EmployeesListDefinition] のプロジェクトノードのショートカットメニューで、を **[プロパティ]**を選択します。

プロパティエディターまたはデザイナーが開きます。
[SharePoint] のタブで、**[アップグレード]**に [アクティブな配置構成] のプロパティを設定します。

このカスタムの配置構成には、新しいアップグレードの配置手順が含まれます。
[Employees List] プロジェクト項目に対するショートカットメニューを開き、[プロパティ] か **[開く]**を選択します。

プロパティエディターまたはデザイナーが開きます。
[ビュー] のタブで、[電子メール] の列を選択し、[選択された列] の一覧から [使用可能な列] の一覧に列を移動することに [<] のキーを選択します。

SharePoint サイトの Employees リストの既定の表示から、これらのフィールドが削除されます。
F5キーのまたはを選択する [デバッグ]、メニューバーのをクリックしてデバッグを開始した [デバッグの開始]。
Visual Studio のもう一方のインスタンスで、先ほど CanExecute メソッドに設定したブレークポイントで、コードが停止していることを確認します。
F5キーをまたはで、メニューバーで再度選択するか、[デバッグ]、**[続行]**を選択します。
先ほど Execute メソッドに設定したブレークポイントで、コードが停止していることを確認します。
F5キーをまたはで、メニューバーのをクリックするか、[デバッグ]、最終的な時間 [続行] を選択します。

WebブラウザーでSharePointサイトが開きます。
クイック起動領域の [リスト] のセクションでは、[従業員] のリストをクリックし、次の事項を確認する:
- は、手動で前に追加した項目には、リスト (アンディー、機能マネージャー) に存在します。
- [会社電話番号] とは [電子メールアドレス] の列がこのリストのビューに表示されません。
アップグレードの配置構成によって、SharePoint サイト上の既存の Employees リストインスタンスが変更されます。仮にアップグレードではなく、既定の配置構成を使用した場合、配置の競合が発生します。Visual Studioは、[従業員] のリストを置き換えることによって競合を解決し、アンディーの項目、機能マネージャーは削除されます。

開発コンピューターのクリーンアップ

アップグレードの配置手順のテストが終わったら、リストインスタンスおよびリスト定義を SharePoint サイトから削除し、さらに配置手順の拡張機能を Visual Studio から削除します。

SharePoint サイトからリストインスタンスを削除するには

リストがまだ開いていないときは、SharePointサイトの [従業員] の一覧を表示します。
SharePointサイトのリボンで、[リストツール] のタブをクリックし、[一覧] のタブをクリックします。
[設定] のグループで、[リストの設定] の項目を選択します。
[権限と管理]の下に、[このリストを削除します] のコマンドをごみ箱にリストを送信する次に閉じられるWebブラウザーを選択します。ことを確認するために [OK] を選択します。

SharePoint サイトからリスト定義を削除するには

Visual Studioの実験用インスタンスで、メニューバーで、[ビルド]、**[取り消し]**を選択します。

SharePoint サイトからリスト定義が取り消されます。

拡張機能をアンインストールするには

Visual Studioの実験用インスタンスで、メニューバーで、[ツール]、**[拡張機能と更新プログラム]**を選択します。

[拡張機能と更新プログラム] のダイアログボックスが表示されます。
拡張機能の一覧で、[Upgrade Deployment Step for SharePoint Projects]を選択し、[アンインストール] のコマンドを選択します。
表示されたダイアログボックスで、拡張機能をアンインストールする選択し、アンインストールを実行するに [今すぐ再起動] を選択します。ことを確認するためにを [○]。
Visual Studioの実験用インスタンスとインスタンス (UpgradeDeploymentStepソリューションが開いている) Visual Studioの両方のインスタンスのインスタンスを閉じます。

参照

概念

SharePoint のパッケージ化と配置の拡張

Last updated on 2013-02-21