SharePoint のクライアントライブラリコードを使用して基本的な操作を完了する

[アーティクル]
04/08/2023

SharePoint クライアントオブジェクトモデル (CSOM) を使用して、SharePoint でデータを取得、更新、および管理できます。 SharePoint では、次のようなさまざまな形で CSOM を使用できます。

.NET Framework 再頒布可能アセンブリ
JavaScript ライブラリ (JSOM)
REST/OData エンドポイント
Windows Phone アセンブリ (非推奨)
Silverlight 再頒布可能アセンブリ (非推奨)

SharePoint プラットフォームで利用できる API セットの詳細については、「SharePoint で適切な API セットを選択する」を参照してください。

この記事では、.NET Framework オブジェクトモデルを使用して基本的な操作を実行する方法を説明します。これは、NuGet gallery で再配布可能なパッケージとして利用できます。

その他のクライアント API の使用方法については、次を参照してください。

SharePoint .NET クライアントオブジェクトモデルを使用した基本的な操作

以降のセクションで、プログラムで完了できるタスクについて説明します。説明には、CSOM の操作を例示する C# コード例が含まれます。

Visual Studio 2012 で SharePoint 用のアドインを作成すると、.NET Framework アセンブリ、Microsoft.SharePoint.Client.Runtime.dll、Microsoft.SharePoint.Client.dll への参照がプロジェクトに自動的に追加されます。 .NET Framework アプリケーションやコンソールアプリケーションなどの他の種類のプロジェクトでは、これらの参照を追加する必要があります。どの SharePoint サーバーでも、ファイルは %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\ISAPI にあります。

これらの例では、コードは Microsoft ASP.NET Web ページ用の分離コードファイルに記述するものとします。次の using ステートメントをコードファイルに追加する必要があります。

using Microsoft.SharePoint.Client;

特に明記しない限り、これらの例は、ページのクラスに定義されるパラメーターなしメソッド内に記述するものとします。また、label1、label2 などは、ページの Label オブジェクトの名前です。

注:

プロバイダー向けのホスト型 SharePoint アドインを ASP.NET Web アプリケーションで作成する際に、アセンブリへの参照を Visual Studio でこの Web アプリケーションプロジェクトに追加する場合は、アセンブリが Web サーバーにインストール済みであるか、アドインの展開前にインストールされることが確実な場合を除き、アセンブリの Copy Local プロパティを True に設定します。

.NET Framework は、Microsoft Azure Web ロールと Azure Web サイトにインストールされます。ただし、SharePoint クライアントアセンブリと、各種の Microsoft マネージコード拡張機能や基盤はインストールされません。 Office Developer Tools for Visual Studio 2012 は、SharePoint アドインでよく使われるいくつかのアセンブリへの参照を自動的に追加し、Copy Local プロパティを設定します。

SharePoint Web サイトのタスク

以下の例は、.NET Framework CSOM を使用して Web サイトに関連するタスクを完了する方法を示しています。

Web サイトのプロパティを取得する

SharePoint Web サイトのタイトルを取得します。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// The SharePoint web at the URL.
Web web = context.Web;

// We want to retrieve the web's properties.
context.Load(web);

// Execute the query to the server.
context.ExecuteQuery();

// Now, the web's properties are available and we could display
// web properties, such as title.
label1.Text = web.Title;

Web サイトの選択したプロパティのみを取得する

クライアントの関心が、オブジェクトの一部のプロパティのみにある場合があります。 SharePoint .NET Framework CSOM では、サーバー上のオブジェクトからすべてのプロパティを取得する必要はありません。ラムダ式を使用できる匿名メソッドを使用して、特定のプロパティ名を要求できます。クライアントライブラリは、サーバー上で要求されたプロパティのみのクエリを実行し、サーバーはそれらのプロパティのみをクライアントに送信します。このテクニックを使うと、クライアントとサーバー間の不要なデータ転送を削減できます。また、オブジェクトのその他の未使用プロパティの中に、ユーザーがアクセス許可を持っていないものがある場合にも有用です。

System.Linq 用の using ステートメントを追加する必要があります。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// The SharePoint web at the URL.
Web web = context.Web;

