方法: SharePoint プロジェクト項目の拡張機能を作成する

2011-08-09

既に Visual Studio にインストールされている SharePoint プロジェクト項目に機能を追加する必要がある場合は、プロジェクト項目の拡張機能を作成します。詳細については、「SharePoint プロジェクト項目の拡張」を参照してください。

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

クラスライブラリプロジェクトを作成します。
次のアセンブリへの参照を追加します。
- Microsoft.VisualStudio.SharePoint
- System.ComponentModel.Composition
ISharePointProjectItemTypeExtension インターフェイスを実装するクラスを作成します。
クラスに次の属性を追加します。
- System.ComponentModel.Composition.ExportAttribute. Visual Studio は、この属性を頼りに ISharePointProjectItemTypeExtension の実装を発見し、読み込みます。この属性のコンストラクターには ISharePointProjectItemTypeExtension 型を渡します。
- SharePointProjectItemTypeAttribute. プロジェクト項目の拡張機能では、拡張の対象となるプロジェクト項目がこの属性によって識別されます。プロジェクト項目の ID を属性コンストラクターに渡します。 Visual Studio 2010 に含まれるプロジェクト項目の ID 一覧については、「SharePoint プロジェクト項目の拡張」を参照してください。
Initialize メソッドの実装では、projectItemType パラメーターのメンバーを使用して拡張機能の動作を定義します。このパラメーターは、ISharePointProjectItemEvents インターフェイスおよび ISharePointProjectItemFileEvents インターフェイスに定義されているイベントにアクセスできる ISharePointProjectItemType オブジェクトです。拡張しているプロジェクト項目の種類の特定インスタンスにアクセスするには、ProjectItemAdded、ProjectItemInitialized などの ISharePointProjectItemEvents イベントを処理します。

例

次のコード例に、イベントレシーバープロジェクト項目の単純な拡張機能の作成方法を示します。 SharePoint プロジェクトにイベントレシーバープロジェクト項目をユーザーが追加するたびに、この拡張機能によって [出力] ウィンドウと [エラー一覧] ウィンドウにメッセージが書き込まれます。

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

Namespace Contoso.ExampleProjectItemExtension

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

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

        Private Sub ProjectItemAdded(ByVal Sender As Object, ByVal e As SharePointProjectItemEventArgs)
            Dim projectItem As ISharePointProjectItem = CType(Sender, ISharePointProjectItem)
            Dim Message As String = String.Format("An Event Handler project item named {0} was added to the {1} project.", _
                projectItem.Name, projectItem.Project.Name)
            projectItem.Project.ProjectService.Logger.WriteLine(Message, LogCategory.Message)
        End Sub
    End Class
End Namespace

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

namespace Contoso.ExampleProjectItemExtension
{
    [Export(typeof(ISharePointProjectItemTypeExtension))]
    [SharePointProjectItemType("Microsoft.VisualStudio.SharePoint.EventHandler")]
    internal class ExampleProjectItemExtension : ISharePointProjectItemTypeExtension
    {
        public void Initialize(ISharePointProjectItemType projectItemType)
        {
            projectItemType.ProjectItemAdded += projectItemType_ProjectItemAdded;
        }

        void projectItemType_ProjectItemAdded(object sender, SharePointProjectItemEventArgs e)
        {
            ISharePointProjectItem projectItem = (ISharePointProjectItem)sender;
            string message = String.Format("An Event Handler project item named {0} was added to the {1} project.",
                projectItem.Name, projectItem.Project.Name);
            projectItem.Project.ProjectService.Logger.WriteLine(message, LogCategory.Message);
        }
    }
}

この例では、SharePoint プロジェクトサービスを使用して、出力ウィンドウおよび [エラー一覧] ウィンドウにメッセージを書き込みます。詳細については、「SharePoint プロジェクトサービスの使用」を参照してください。

コードのコンパイル

この例は、次のアセンブリへの参照を必要とします。

Microsoft.VisualStudio.SharePoint
System.ComponentModel.Composition

拡張機能の配置

拡張機能を配置するには、アセンブリと、拡張機能に同梱する必要のあるその他のファイルを提供するための Visual Studio Extension (VSIX) パッケージを作成します。詳細については、「Visual Studio での SharePoint ツールの拡張機能の配置」を参照してください。

次の方法で共有

方法: SharePoint プロジェクト項目の拡張機能を作成する

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

例

コードのコンパイル

拡張機能の配置

参照

処理手順

その他の技術情報

その他のリソース