Share via

Visual Studio 2005 Extensions を使用して Windows SharePoint Services 3.0 Web パーツを作成する

  • [アーティクル]

要約 : Microsoft Visual Studio 2005 Extensions for Microsoft Windows SharePoint Services 3.0 付属のプロジェクト テンプレートを使用して、迅速に Web パーツを開発する方法を学びます。(5 印刷ページ)

Alex Malek、Microsoft Corporation

Andrew May、Microsoft Corporation

2006 年 11 月

適用対象 : Microsoft Windows SharePoint Services 3.0、Microsoft Visual Studio 2005

目次

  • Visual Studio 2005 Extensions for Windows SharePoint Services 3.0 を使用した Windows SharePoint Services 3.0 Web パーツ開発の概要

  • 新しい Web パーツ ソリューションを作成する

  • Web パーツ ソリューション パッケージをカスタマイズする

  • Web パーツを配置してデバッグする

  • まとめ

  • 追加情報

Visual Studio 2005 Extensions for Windows SharePoint Services 3.0 を使用した Windows SharePoint Services 3.0 Web パーツ開発の概要

Microsoft Visual Studio 2005 Extensions for Microsoft Windows SharePoint Services 3.0 には、Windows SharePoint Services 環境での開発作業を推進できるプロジェクト テンプレートが付属しています。さらに、この拡張機能には、Windows SharePoint Services での Microsoft ASP.NET Web パーツの作成、配置、およびテストを合理化する Web パーツ プロジェクトが付属しています。

この記事では、Web パーツ プロジェクトを使用して、Windows SharePoint Services 3.0 の ASP.NET Web パーツの開発、配置、およびテストを行う方法について説明しています。

注意

この記事では、Visual Studio 2005 Extensions for Windows SharePoint Services 3.0 がインストールおよび構成されていることを前提としています。Microsoft ダウンロード センターから「Windows SharePoint Services 3.0 ツール : Visual Studio 2005 Extensions Version 1.1」をダウンロードできます。

新しい Web パーツ ソリューションを作成する

この拡張機能に付属している Web パーツ プロジェクト テンプレートは、Windows SharePoint Services 環境での Web パーツ作成専用にカスタマイズされています。

