LINQ を使用して SharePoint 2010 Web パーツでデータにアクセスする

[アーティクル]
09/24/2014

SharePoint クイックスタートバナー

SharePoint 2010 でのデータアクセスの概要: LINQ を使用してリストからデータを取得する SharePoint 2010 Web パーツの作成方法について解説します。

最終更新日: 2012年6月13日

適用対象: Office 2010 | SharePoint Foundation 2010 | SharePoint Server 2010 | Visual Studio | Visual Studio 2010

この記事の内容
視覚的 Web パーツプロジェクトを作成する
LINQ to SharePoint プロキシコードを成する
データを SharePoint リストから読み出すコードを追加する
Web パーツを配置して Web パーツページに追加する
次の手順

この演習では、LINQ クエリを使用して 2 つのリストからデータを読み出し、DataGrid コントロール内に表示する視覚的 Web パーツを作成して配置します。このタスクを完了するには、以下の作業を実行します。

視覚的 Web パーツプロジェクトを作成する
LINQ to SharePoint プロキシコードを成する
データを SharePoint リストから読み出すコードを追加する
Web パーツを配置して Web パーツページに追加する

視覚的 Web パーツプロジェクトを作成する

このタスクでは、視覚的 Web パーツプロジェクトを Microsoft Visual Studio 2010 に作成します。

注意

以降のタスクは、既定の SharePoint Web サイトに Employees と Projects というタイトルのリストがあるものと想定しています。これら 2 つのリストの作成方法については、「リンクされているリストを SharePoint 2010 に作成する」を参照してください。

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

