チュートリアル: 基本サイト定義プロジェクトを作成する

このチュートリアルでは、複数のコントロールを備えた視覚的 Web パーツを含む基本サイト定義を作成する方法について説明します。 わかりやすくするため、作成する視覚的 Web パーツには少数のコントロールしかありません。 ただし、より多くの機能を含むより高度な SharePoint サイト定義を作成できます。

このチュートリアルでは、次のタスクについて説明します。

• Visual Studio プロジェクト テンプレートを使用してサイト定義を作成する。

• SharePoint でサイト定義を使用して SharePoint サイトを作成する。

• 視覚的 Web パーツをソリューションに追加する。

• 新しい視覚的 Web パーツを追加して、サイトの default.aspx ページをカスタマイズする。

  Note

  次の手順で参照している Visual Studio ユーザー インターフェイス要素の一部は、お使いのコンピューターでは名前や場所が異なる場合があります。 これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。 詳細については、「Visual Studio IDE のカスタマイズ」を参照してください。

必須コンポーネント

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

• サポート対象エディションの Microsoft Windows および SharePoint。 詳細については、「SharePoint ソリューションの開発要件」を参照してください。

• Visual Studio.

サイト定義ソリューションを作成する

まず、サイト定義プロジェクトを Visual Studio に作成します。

サイト定義プロジェクトを作成するには

1. メニュー バーで、 [ファイル]>[新規作成]>[プロジェクト] を選択します。 IDE が Visual Basic 開発設定を使用するように設定されている場合は、メニュー バーで [ファイル] > [新しいプロジェクト] の順に選択します。

   [新しいプロジェクト] ダイアログ ボックスが表示されます。

