SharePoint の Web パーツを作成する
Web パーツを作成すると、SharePoint サイト ページのコンテンツ、外観、および動作をユーザーがブラウザーから変更できます。 Web パーツは、Web パーツ ページ内で実行されるサーバー側コントロールです。SharePoint サイトに表示されるページはこれらの Web パーツで構成されます。 「構成要素: Web パーツ」を参照してください。
SharePoint サイトの Web パーツを作成およびデバッグするには、Visual Studio のテンプレートを使用します。
Visual Studio で Web パーツを作成する
Web パーツを作成するには、SharePoint プロジェクトに Web パーツ項目を追加します。 サンドボックス ソリューションまたはファーム ソリューションに Web パーツ項目を使用できます。
デザイナーを使用して Web パーツを視覚的にデザインする場合は、視覚的 Web パーツ プロジェクトを作成するか、視覚的 Web パーツ項目を SharePoint プロジェクトに追加します。 視覚的 Web パーツ項目を使用できるのは、ファーム ソリューションのみです。
Web パーツ項目
Web パーツ項目には、SharePoint サイト用の Web パーツをデザインするためのファイルが用意されています。 Web パーツ項目を追加すると、プロジェクトにフォルダーが作成され、そのフォルダーにいくつかのファイルが追加されます。 各ファイルの説明を次の表に示します。
ファイル | 説明 |
---|---|
Elements.xml | Web パーツを配置する際、プロジェクトのフィーチャー定義ファイルで使用する情報が格納されます。 |
.webpart ファイル | SharePoint の Web パーツ ギャラリーに Web パーツを表示するために必要な情報を指定します。 |
コード ファイル | Web パーツにコントロールを追加するメソッド、および Web パーツ内にカスタム コンテンツを生成するメソッドが保存されます。 |
詳細については、「方法:SharePoint Web パーツを作成する」を参照してください。
視覚的 Web パーツ項目
視覚的 Web パーツは、Visual Studio の Visual Web Developer デザイナーを使用して作成する Web パーツです。 視覚的 Web パーツの機能は他の Web パーツと同じです。 ボタンやテキスト ボックスなどのコントロールを Web パーツに追加するときは、XML ファイルにコードを追加します。 ただし、視覚的 Web パーツにコントロールを追加するときは、Visual Studio のツールボックスから Web パーツへコントロールをドラッグまたはコピーします。 その後、XML ファイルで必要なコードを生成します。 「方法:デザイナーを使用して SharePoint Web パーツを作成する」を参照してください。
SharePoint コントロール
Visual Studio には、アプリケーションのページなど、SharePoint ページを作成するためのコントロールが用意されています。 これらのコントロールは、ツールボックスの [SharePoint コントロール] の下に表示されます。 これらのコントロールの機能は、Microsoft.SharePoint.WebControls 名前空間から取得されます。ここには、SharePoint のサイトやリストのページで使用する ASP.NET サーバー コントロールが含まれています。
コントロール名 | 説明 |
---|---|
AspMenu | ASP メニューを挿入します。 詳細については、「メニュー コントロールの概要」を参照してください。 |
CssLink | LINK 要素を .aspx ページに挿入し、CssRegistrationで定義されている外部スタイル シートを適用します。 |
DateTimeControl | .aspx ページに DateTime コントロールを挿入します。 |
FormDigest | .aspx ページにセキュリティ検証を挿入します |
ListProperty | 指定されたリストのプロパティを返します。 |
ProjectProperty | 現在の Web サイトのグローバル プロパティを返します。 |
RssLink | RSS フィードへのリンクを .aspx ページに挿入します。 |
ScriptLink | スクリプトなどのリソースをページに登録し、ページのレンダリング時に要求できるようにするためのプロパティとメソッドを提供します。 |
テーマ | .aspx ページにテーマを適用します。 |
Web パーツをデバッグする
他の Visual Studio プロジェクトをデバッグする場合と同様に、Web パーツを含む SharePoint プロジェクトをデバッグできます。 Visual Studio デバッガーを開始すると、SharePoint サイトが開きます。
コードのデバッグを開始するには、SharePoint で Web パーツ ページに Web パーツを追加します。
SharePoint プロジェクトのデバッグ方法の詳細については、「SharePoint ソリューションのトラブルシューティング」を参照してください。
視覚的 Web パーツの制限
Visual Studio では、SharePoint のサンドボックス ソリューションおよびファーム ソリューションに視覚的 Web パーツを追加できます。 ただし、視覚的 Web パーツには次のような制限があります。
視覚的 Web パーツでは置き換え可能パラメーターを使用できません。 詳細については、「置き換え可能パラメーター」を参照してください。
ユーザー コントロールと視覚的 Web パーツは、視覚的 Web パーツ上にドラッグ アンド ドロップしたり、コピーしたりできません。 これらの操作を実行するとビルド エラーが発生します。
視覚的 Web パーツは、$SPUrl などの SharePoint サーバー トークンを直接サポートしません。 詳細については、「SharePoint ソリューションのトラブルシューティング」トピックの「サンドボックス視覚的 Web パーツでのトークンの制約」を参照してください。
サンドボックス ソリューション内の視覚的 Web パーツでは、"サンドボックス コード ホスト サービスがビジーで要求を処理できないため、サンドボックス コード実行要求が拒否されました" というエラーが発生することがあります。このエラーの詳細については、SharePoint Developer チーム ブログ内の、この投稿をご覧ください。
Visual Studio では、サーバー側 JavaScript のデバッグがサポートされていません。ただし、クライアント側 JavaScript のデバッグはサポートされています。
サーバー側のマークアップ ファイルにインライン JavaScript を追加できますが、マークアップに追加したブレークポイントはデバッグできません。 JavaScript をデバッグするには、マークアップ ファイルで外部の JavaScript ファイルを参照し、JavaScript ファイルにブレークポイントを設定します。
インライン ASP.NET コードのデバッグは、マークアップ ファイルではなく、生成されたコード ファイルで実行する必要があります。
視覚的 Web パーツでは、
<@ Assembly Src=
ディレクティブを使用できません。SharePoint の Web コントロールと一部の ASP.NET コントロールは、 SharePoint サンドボックス環境ではサポートされていません。 サンドボックス ソリューションの視覚的 web パーツでサポート対象外のコントロールを使用すると、"型または名前空間の名前 'Theme' は名前空間 'Microsoft.SharePoint.WebControls' に存在しません" というエラーが表示されます。
サンドボックス ソリューションの詳細については、「サンドボックス ソリューションとファーム ソリューションの違い」を参照してください。
古い形式の SharePoint に基づく Web パーツを作成する
Visual Studio 内のテンプレートを使うと、SharePoint 用の独自の ASP.NET 2.0 Web パーツを作成できます。 ASP.NET 2.0 Web パーツは ASP.NET Web パーツのインフラストラクチャの最上位にビルドされるため、新しいプロジェクトに適しています。
ごくまれに、古い形式の SharePoint に対応する Web パーツを使用して Web パーツを作成しなければならない場合があります。 こうした Web パーツも Visual Studio で作成できますが、Visual Studio にはその際に役立つテンプレートがありません。
古い形式の SharePoint に対応する Web パーツを作成するケースについては、Windows SharePoint Services の Web パーツ インフラストラクチャに関するページを参照してください。 古い形式の SharePoint に基づく Web パーツを使用して Web パーツを作成する方法については、「チュートリアル: 基本的な SharePoint Web パーツの作成」を参照してください。
関連トピック
Title | 説明 |
---|---|
方法: SharePoint Web パーツを作成する | SharePoint ページの Web パーツを作成する方法について説明します。 |
方法: デザイナーを使用して SharePoint Web パーツを作成する | 視覚的なデザイン サーフェイスを使用して、SharePoint の Web パーツを作成する方法について説明します。 |
方法: SharePoint アプリケーション ページまたは Web パーツのユーザー コントロールを作成する | SharePoint で実行されるアプリケーション ページと Web パーツで使用できる、再利用可能なカスタム コントロールを作成する方法について説明します。 |
チュートリアル: SharePoint の Web パーツの作成 | SharePoint の Web パーツをデザインする方法について説明します。 |
チュートリアル: デザイナーを使用した SharePoint の Web パーツの作成 | 視覚的なデザイン サーフェイスにコントロールをドラッグして、SharePoint の Web パーツをデザインする方法について説明します。 |
チュートリアル: SharePoint の OData を表示する Silverlight Web パーツの作成 | Silverlight アプリケーションをホストし、SharePoint リストのデータを表示する、SharePoint の Web パーツをデザインする方法について説明します。 |