// We want to retrieve the web's title and description.
context.Load(web, w => w.Title, w => w.Description);

// Execute the query to server.
context.ExecuteQuery();

// Now, only the web's title and description are available. If you
// try to print out other properties, the code will throw
// an exception because other properties aren't available.
label1.Text = web.Title;
label1.Text = web.Description;

注:

他のプロパティにアクセスしようとした場合、他のプロパティは使用できないため、このコードは例外をスローします。

Web サイトのプロパティに書き込む

次の例は、Web サイトのプロパティに書き込む方法を示しています。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// The SharePoint web at the URL.
Web web = context.Web;

web.Title = "New Title";
web.Description = "New Description";

// Note that the web.Update() doesn't trigger a request to the server.
// Requests are only sent to the server from the client library when
// the ExecuteQuery() method is called.
web.Update();

// Execute the query to server.
context.ExecuteQuery();

新しい SharePoint Web サイトを作成する

次の例は、新しい SharePoint サイトを、現在の Web サイトのサブサイトとして作成する方法を示しています。 WebCreationInformation クラスを使用して、新しい Web サイトを作成します。 System.Collections.Generic および System.Text 用の using ステートメントも追加する必要があります。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

WebCreationInformation creation = new WebCreationInformation();
creation.Url = "web1";
creation.Title = "Hello web1";
Web newWeb = context.Web.Webs.Add(creation);

// Retrieve the new web information.
context.Load(newWeb, w => w.Title);
context.ExecuteQuery();

label1.Text = newWeb.Title;

SharePoint リストのタスク

以下の例は、.NET Framework CSOM を使用して、リストに関連するタスクを完了する方法を示しています。

Web サイト内のすべての SharePoint リストを取得する

次の例では、SharePoint Web サイト内のすべての SharePoint リストを取得します。このコードをコンパイルするには、System.Linq 用の using ステートメントを追加する必要があります。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// The SharePoint web at the URL.
Web web = context.Web;

// Retrieve all lists from the server.
// For each list, retrieve Title and Id.
context.Load(web.Lists,
             lists => lists.Include(list => list.Title,
                                    list => list.Id));

// Execute query.
context.ExecuteQuery();

// Enumerate the web.Lists.
foreach (List list in web.Lists)
{
  label1.Text = label1.Text + ", " + list.Title;
}

注:

あるいは、web.Lists プロパティではなく LoadQuery メソッドを使用して、戻り値を別のコレクションに格納することもできます。 System.Collections.Generic および System.Linq 用の using ステートメントも追加する必要があります。さらに、Microsoft.SharePoint.Client 名前空間用の using ステートメントに対するエイリアスを追加して、そのクラスを明確に参照できるようにします。たとえば、using SP = Microsoft.SharePoint.Client; などです。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// The SharePoint web at the URL.
Web web = context.Web;

// Retrieve all lists from the server, and put the return value in another
// collection instead of the web.Lists.
IEnumerable<SP.List> result = context.LoadQuery(
  web.Lists.Include( 
      // For each list, retrieve Title and Id.
      list => list.Title,
      list => list.Id
  )
);

// Execute query.
context.ExecuteQuery();

// Enumerate the result.
foreach (List list in result)
{
  label1.Text = label1.Text + ", " + list.Title;
}

SharePoint リストを作成および更新する

次の例では、ListCreationInformation クラスを使用して、SharePoint リストの作成と更新を行います。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// The SharePoint web at the URL.
Web web = context.Web;

ListCreationInformation creationInfo = new ListCreationInformation();
creationInfo.Title = "My List";
creationInfo.TemplateType = (int)ListTemplateType.Announcements;
List list = web.Lists.Add(creationInfo);
list.Description = "New Description";

list.Update();
context.ExecuteQuery();

SharePoint リストを削除する

次の例では、SharePoint リストを削除します。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// The SharePoint web at the URL.
Web web = context.Web;

List list = web.Lists.GetByTitle("My List");
list.DeleteObject();

context.ExecuteQuery();

SharePoint リストにフィールドを追加する

