クライアント側オブジェクトモデルを実装する

[アーティクル]
06/15/2015

最終更新日: 2011年2月7日

適用対象: SharePoint Foundation 2010

このチュートリアルの前半の「SharePoint Foundation REST インターフェイスを実装する」では、ADO.NET Data Services および SharePoint Foundation REST インターフェイスを使用して、リストおよびライブラリに格納されているデータを操作する方法について説明しています。ただし、REST インターフェイスでは、より高度なアプリケーションで必要な場合に、SharePoint Foundation サイトの他のデータにアクセスすることができません。前のバージョンの SharePoint Foundation では、既定の Web サービスを使用してデータにアクセスし、ラッパークラスを定義して、返された SOAP XML をアプリケーションのオブジェクトに変換していました。Microsoft SharePoint Foundation 2010 には、マネージクライアント側オブジェクトモデルが導入され、オブジェクト階層内の Web サイトレベルまたはその下位のレベルで、新しい REST インターフェイスよりも幅広い SharePoint Foundation オブジェクトにアクセスできます。また、このオブジェクトモデルにより、Web サービスを使用するよりも簡単に、リモートアプリケーションでデータを操作できるようになりました。

この例では、「SharePoint Foundation REST インターフェイスを実装する」で説明した Windows Forms アプリケーションが作成されていることを前提としています。この例では、クライアントオブジェクトモデルを使用してフォームのタイトルバーを Web サイトのタイトルに設定し、さらに、ユーザーがフォームの [Star Project] ボタンをクリックしたときに、選択されているプロジェクトアイテムに基づいて、サイトの Projects リストの説明を変更します。

クライアントオブジェクトモデルを使用してフォームのタイトルおよびリストの説明を変更する

2 つのクライアントモデルアセンブリ、Microsoft.SharePoint.Client.dll および Microsoft.SharePoint.Client.Runtime.dll への参照を追加します。ソリューションエクスプローラーで [参照] を右クリックし、[参照の追加] をクリックします。[参照の追加] ダイアログボックスの [.NET] タブで、[Microsoft.SharePoint.Client] および [Microsoft.SharePoint.Client.Runtime] を選択します。次に、[OK] をクリックします。

Form1.cs または Form1.vb で、ステートメントを追加し、Microsoft.SharePoint.Client 名前空間をプロジェクトにインポートします。次のように、ClientContext() コンストラクターを使用して Web サイトに接続し、クライアントコンテキストを使用してクライアントオブジェクトモデルにアクセスします。

Imports ProjectTracker.ServiceReference1
Imports System.Net
Imports Microsoft.SharePoint.Client

Public Class Form1

    Private Shared websiteUrl As String = "http://YourServer/sites/YourSiteCollection/YourWebSite"

    Private context As New TestWebsDataContext(
        New Uri(websiteUrl  + "/_vti_bin/listdata.svc"))

    Private clientContext As New ClientContext(websiteUrl)

    Public Sub New()
        InitializeComponent()
    End Sub

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using Microsoft.SharePoint.Client;

namespace ProjectTracker
{
    using ServiceReference1;
    using System.Net;

    public partial class Form1 : Form
    {

        private static string websiteUrl= "http://YourServer/sites/YourSiteCollection/YourWebSite";

        TestWebsDataContext context = new TestWebsDataContext(
            new Uri(websiteUrl + "/_vti_bin/listdata.svc"));

        ClientContext clientContext = new ClientContext(websiteUrl);

        public Form1()
        {
            InitializeComponent();
        }

Form1_Load イベントを使用して、要求を SharePoint Foundation サーバーに送信します。既定の資格情報がクライアントオブジェクトモデルによって自動的に使用されます。オブジェクトを使用するには、Load<T>(T, []) メソッドを呼び出してオブジェクトのプロパティの読み込みを明示的に要求し、ExecuteQuery() メソッド (Microsoft Silverlight バージョンのオブジェクトモデルでは ExecuteQueryAsync(ClientRequestSucceededEventHandler, ClientRequestFailedEventHandler) メソッド) を呼び出してその要求を SharePoint Foundation に送信し、Web サイトオブジェクトにデータを設定します。次のスニペットでは、フォームのタイトルバーが Web サイトのタイトルに設定されます。

    Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
        context.Credentials = CredentialCache.DefaultCredentials

        ProjectsBindingSource.DataSource = context.Projects