新しい Web パーツ ソリューションを作成するには

  1. Microsoft Visual Studio 2005 を起動します。

  2. [ファイル] メニューの [新規作成] をクリックし、[プロジェクト] を選択します。

  3. [プロジェクトの種類] で [Visual C#] を選択してから、[SharePoint] を選択します。

    注意

    現在、拡張機能の Web パーツ テンプレートでは Microsoft Visual C# のみをサポートしています。

  4. [テンプレート] で、[Web パーツ] を選択します。

  5. Web パーツの新しい名前、場所、またはソリューションを指定し、[OK] をクリックします。拡張機能では、以下を含む新しい Web パーツ ソリューション プロジェクトが作成されます。

    • 必要な DLL への参照

    • AssemblyInfo.cs (Web パーツ アセンブリの会社および製品の情報、バージョン情報を指定できるファイル)

    • Temporary.snk (Web パーツ アセンブリの一時的な署名キー ファイル)

      注意

      この一時的な署名キー ファイルは、開発専用です。Web パーツ アセンブリの運用準備ができたら、独自の永続的な署名キー ファイルを生成する必要があります。

    • Web パーツ用の Visual C# コード ファイル (Web パーツ名と同じ名前が付けられています)

    既定では、Web パーツ用のコード ファイルには以下が含まれています。

    • Microsoft.SharePoint、Microsoft.SharePoint.WebControls、Microsoft.SharePoint.WebPartPages など、必要とされる System および Windows SharePoint Services 名前空間の using ステートメント

    • System.Web.UI.WebControls.WebParts.WebPart から継承される空の Web パーツ クラス

  6. Web パーツ クラスに必要なコードを追加します。

Web パーツ ソリューション パッケージをカスタマイズする

Web パーツ プロジェクト テンプレートは、開発およびアクティベーション用の Windows SharePoint Services 3.0 の機能として Web パーツのパッケージ化に必要な XML ファイルを自動的に生成します。XML ファイルに含まれている必須の GUID も自動的に生成されます。

機能の詳細については、「フィーチャーを操作する」を参照してください。

拡張機能では、Web パーツを含む機能用に element.xml ファイルとして .webpart ファイルを生成します。すべての Web パーツには .webpart ファイルが必要です。このファイルは、Web パーツを記述する XML ファイルです。また, .webpart ファイルにより、Web パーツが Windows SharePoint Services の Web パーツ ギャラリーに表示されます。

プロジェクトの [プロパティ] ダイアログ ボックスにある [SharePoint ソリューション] タブでソリューション、機能、および要素プロパティを編集すると、これらの XML ファイルの情報をカスタマイズできます。

  • Solution このノードの情報は、機能の manifest.xml ファイルに書き込まれます。次のソリューション プロパティを設定できます。

    • Name Web パーツ ソリューションの名前です。

  • Feature このノードの情報は、機能の feature.xml ファイルに書き込まれます。次の機能のプロパティを設定できます。

    • Folder Name この機能のファイルを格納しているフォルダの名前です。

    • Title 機能のタイトルです。最大で 255 文字です。

    • Description 機能の処理内容について詳しく説明します。

    • Version 機能のバージョンに関して System.Version に対応した表現を指定します。これは、バージョンを示す小数によって区切られる最大 4 つの数です。

    • Scope 機能の範囲です。Farm (ファーム)、WebApplication (Web アプリケーション)、Site (サイト コレクション)、または Web (Web サイト) のいずれかの値を含む可能性があります。

      機能の範囲の機能の詳細については、「要素の範囲」を参照してください。

    • Hidden 機能を非表示にします。この属性は、既定では FALSE です。

    • Default Resource File 機能 XML ファイルを取得することにより、共通のリソース ファイルを示します。

      これらの属性に関する詳細については、「Feature 要素 (フィーチャー)」を参照してください。

  • Element このノードの情報は、機能の element.xml ファイルに書き込まれます。前述のように、このファイルには、通常は .webpart ファイルに含まれている情報が含まれています。次の要素のプロパティを設定できます。

    • Title Web パーツのタイトルで、ユーザーの希望通りに Windows SharePoint Services ユーザー インターフェイスに表示されます。

    • Description Web パーツの説明で、Windows SharePoint Services ユーザー インターフェイスに表示されます。

    • ImportErrorMessage Windows SharePoint Services で Web パーツ ソリューションをインポートできない場合に表示されるエラーに関する文字列です。

Web パーツ ソリューション機能パッケージをカスタマイズするには

  1. ソリューション エクスプローラで、Web パーツ プロジェクトを右クリックして、[プロパティ] を選択します。

  2. [プロパティ] ウィンドウの [SharePoint Solution] を選択します。

    このタブには、後で拡張機能によって生成されるソリューション パッケージのプロパティを含むノードの一覧が表示されます。

  3. [ソリューション] ノードを展開して、[機能] ノードおよび [要素] ノードを展開します。

  4. ノードのプロパティを編集するには、ノードをクリックして、必要なプロパティを編集します。

    たとえば、[要素] ノードをクリックして、Title、Description、および ImportErrorMessage キーの値を編集します。

  5. ノードの変更を行うには、Description 値のフィールドでクリックします。

Web パーツを配置してデバッグする

F5 を押すだけで、Web パーツを配置し、デバッグを開始できます。

注意

デバッグを行うには、Windows SharePoint Services のインストール時に ASP のデバッグを有効にする必要があります。

F5 を押すと、拡張機能によって自動的にビルドされ、配置されて、Web パーツ ソリューション機能のデバッグが開始されます。これを行うため、拡張機能によって次の処理が自動的に実行されます。

  • Web パーツ アセンブリをビルドします。

  • Web パーツ ソリューションを Windows SharePoint Services 機能としてパッケージ化します。

  • この Web パーツ ソリューションがあらかじめ配置されている場合、拡張機能によって前バージョンの Web パーツ ソリューションの機能が消去されます。

  • Web パーツ アセンブリをグローバル アセンブリ キャッシュにインストールします。

  • Windows SharePoint Services の Web パーツ ソリューションの機能を配置してアクティブ化します。

  • Web パーツを SafeControls リストに追加します。

  • iisreset コマンドを呼び出して、Microsoft Internet Information Services (IIS) を再起動します。

  • w3wp プロセスに添付して、デバッグを有効にします。

Web パーツを配置してデバッグするには

  1. F5 キーを押します。拡張機能によって自動的にビルドされ、配置されて、Web パーツ ソリューション機能のデバッグが開始されます。

  2. Web パーツを追加する SharePoint サイトの Web パーツ ページに進みます。

  3. Web パーツ ページの [サイトの操作] をクリックし、[ページの編集] を選択します。

  4. Web パーツを追加する Web パーツ ゾーンの [Web パーツの追加] をクリックします。

  5. [Web パーツの追加] ダイアログ ボックスの [すべての Web パーツ] セクションにある [その他] で、Web パーツを選択して [OK] をクリックします。

まとめ

この記事では、Visual Studio 2005 Extensions for Windows SharePoint Services 3.0 に付属の Web パーツ プロジェクト テンプレートを使用すると、Windows SharePoint Services の Web パーツ ソリューションの作成、配置、およびテストがかつてないほどに容易になることについて説明しています。

追加情報