次の例では、SharePoint リストにフィールドを追加します。 Microsoft.SharePoint.Client 名前空間用の using ステートメントに対するエイリアスを追加して、そのクラスを明確に参照できるようにします。たとえば、using SP = Microsoft.SharePoint.Client; などです。

注:

この例では、context.CastTo を使用してキャストを行います。クライアントライブラリは、クエリの実行前は、返されるオブジェクト "フィールド" の実際の型がわからないため、SharePoint.Field が唯一の可能な型になります。実際の型がわかっている場合は、ClientContext.CastTo<RealType> メソッドを使用してオブジェクトをキャストできます。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

SP.List list = context.Web.Lists.GetByTitle("Announcements");

SP.Field field = list.Fields.AddFieldAsXml("<Field DisplayName='MyField2' Type='Number' />",
                                           true,
                                           AddFieldOptions.DefaultValue);
SP.FieldNumber fldNumber = context.CastTo<FieldNumber>(field);
fldNumber.MaximumValue = 100;
fldNumber.MinimumValue = 35;
fldNumber.Update();

context.ExecuteQuery();

SharePoint リストアイテムのタスク

以下の例は、.NET Framework CSOM を使用して、リストアイテムに関連するタスクを完了する方法を示しています。

SharePoint リストからアイテムを取得する

次の例では、SharePoint リスト内のアイテムを取得します。 Microsoft.SharePoint.Client.QueryExpression 用の using ステートメントも追加する必要があります。

注:

FolderServerRelativeUrl プロパティを使用して、特定のフォルダーに返されるアイテムを制限できます。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// Assume the web has a list named "Announcements".
List announcementsList = context.Web.Lists.GetByTitle("Announcements");

// This creates a CamlQuery that has a RowLimit of 100, and also specifies Scope="RecursiveAll"
// so that it grabs all list items, regardless of the folder they are in.
CamlQuery query = CamlQuery.CreateAllItemsQuery(100);
ListItemCollection items = announcementsList.GetItems(query);

// Retrieve all items in the ListItemCollection from List.GetItems(Query).
context.Load(items);
context.ExecuteQuery();
foreach (ListItem listItem in items)
{
  // We have all the list item data. For example, Title.
  label1.Text = label1.Text + ", " + listItem["Title"];
}

新しいリストアイテムを作成する

次の例では、ListItemCreationInformation クラスを使用して新しい SharePoint リストアイテムを作成します。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// Assume that the web has a list named "Announcements".
List announcementsList = context.Web.Lists.GetByTitle("Announcements");

// We are just creating a regular list item, so we don't need to
// set any properties. If we wanted to create a new folder, for
// example, we would have to set properties such as
// UnderlyingObjectType to FileSystemObjectType.Folder.
ListItemCreationInformation itemCreateInfo = new ListItemCreationInformation();
ListItem newItem = announcementsList.AddItem(itemCreateInfo);
newItem["Title"] = "My New Item!";
newItem["Body"] = "Hello World!";
newItem.Update();

context.ExecuteQuery();

リストアイテムを更新する

次の例では、SharePoint リストアイテムを更新します。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// Assume that the web has a list named "Announcements".
List announcementsList = context.Web.Lists.GetByTitle("Announcements");

// Assume there is a list item with ID=1.
ListItem listItem = announcementsList.GetItemById(1);

// Write a new value to the Body field of the Announcement item.
listItem["Body"] = "This is my new value!!";
listItem.Update();

context.ExecuteQuery();

リストアイテムを削除する

次の例では、SharePoint リストアイテムを削除します。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// Assume that the web has a list named "Announcements".
List announcementsList = context.Web.Lists.GetByTitle("Announcements");

// Assume that there is a list item with ID=2.
ListItem listItem = announcementsList.GetItemById(2);
listItem.DeleteObject();

context.ExecuteQuery(); }

SharePoint フィールドタスク

以下の例は、SharePoint .NET Framework CSOM を使用して、フィールドに関連するタスクを完了する方法を示しています。

リスト内のすべてのフィールドを取得する

次の例では、SharePoint リスト内のすべてのフィールドを取得します。さらに、Microsoft.SharePoint.Client 名前空間用の using ステートメントに対するエイリアスを追加して、そのクラスを明確に参照できるようにする必要もあります。たとえば、using SP = Microsoft.SharePoint.Client; などです。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