2. [Visual C#] ノードまたは [Visual Basic] ノードを展開し、[SharePoint] ノードを展開して、[2010] ノードをクリックします。

3. [テンプレート] ボックスの一覧で、[SharePoint 2010 プロジェクト] テンプレートを選択します。

4. [名前] ボックスに「TestSiteDef」と入力した後、[OK] をクリックします。

   SharePoint カスタマイズ ウィザードが表示されます。

5. [デバッグのサイトとセキュリティ レベルの指定] ページで、サイト定義をデバッグする SharePoint サイトの URL を入力するか、既定の場所 (http://システム名/) を使用します。

6. [この SharePoint ソリューションの信頼レベル] セクションで、[ファーム ソリューションとして配置する] オプション ボタンをクリックします。

   すべてのサイト定義プロジェクトは、ファーム ソリューションとして配置する必要があります。 サンドボックス ソリューションとファーム ソリューションの比較の詳細については、「サンド ボックス ソリューションの考慮事項」を参照してください。

7. [完了] ボタンを選択します。

   ソリューション エクスプローラーにプロジェクトが表示されます。

8. ソリューション エクスプローラーで、プロジェクト ノードを選択します。次に、メニュー バーで [プロジェクト]>[新しい項目の追加] を選択します。

9. [Visual C#] または [Visual Basic] で [SharePoint] ノードを展開し、[2010] ノードを選択します。

10. [テンプレート] ペインで、[サイト定義] テンプレートを選択し、[名前] は SiteDefinition1 のままにして、[追加] をクリックします。

視覚的 Web パーツを作成する

次に、サイト定義のメイン ページに表示する視覚的 Web パーツを作成します。

視覚的 Web パーツを作成するには

1. ソリューション エクスプローラーで、[すべてのファイルを表示] をクリックします。

2. [SiteDefinition1] プロジェクト ノードを選択し、次に、メニュー バーで [プロジェクト] > [新しい項目の追加] の順に選択します。

   [新しい項目の追加] ダイアログ ボックスが表示されます。

3. [Visual C#] ノードまたは [Visual Basic] ノードを展開し、[SharePoint] ノードを展開して、[2010] ノードをクリックします。

4. テンプレートの一覧で、[視覚的 Web パーツ] テンプレートを選択し、既定の名前の VisualWebPart1 のままにして、[追加] をクリックします。

   VisualWebPart1.ascx ファイルが開きます。

5. VisualWebPart1.ascx の下部で、次のマークアップを追加して、テキスト ボックス、ボタン、ラベルの 3 つのコントロールをフォームに追加します。

   <table>
     <tr>
       <td>
         <asp:TextBox runat="server" ID="tbName"></asp:TextBox>
       </td>
       <td>
         <asp:Button runat="server" ID="btnSubmit" Text = "Change Label Text" OnClick="btnSubmit_Click"></asp:Button>
       </td>
       <td>
         <asp:Label runat="server" ID="lblName"></asp:Label>
       </td>
     </tr>
   </table>
   

6. VisualWebPart1.ascx の下で、VisualWebPart1.ascx.cs ファイル (Visual C# の場合) または VisualWebPart1.ascx.vb ファイル (Visual Basic の場合) を開き、次のコードを追加します。

   C#

   protected void btnSubmit_Click(object sender, EventArgs e)
   {            
       lblName.Text = tbName.Text;
   }
   

   VB

   Protected Sub btnSubmit_Click(ByVal sender As Object, ByVal e As EventArgs)
       lblName.Text = tbName.Text
   End Sub
   

   このコードにより、Web パーツのボタン クリックの機能が追加されます。

既定の ASPX ページに視覚的 Web パーツを追加する

次に、視覚的 Web パーツをサイト定義の既定の ASPX ページに追加します。

既定の ASPX ページに視覚的 Web パーツを追加するには

1. default.aspx ページを開き、WebPartPages タグの下に次の行を追加します。

   <%@ Register Tagprefix="MyWebPartControls" Namespace="TestSiteDef.VisualWebPart1" Assembly="$SharePoint.Project.AssemblyFullName$" %>
   

   この行によって、MyWebPartControls という名前が Web パーツとそのコードに関連付けられます。 Namespace パラメーターは、VisualWebPart1.ascx コード ファイルで使用されている名前空間と一致します。

2. </asp:Content> 要素の後に、ContentPlaceHolderId="PlaceHolderMain" セクション全体とその内容を次のコードに置き換えます。

   <asp:Content ID="Content1" ContentPlaceHolderId="PlaceHolderMain" runat="server">
       <MyWebPartControls:VisualWebPart1 runat="server" />
   </asp:Content>
   

   このコードによって、前に作成した視覚的 Web パーツへの参照が作成されます。

3. ソリューション エクスプローラーで、[SiteDefinition1] ノードのショートカット メニューを開き、[スタートアップ アイテムとして設定] を選択します。

サイト定義ソリューションを配置して実行する

次に、プロジェクトを SharePoint に配置してから、プロジェクトを実行します。

サイト定義を配置して実行するには

• メニュー バーで [ビルド] > [TestSiteDef の配置] の順に選択します。

• F5 キーを押します。

  Visual Studio により、コードがコンパイルされ、その機能が追加され、すべてのファイルが SharePoint ソリューション (WSP) ファイルにパッケージ化され、WSP ファイルが SharePoint サーバーに配置されます。 その後、SharePoint によってファイルがインストールされ、機能がアクティブ化されます。

サイト定義に基づいてサイトを作成する

次に、新しいサイト定義を使用してサイトを作成します。

サイト定義を使用してサイトを作成するには

1. SharePoint サイトで、[新しい SharePoint サイト] ページが表示されます。

2. [タイトルと説明] セクションで、サイトのタイトルと説明に「My New Site」(新しいマイ サイト) と入力します。

3. [Web サイト アドレス] セクションで、[URL 名] ボックスに「mynewsite」と入力します。

4. [テンプレート] セクションで、[SharePoint のカスタマイズ] タブを選択します。

5. [テンプレートの選択] ボックスの一覧で [SiteDefinition1] を選択します。

6. その他の設定はそれぞれの既定値のままにして、[作成] をクリックします。

   新しいサイトが表示されます。

新しいサイトをテストする

次に、新しいサイトをテストして、正常に動作するかどうかを確認します。

新しいサイトをテストするには

• 既定の ASPX ページで、テキストを入力し、テキスト ボックスの横にある [ラベル テキストの変更] をクリックします。

  テキストは、ボタンの右側のラベルに表示されます。

関連するコンテンツ

• 方法: イベント レシーバーを作成する
• SharePoint ソリューションの開発