Visual Studio 2010 を起動して、[ファイル] をクリックし、[新規作成] をポイントし、[プロジェクト] をクリックします。
[インストールされているテンプレート] セクションの [Visual C#] ノードに移動して、[SharePoint]、[2010] の順にクリックします。
[視覚的 Web パーツ] プロジェクトテンプレートを選択し、プロジェクトの名前 (AccessSPDatawithLINQ など) と場所を入力して、[OK] をクリックします。
[デバッグに使用するローカルサイトを指定してください] ドロップダウンリストで、使用するサイト (https://localhost/sites/MySampleWebSite など) を選択します。[ファームソリューションとして配置する] オプションも選択して、[完了] をクリックします。

プロジェクトを作成すると、ソリューションエクスプローラーに VisualWebPart1 という名前の視覚的 Web パーツが表示されることに注目してください (図 1 を参照)。

図 1. ソリューションエクスプローラーで表示した AccessSPDatawithLINQ プロジェクト

LINQ to SharePoint プロキシコードを成する

このタスクでは、spmetal.exe コード生成ユーティリティを使用して、LINQ to SharePoint プロキシコードを生成します。このツールは、IntelliSense を取得し、LINQ ベースのクエリを SharePoint Server 2010 リストに対して実行できるようにするためのインターフェイスとして Visual Studio 2010 が使用するエンティティクラスコードを生成します。

LINQ プロキシコードを生成するには

ソリューションエクスプローラーで [AccessSPDatawithLINQ] を右クリックして、[Windows エクスプローラーでフォルダーを開く] をクリックします。
SHIFT キーを押しながらエクスプローラーウィンドウを右クリックし、[コマンドウィンドウをここで開く] をクリックして、現在のプロジェクトディレクトリでコマンドウィンドウを開きます。
コマンドウィンドウで以下のコマンドを入力し、ENTER キーを押して、SharePoint Server 2010 フォルダーのパスを設定します。

set path=%path%;c:\program files\common files\microsoft shared\web server extensions\14\bin
コマンドウィンドウで以下のコマンドを入力し、ENTER キーを押して、LINQ to SharePoint プロキシコードを生成します。SharePoint サイトの URL はユーザーのサイトの URL で置き換えます。

spmetal.exe /web:https://localhost/sites/MySampleWebSite /namespace:AccessSPDatawithLINQ.VisualWebPart1 /code:SPLinq.cs

このコマンドによって、AccessSPDatawithLINQ プロジェクトフォルダーに SPLinq.cs ファイルが作成されます。
コマンドウィンドウを閉じます。
今度はファイルをプロジェクトに追加します。Visual Studio プロジェクト画面に戻ります。
ソリューションエクスプローラーで [AccessSPDatawithLINQ] を右クリックし、[追加] をポイントして、[ 既存の項目] をクリックします。
[既存の項目の追加] ダイアログウィンドウで [SPLinq.cs] を選択し、[追加] をクリックします。
ソリューションエクスプローラーで [参照] を右クリックし、[参照の追加] をクリックします。
[参照] タブをクリックして、[ファイル名] ボックスに「C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\ISAPI」と入力します。
[Microsoft.SharePoint.Linq.dll] を選択し、[OK] をクリックします。

データを SharePoint リストから読み出すコードを追加する

このタスクでは、視覚的 Web パーツが SharePoint Server 2010 リストからデータを取得できるようにするコードをソリューションに追加します。

コードをプロジェクトに追加するには

ソリューションエクスプローラーで [VisualWebPart1] を展開して、[VisualWebPart1UserControl.ascx] をダブルクリックします。Visual Studio によって、視覚的 Web パーツユーザーコントロール用 HTML が表示されます。

以下のコードを既存のコードの下に追加して、グリッドビューを作成します。

<%@ Import Namespace="Microsoft.SharePoint.WebControls" %> 
<SharePoint:SPGridView id="spGridView" runat="server" AutoGenerateColumns="false"> 
  <HeaderStyle HorizontalAlign="Left" ForeColor="Navy" Font-Bold="true" /> 
  <Columns> 
    <SharePoint:SPBoundField  DataField="Title" HeaderText="Title"></SharePoint:SPBoundField> 
    <SharePoint:SPBoundField DataField="JobTitle" HeaderText="JobTitle"></SharePoint:SPBoundField> 
    <SharePoint:SPBoundField DataField="ProjectTitle" HeaderText="ProjectTitle"></SharePoint:SPBoundField> 
    <SharePoint:SPBoundField DataField="DueDate" HeaderText="DueDate"></SharePoint:SPBoundField> 
  </Columns> 
</SharePoint:SPGridView>

コードを追加すると、視覚的 Web パーツユーザーコントロール用 HTML は図 2 のようになります。

図 2. 視覚的 Web パーツユーザーコントロールの完全なコード

ビジュアル Web パーツユーザーコントロール内のコード

ソリューションエクスプローラーで [VisualWebPart1UserControl.ascx] を右クリックして、[コードの表示] をクリックします。
コード画面の先頭で、以下のステートメントをコードに追加します。
```
using Microsoft.SharePoint.Linq; 
using Microsoft.SharePoint; 
using System.Linq;
```

以下のコードを Page_Load メソッドの内側に挿入します。

SPLinqDataContext dc = new SPLinqDataContext(SPContext.Current.Web.Url);  
EntityList<EmployeesItem> Employees = dc.GetList<EmployeesItem>("Employees");  
var empQuery = from emp in Employees 
               where emp.Project.DueDate < DateTime.Now.AddMonths(6) 
               select new 
               { 
                   emp.Title, 
                   emp.JobTitle, 
                   ProjectTitle = emp.Project.Title, 
                   DueDate = emp.Project.DueDate.Value.ToShortDateString() 
               };  
spGridView.DataSource = empQuery; 
spGridView.DataBind();

Web パーツを配置して Web パーツページに追加する

このタスクでは、Web パーツを配置して SharePoint Server 2010 Web サイト上のホームページに追加します。

視覚的 Web パーツを展開してテストするには

ソリューションエクスプローラーで [AccessSPDatawithLINQ] を右クリックして、[配置] をクリックします。これにより、視覚的 Web パーツが作成され、前に指定した SharePoint サイトに配置されます。
Internet Explorer を起動して SharePoint サイトに移動します。
ホームページ上部の [編集] アイコンをクリックして、ページの編集を開始します。
リボンの [編集ツール] タブで、[挿入]、[Web パーツ] の順にクリックします。
図 3 に示すように、[カテゴリ] セクションで [カスタム] をクリックし、[Web パーツ] セクションで [SPLinqDemoTitle] をクリックし、[追加] をクリックします。

図 3. SPlinqDemoTitle Web パーツを選択する

これにより、図 4 に示すように、SPLinqDemoTitle Web パーツがホームページに追加されます。

図 4. ホームページに追加された SPLinqDemoTitle Web パーツ
リボンの [編集の終了] をクリックし、ページを保存して編集を終了します。
Internet Explorer を閉じます。

LINQ を使用して SharePoint 2010 Web パーツでデータにアクセスする

視覚的 Web パーツ プロジェクトを作成する

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

LINQ to SharePoint プロキシ コードを成する

LINQ プロキシ コードを生成するには