SP.List list = context.Web.Lists.GetByTitle("Shared Documents");
context.Load(list.Fields);

// We must call ExecuteQuery before enumerate list.Fields.
context.ExecuteQuery();

foreach (SP.Field field in list.Fields)
{
  label1.Text = label1.Text + ", " + field.InternalName;
}

リストから特定のフィールドを取得する

特定のフィールドに関する情報を取得する場合は、Fields.GetByInternalNameOrTitle メソッドを使用します。このメソッドの戻り値の型は Field です。クライアントは、クエリの実行前はオブジェクトの型がわからないため、それを派生型にキャストするための C# 構文は使用できません。したがって、ClientContext.CastTo メソッドを使用してキャストを行い、クライアントライブラリにオブジェクトを再作成するように命令します。 System.Collections.Generic 用の using ステートメントも追加する必要があります。さらに、Microsoft.SharePoint.Client 名前空間用の using ステートメントに対するエイリアスを追加して、そのクラスを明確に参照できるようにする必要もあります。たとえば、using SP = Microsoft.SharePoint.Client; などです。

注:

この例で使用されている GetByInternalNameOrTitle メソッドは、リモートメソッドです。クライアントコレクションが既に入力されている場合でも、クライアントコレクションのデータを使用することはありません。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

SP.List list = context.Web.Lists.GetByTitle("Shared Documents");
SP.Field field = list.Fields.GetByInternalNameOrTitle("Title");
FieldText textField = context.CastTo<FieldText>(field);
context.Load(textField);
context.ExecuteQuery();

// Now, we can access the specific text field properties.
label1.Text = textField.MaxLength;

SharePoint ユーザータスク

SharePoint .NET Framework CSOM を使用して、SharePoint ユーザー、グループ、およびユーザーセキュリティを管理できます。

SharePoint グループにユーザーを追加する

次の例では、Members という名前の SharePoint グループに、ユーザーとユーザー情報を追加します。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

GroupCollection siteGroups = context.Web.SiteGroups;

// Assume that there is a "Members" group, and the ID=5.
Group membersGroup = siteGroups.GetById(5);

// Let's set up the new user info.
UserCreationInformation userCreationInfo = new UserCreationInformation();
userCreationInfo.Email = "user@domain.com";
userCreationInfo.LoginName = "domain\\user";
userCreationInfo.Title = "Mr User";

// Let's add the user to the group.
User newUser = membersGroup.Users.Add(userCreationInfo);

context.ExecuteQuery();

SharePoint グループ内のすべてのユーザーを取得する

次の例では、Members という名前の SharePoint グループからすべてのユーザーに関する情報を取得します。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

GroupCollection siteGroups = context.Web.SiteGroups;

// Assume that there is a "Members" group, and the ID=5.
Group membersGroup = siteGroups.GetById(5);
context.Load(membersGroup.Users);
context.ExecuteQuery();

foreach (User member in membersGroup.Users)
{
  // We have all the user info. For example, Title.
  label1.Text = label1.Text + ", " + member.Title;
}

ロールを作成する

次の例では、アラートのアクセス許可を作成して管理するロールを作成します。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

BasePermissions perm = new BasePermissions();
perm.Set(PermissionKind.CreateAlerts);
perm.Set(PermissionKind.ManageAlerts);

RoleDefinitionCreationInformation creationInfo = new RoleDefinitionCreationInformation();
creationInfo.BasePermissions = perm;
creationInfo.Description = "A role with create and manage alerts permission";
creationInfo.Name = "Alert Manager Role";
creationInfo.Order = 0;
RoleDefinition rd = context.Web.RoleDefinitions.Add(creationInfo);

context.ExecuteQuery();

ロールにユーザーを追加する

次の例では、ロールにユーザーを追加します。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

// Assume that we have a SiteUser with Login user.
Principal user = context.Web.SiteUsers.GetByLoginName(@"domain\user");