        clientContext.Load(clientContext.Web)
        clientContext.ExecuteQuery()
        Me.Text = clientContext.Web.Title
    End Sub

    Private Sub ProjectsBindingSource_CurrentChanged(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles ProjectsBindingSource.CurrentChanged
        EmployeesBindingSource.DataSource =
            From emp In context.Employees _
            Where emp.Project.Id = DirectCast(ProjectsBindingSource.Current, ProjectsItem).Id _
            Select emp
    End Sub

    Private Sub ProjectsBindingSource_CurrentItemChanged(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles ProjectsBindingSource.CurrentItemChanged
        context.UpdateObject(ProjectsBindingSource.Current)
    End Sub

    Private Sub ProjectsBindingNavigatorSaveItem_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles ProjectsBindingNavigatorSaveItem.Click
        context.SaveChanges()
    End Sub

        private void Form1_Load(object sender, EventArgs e)
        {
            context.Credentials = CredentialCache.DefaultCredentials;
            projectsBindingSource.DataSource = context.Projects;

            clientContext.Load(clientContext.Web);
            clientContext.ExecuteQuery();

            this.Text = clientContext.Web.Title;

        }

        private void projectsBindingSource_CurrentChanged(object sender, EventArgs e)
        {
            employeesBindingSource.DataSource =
                from emp in context.Employees
                where emp.Project.Id == ((ProjectsItem)projectsBindingSource.Current).Id
                select emp;
        }

        private void projectsBindingNavigatorSaveItem_Click(object sender, EventArgs e)
        {
            context.SaveChanges();
        }

        private void projectsBindingSource_CurrentItemChanged(object sender, EventArgs e)
        {
            context.UpdateObject(projectsBindingSource.Current);
        }

この例では、フォームのタイトルを変更するほかに、ユーザーの選択に基づいて Web サイトに表示される Projects リストの説明も変更します。ユーザーが Projects リストでアイテムを選択してボタンをクリックすると、選択されているプロジェクトが強調表示されるようにリストの説明が変更されます。ボタンを Form1 に追加するには、[保存] ボタンの横にあるフォームタイトルバーを右クリックし、表示されたドロップダウンリストで [ボタン] を選択します。
ボタンの [プロパティ] ウィンドウで、[表示スタイル] を [テキスト] に設定し、[テキスト] 設定の値として「Star Project」と入力します。

フォームのボタンをダブルクリックして Click イベントを開き、次のコードを追加します。このスニペットは、クライアントオブジェクトモデルの GetByTitle(String) メソッドを使用してリストを返し、その説明にアクセスします。この例では、ADO.NET Data Services Projects データソースを使用して、現在選択されているプロジェクトのタイトルを取得し、選択されているアイテムを ProjectsItem オブジェクトとしてキャストして、そのアイテムの Title プロパティにアクセスします。

    Private Sub ToolStripButton1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles ToolStripButton1.Click
        Dim oList As List = clientContext.Web.Lists.GetByTitle("Projects")

        oList.Description = String.Format("Star Project of the Week is {0}!!!", DirectCast(ProjectsBindingSource.Current, ProjectsItem).Title)

        oList.Update()
        clientContext.ExecuteQuery()
    End Sub
End Class

        private void toolStripButton1_Click(object sender, EventArgs e)
        {
            List oList = clientContext.Web.Lists.GetByTitle("Projects");

            oList.Description = string.Format("Star Project of the Week is {0}!!!",
                ((ProjectsItem)projectsBindingSource.Current).Title);

            oList.Update();
            clientContext.ExecuteQuery();
        }
}}

F5 キーを押してアプリケーションを実行し、フォームのタイトルが変更されていることを確認します。プロジェクトの DataGridView コントロールでアイテムの 1 つを選択し、[Star Project] をクリックすると、リストの説明が変更されます。

完全な Form1 コード例については、「SharePoint Foundation の WCF Form1 サンプルを完了する」を参照してください。

クライアント側オブジェクトモデルを実装する

クライアントオブジェクトモデルを使用してフォームのタイトルおよびリストの説明を変更する

関連項目

概念

その他の技術情報

その他のリソース

クライアント側オブジェクト モデルを実装する

クライアント オブジェクト モデルを使用してフォームのタイトルおよびリストの説明を変更する

関連項目

概念

その他の技術情報

その他のリソース

クライアント側オブジェクトモデルを実装する

クライアントオブジェクトモデルを使用してフォームのタイトルおよびリストの説明を変更する