// Assume that we have a RoleDefinition named "Read".
RoleDefinition readDef = context.Web.RoleDefinitions.GetByName("Read");
RoleDefinitionBindingCollection roleDefCollection = new RoleDefinitionBindingCollection(context);
roleDefCollection.Add(readDef);
RoleAssignment newRoleAssignment = context.Web.RoleAssignments.Add(user, roleDefCollection);

context.ExecuteQuery();

SharePoint .NET クライアントオブジェクトモデルを使用するための規則とベストプラクティス

以下の例は、SharePoint .NET Framework CSOM を使用する際に従う必要がある重要なベストプラクティスと要件を示しています。

値のプロパティにアクセスする前に ClientContext.ExecuteQuery を呼び出す

SharePoint .NET Framework CSOM では、SQL に似たプログラミングパターンを使用する必要があります。つまり、データにアクセスする前に、必要なものを宣言して、クエリを実行することが必要です。たとえば、SharePoint Web サイトのタイトル表示を試行する次のコードは、例外をスローします。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

Web web = context.Web;
label1.Text = web.Title;

このコードは失敗するのは、SharePoint .NET Framework CSOM コードが次の要件を満たしていないためです。

アドホック SQL クエリまたはストアドプロシージャをビルドする。
SQL クエリを実行する
SQL から結果を読み込む

SharePoint .NET Framework CSOM では、メソッドの呼び出し時にクエリをビルドします。クエリが累積され、呼び出されるまで ExecuteQuery サーバーに送信されません。

次の例は、Web サイトのタイトルを表示するために必要なコードを示しています。 System.Linq 用の using ステートメントも追加する必要があります。さらに、Microsoft.SharePoint.Client 名前空間用の using ステートメントに対するエイリアスを追加して、そのクラスを明確に参照できるようにします。たとえば、using SP = Microsoft.SharePoint.Client; などです。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

Web web = context.Web;

context.Load(web, w => w.Title);

context.ExecuteQuery();

label1.Text = web.Title;

違いは、以下の行の追加です。1 行目は Web の Title プロパティ用のクエリを作成します。 2 行目はクエリを実行します。

context.Load(web, w => w.Title);
context.ExecuteQuery();

同じクエリ内のメソッドまたはプロパティから返された値オブジェクトは使用しない

メソッドまたはプロパティから値オブジェクトが返される場合、クエリを実行し終わるまでそのオブジェクトは使用できません。たとえば、次のコードは、親 Web サイトと同じタイトルの SharePoint リストの作成を試行しますが、例外をスローします。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

Web web = context.Web;
ListCreationInformation creationInfo = new ListCreationInformation();
creationInfo.TemplateType = (int)ListTemplateType.Announcements;
creationInfo.Description = web.Title;
creationInfo.Title = web.Title;
List newList = web.Lists.Add(creationInfo);

例外がスローされるのは、クエリの実行前は、プロパティを使用できないためです。 SQL では、web.Title の値を保持するローカル変数を宣言し、そのローカル変数を Web の作成に使用します。クライアントライブラリでは、ローカル変数は作成できません。次の例に示すように、機能を 2 つの独立したクエリに分割する必要があります。 System.Linq 用の using ステートメントも追加する必要があります。さらに、Microsoft.SharePoint.Client 名前空間用の using ステートメントに対するエイリアスを追加して、そのクラスを明確に参照できるようにします。たとえば、using SP = Microsoft.SharePoint.Client; などです。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

Web web = context.Web;

context.Load(web, w => w.Title, w => w.Description);

context.ExecuteQuery();

ListCreationInformation creationInfo = new ListCreationInformation();
creationInfo.TemplateType = (int)ListTemplateType.Announcements;
creationInfo.Description = web.Description;
creationInfo.Title = web.Title;
SP.List newList = web.Lists.Add(creationInfo);

context.ExecuteQuery();

違いは、次の 3 行です。

context.Load(web, w => w.Title, w => w.Description);
context.ExecuteQuery();
// ...
context.ExecuteQuery();

クライアントオブジェクトを返すメソッドまたはプロパティを、同じクエリ内の別のメソッド呼び出しで使用する

値オブジェクトとは異なり、クライアントオブジェクトは、同じクエリ内の別のメソッドの中で使用できます。

.NET リモート処理では、値オブジェクトは値によってマーシャリングされるクラスまたは構造体であり、クライアントオブジェクトは参照によってマーシャリングされるクラスまたは構造体です。たとえば、ListItem はクライアントオブジェクトであり、UrlFieldValue およびその他のフィールド値は値オブジェクトです。

クライアントライブラリでは、対応するサーバーオブジェクトに [ClientCallable(ValueObject = true)] 属性が設定されます。これらの値は、プロパティのみを持ち、メソッドがない場合があります。 strings や ints などのプリミティブ型は、値オブジェクトとして処理されます。すべての値は、クライアントとサーバー間でマーシャリングされます。 ValueObject の既定値は false です。

値オブジェクトに対応するのはクライアントオブジェクトです。対応するサーバーオブジェクトに [ClientCallable(ValueObject = false)] 属性がある場合、オブジェクトはクライアントオブジェクトです。クライアントオブジェクトの場合、オブジェクトの作成方法を追跡します。これは、クライアントライブラリの実装では ObjectPath と呼ばれます。たとえば、次のようなコードがあるとします。

ClientContext context = new ClientContext("https://{site_url}");
Web web = context.Web;
SP.List list = web.Lists.GetByTitle("Announcements");

このリストは、以下の手順で作成されることがわかっています。

コンテキストから Web プロパティを取得する
上の結果から Lists プロパティを取得する
上の結果から Announcements パラメーターを使用して GetByTitle メソッドを呼び出す

SharePoint .NET Framework CSOM からサーバーにこの情報が渡されると、サーバー上でオブジェクトを再作成できます。クライアントライブラリでは、クライアントオブジェクトが作成される ObjectPath を追跡できます。オブジェクトの作成方法はわかっているので、オブジェクトをパラメーターとして使用して、同じクエリ内で別のメソッドを呼び出すことができます。

同じオブジェクトに関するデータの取得をグループ化してパフォーマンスを向上させる

同じオブジェクトから複数のデータを読み取る場合は、1 つのクエリですべてのデータを取得する必要があります。つまり、メソッドの 1 回の Load<T>(T, []) 呼び出しです。次のコードは、Web サイトのタイトルと説明、および Announcements リストの説明を取得するための 2 つの方法を示しています。このコードをコンパイルするには、System.Linq 用の using ステートメントを追加する必要があります。さらに、Microsoft.SharePoint.Client 名前空間用の using ステートメントに対するエイリアスを追加して、そのクラスを明確に参照できるようにします。たとえば、using SP = Microsoft.SharePoint.Client; などです。

static void Method1()
{
  ClientContext context = new ClientContext("https://{site_url}");
  Web web = context.Web;
  SP.List list = web.Lists.GetByTitle("Announcements");
  context.Load(web, w => w.Title, w => w.Description);
  context.Load(list, l => l.Description);
  context.ExecuteQuery();
}

static void Method2()
{
  ClientContext context = new ClientContext("https://{site_url}");
  Web web = context.Web;
  SP.List list = web.Lists.GetByTitle("Announcements");
  context.Load(web, w => w.Title);
  context.Load(list, l => l.Description);
  context.Load(web, w => w.Description);
  context.ExecuteQuery();
}

これらの効率は同じではありません。 Method1 では、Web のタイトルと説明を取得するコードがグループ化されています。 Method2 では、Web のタイトルと説明を取得するコードが他のアクションによって分離されています。つまり、Method2 では、同じ Web オブジェクトに関して 2 つの独立したクエリがトリガーされ、同じ Web に対する 2 つの結果セットが存在することになります。クライアントライブラリは一貫性のあるデータを返そうとするため、2 つ目の結果セットにはタイトルと説明の両方が含まれます。前のコードは、次のように見なすことができます。

// Method1:
SELECT Title, Description FROM Webs WHERE ...
SELECT Description FROM Lists WHERE …

// Method2:
SELECT Title FROM Webs WHERE …
SELECT Description FROM Lists WHERE …
SELECT Title, Description FROM Webs WHERE …

オブジェクトのどのプロパティを返すかを指定する

SharePoint サーバーオブジェクトモデルでは、SPWeb オブジェクトを取得する場合は、そのプロパティをすべて検査できます。 SQL では、テーブルのすべての列を取得するには、次のコマンドを実行します。

SELECT * FROM Webs

クライアントライブラリでは、Load<T> も他のメソッドも、すべてのプロパティを返すことはないため、目的のプロパティを明示的に指定する必要があります。たとえば、次のコードは、返すプロパティを指定せずに Web サイトオブジェクトを取得します。その後、2 つのプロパティを読み込もうとしていますが、そのうちの 1 つは Load によって自動的に返されるプロパティには含まれていません。このコードは例外をスローします。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

Web web = context.Web;
context.Load(web);
context.ExecuteQuery();

Console.WriteLine(web.Title);
Console.WriteLine(web.HasUniqueRoleAssignments);

このコードのコンパイルを成功させるには、コードを次のように更新します。このコードをコンパイルするには、System.Linq 用の using ステートメントを追加する必要があります。さらに、Microsoft.SharePoint.Client 名前空間用の using ステートメントに対するエイリアスを追加して、そのクラスを明確に参照できるようにします。たとえば、using SP = Microsoft.SharePoint.Client; などです。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

Web web = context.Web;
context.Load(web);
context.Load(web, web => web.HasUniqueRoleAssignments);
context.ExecuteQuery();

Console.WriteLine(web.Title);
Console.WriteLine(web.HasUniqueRoleAssignments);

データを読み込む前に条件範囲を使用して前提条件をテストする

コードを条件付きで実行するには、ConditionalScope オブジェクトを使用して、条件範囲を設定します。たとえば、リストが null 以外の場合にリストのプロパティを取得します。 System.Collections.Generic および System.Linq 用の using ステートメントも追加する必要があります。さらに、Microsoft.SharePoint.Client 名前空間用の using ステートメントに対するエイリアスを追加して、そのクラスを明確に参照できるようにします。たとえば、using SP = Microsoft.SharePoint.Client; などです。

注:

条件範囲内でメソッドの呼び出しとプロパティの設定を行うことは許可されていません。これは、クライアントライブラリでは、メソッドの呼び出しとプロパティの設定の副作用を追跡しないためです。条件範囲の中では、Load のみを使用する必要があります。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

SP.List list = context.Web.GetCatalog(ListTemplateType.WebPartCatalog);
BasePermissions perm = new BasePermissions();
perm.Set(PermissionKind.ManageLists);

ConditionalScope scope =
    new ConditionalScope(context,
                         () => list.ServerObjectIsNull &amp;&amp; context.Web.DoesUserHavePermissions(perm).Value);
using (scope.StartScope())
{
  context.Load(list, l => l.Title);
}
context.ExecuteQuery();

label1.Text = scope.TestResult.Value;

if (scope.TestResult.Value)
{
  label1.Text = list.Title;
}

例外処理範囲を使用して例外をキャッチする

次の例は、ExceptionHandlingScope オブジェクトを使用して例外処理範囲を作成および使用する方法を示しています。このシナリオは、リストの説明を更新し、フォルダーも作成できるようにするものです。リストは存在しない可能性もあります。

// Starting with ClientContext, the constructor requires a URL to the
// server running SharePoint.
ClientContext context = new ClientContext("https://{site_url}");

ExceptionHandlingScope scope = new ExceptionHandlingScope(context);

using (scope.StartScope())
{
  using (scope.StartTry())
  {
    List fooList = context.Web.Lists.GetByTitle("Sample");
    fooList.Description = "In Try Block";
    fooList.Update();
  }
  using (scope.StartCatch())
  {
    // Assume that if there's an exception,
    // it can be only because there was no "Sample" list.
    ListCreationInformation listCreateInfo = new ListCreationInformation();
    listCreateInfo.Title = "Sample";
    listCreateInfo.Description = "In Catch Block";
    listCreateInfo.TemplateType = (int)ListTemplateType.Announcements;
    List fooList = context.Web.Lists.Add(listCreateInfo);
  }
  using (scope.StartFinally())
  {
    List fooList = context.Web.Lists.GetByTitle("Sample");
    fooList.EnableFolderCreation = true;
    fooList.Update();
  }
}

context.ExecuteQuery();

次の方法で共有

SharePoint のクライアントライブラリコードを使用して基本的な操作を完了する

SharePoint .NET クライアントオブジェクトモデルを使用した基本的な操作

SharePoint Web サイトのタスク

Web サイトのプロパティを取得する

Web サイトの選択したプロパティのみを取得する

Web サイトのプロパティに書き込む

新しい SharePoint Web サイトを作成する

SharePoint リストのタスク

Web サイト内のすべての SharePoint リストを取得する

SharePoint リストを作成および更新する

SharePoint リストを削除する

SharePoint リストにフィールドを追加する

SharePoint リストアイテムのタスク

SharePoint リストからアイテムを取得する

新しいリストアイテムを作成する

リストアイテムを更新する

リストアイテムを削除する

SharePoint フィールドタスク

リスト内のすべてのフィールドを取得する

リストから特定のフィールドを取得する

SharePoint ユーザータスク

SharePoint グループにユーザーを追加する

SharePoint グループ内のすべてのユーザーを取得する

ロールを作成する

ロールにユーザーを追加する

SharePoint .NET クライアントオブジェクトモデルを使用するための規則とベストプラクティス

値のプロパティにアクセスする前に ClientContext.ExecuteQuery を呼び出す

同じクエリ内のメソッドまたはプロパティから返された値オブジェクトは使用しない

クライアントオブジェクトを返すメソッドまたはプロパティを、同じクエリ内の別のメソッド呼び出しで使用する

同じオブジェクトに関するデータの取得をグループ化してパフォーマンスを向上させる

オブジェクトのどのプロパティを返すかを指定する

データを読み込む前に条件範囲を使用して前提条件をテストする

例外処理範囲を使用して例外をキャッチする

関連項目

その他のリソース

次の方法で共有

SharePoint のクライアント ライブラリ コードを使用して基本的な操作を完了する

SharePoint .NET クライアント オブジェクト モデルを使用した基本的な操作

SharePoint Web サイトのタスク

Web サイトのプロパティを取得する

Web サイトの選択したプロパティのみを取得する

Web サイトのプロパティに書き込む

新しい SharePoint Web サイトを作成する

SharePoint リストのタスク

Web サイト内のすべての SharePoint リストを取得する

SharePoint リストを作成および更新する

SharePoint リストを削除する

SharePoint リストにフィールドを追加する

SharePoint リスト アイテムのタスク

SharePoint リストからアイテムを取得する

新しいリスト アイテムを作成する

リスト アイテムを更新する

リスト アイテムを削除する

SharePoint フィールド タスク

リスト内のすべてのフィールドを取得する

リストから特定のフィールドを取得する

SharePoint ユーザー タスク

SharePoint グループにユーザーを追加する

SharePoint グループ内のすべてのユーザーを取得する

ロールを作成する

ロールにユーザーを追加する

SharePoint .NET クライアント オブジェクト モデルを使用するための規則とベスト プラクティス

値のプロパティにアクセスする前に ClientContext.ExecuteQuery を呼び出す

同じクエリ内のメソッドまたはプロパティから返された値オブジェクトは使用しない

クライアント オブジェクトを返すメソッドまたはプロパティを、同じクエリ内の別のメソッド呼び出しで使用する

同じオブジェクトに関するデータの取得をグループ化してパフォーマンスを向上させる

オブジェクトのどのプロパティを返すかを指定する

データを読み込む前に条件範囲を使用して前提条件をテストする

例外処理範囲を使用して例外をキャッチする

関連項目

その他のリソース

SharePoint のクライアントライブラリコードを使用して基本的な操作を完了する

SharePoint .NET クライアントオブジェクトモデルを使用した基本的な操作

SharePoint リストアイテムのタスク

新しいリストアイテムを作成する

リストアイテムを更新する

リストアイテムを削除する

SharePoint フィールドタスク

SharePoint ユーザータスク

SharePoint .NET クライアントオブジェクトモデルを使用するための規則とベストプラクティス

クライアントオブジェクトを返すメソッドまたはプロパティを、同じクエリ内の別のメソッド呼び出しで使用する