Web サイトを処理する
最終更新日: 2011年4月29日
適用対象: SharePoint Foundation 2010
この記事の内容
Web サイトのプロパティを取得する
指定された Web サイト プロパティのみを取得する
Web サイトのタイトルと説明を更新する
Web サイトを作成する
Web サイトを処理するには、最初に ClientContext() コンストラクター (JavaScript: ClientContext(serverRelativeUrl)) を使用し、特定の要求コンテストを取得するために URL または URI を渡します。
Web サイトのプロパティを取得する
ClientContext クラス (JavaScript: ClientContext) の Web プロパティ (JavaScript: web) を使用して、指定されたコンテキスト URL に存在する Web サイト オブジェクトのプロパティを指定します。Load<T>(T, []) メソッド (JavaScript: load(clientObject)) を使用して Web サイト オブジェクトを読み込んでから ExecuteQuery() または ExecuteQueryAsync(ClientRequestSucceededEventHandler, ClientRequestFailedEventHandler) (JavaScript: executeQueryAsync(succeededCallback, failedCallback)) を呼び出した後で、この Web サイトのすべてのプロパティにアクセスできるようになります。次の例は、指定されたサイト コレクションのルート Web サイトのタイトルと説明を表示します。ただし、既定で返される他のプロパティは、Web サイト オブジェクトを読み込み、クエリを実行した後で使用可能になります。特定のクライアント オブジェクトを取得するときに既定で使用可能ではないプロパティの一覧については、「データ取得の概要」を参照してください。
using System;
using Microsoft.SharePoint.Client;
namespace Microsoft.SDK.SharePointServices.Samples
{
class RetrieveWebsite
{
static void Main()
{
string siteUrl = "http://MyServer/sites/MySiteCollection";
ClientContext clientContext = new ClientContext(siteUrl);
Web oWebsite = clientContext.Web;
clientContext.Load(oWebsite);
clientContext.ExecuteQuery();
Console.WriteLine("Title: {0} Description: {1}", oWebsite.Title, oWebsite.Description);
}
}
}
Imports System
Imports Microsoft.SharePoint.Client
Namespace Microsoft.SDK.SharePointServices.Samples
Class RetrieveWebsite
Shared Sub Main()
Dim siteUrl As String = "http://MyServer/sites/MySiteCollection"
Dim clientContext As New ClientContext(siteUrl)
Dim oWebsite As Web = clientContext.Web
clientContext.Load(oWebsite)
clientContext.ExecuteQuery()
Console.WriteLine("Title: {0} Description: {1}", oWebsite.Title, oWebsite.Description)
End Sub
End Class
End Namespace
var siteUrl = '/sites/MySiteCollection ';
function retrieveWebSite() {
var clientContext = new SP.ClientContext(siteUrl);
this.oWebsite = clientContext.get_web();
clientContext.load(this.oWebsite);
clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
}
function onQuerySucceeded(sender, args) {
alert('Title: ' + this.oWebsite.get_title() + ' Decription: ' + this.oWebsite.get_description());
}
function onQueryFailed(sender, args) {
alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
}
指定された Web サイト プロパティのみを取得する
クライアントとサーバーの間で不要なデータが転送されることを抑えるため、Web サイト オブジェクトのすべてのプロパティではなく、指定されたプロパティのみを返すこともできます。この場合、LINQ クエリまたは Load<T>(T, []) (JavaScript: load(clientObject)) メソッドとラムダ式構文を使用して、サーバーから返すプロパティを指定します。次の例では、ExecuteQuery() (JavaScript: executeQueryAsync(succeededCallback, failedCallback)) を呼び出した後で、Web サイト オブジェクトのタイトルと作成日付のみが使用可能になります。たとえば、oWebsite.Description をコンソールに書き込むもうとすると、PropertyOrFieldNotInitializedException が返されます。
using System;
using Microsoft.SharePoint.Client;
namespace Microsoft.SDK.SharePointServices.Samples
{
class RetrieveWebsiteProperties
{
static void Main()
{
string siteUrl = "http://MyServer/sites/MySiteCollection";
ClientContext clientContext = new ClientContext(siteUrl);
Web oWebsite = clientContext.Web;
clientContext.Load(
oWebsite,
website => website.Title,
website => website.Created);
clientContext.ExecuteQuery();
Console.WriteLine("Title: {0} Created: {1}", oWebsite.Title, oWebsite.Created);
}
}
}
Imports System
Imports Microsoft.SharePoint.Client
Namespace Microsoft.SDK.SharePointServices.Samples
Class RetrieveWebsiteProperties
Shared Sub Main()
Dim siteUrl As String = "http://MyServer/sites/MySiteCollection"
Dim clientContext As New ClientContext(siteUrl)
Dim oWebsite As Web = clientContext.Web
clientContext.Load(oWebsite, _
Function(website) website.Title, _
Function(website) website.Created)
clientContext.ExecuteQuery()
Console.WriteLine("Title: {0} Created: {1}", oWebsite.Title, oWebsite.Created)
End Sub
End Class
End Namespace
var siteUrl = '/sites/MySiteCollection ';
function retrieveWebSiteProperties() {
var clientContext = new SP.ClientContext(siteUrl);
this.oWebsite = clientContext.get_web();
clientContext.load(this.oWebsite, 'Title', 'Created');
clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
}
function onQuerySucceeded(sender, args) {
alert('Title: ' + this.oWebsite.get_title() + ' Created: ' + this.oWebsite.get_created());
}
function onQueryFailed(sender, args) {
alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
}
JavaScript では ClientContext(serverRelativeUrl) コンストラクターがサーバー相対 URL を受け取り、load(clientObject) メソッドが実際の LINQ オブジェクトではなく文字列を受け取ることに注意してください。
Web サイトのタイトルと説明を更新する
Web サイトを変更するには、サイトのプロパティを設定し、Update() (JavaScript: update()) メソッドを呼び出します。この方法はサーバー オブジェクト モデル関数の場合と似ていますが、クライアント オブジェクト モデルでは ExecuteQuery() または ExecuteQueryAsync(ClientRequestSucceededEventHandler, ClientRequestFailedEventHandler) (JavaScript: executeQuery(succeededCallback, failedCallback)) を呼び出して、指定したすべてのコマンドのバッチ処理を要求する必要があります。次の例は、指定された Web サイトのタイトルと説明を変更します。
using System;
using Microsoft.SharePoint.Client;
namespace Microsoft.SDK.SharePointServices.Samples
{
class UpdateWebSite
{
static void Main()
{
string siteUrl = "http://MyServer/sites/MySiteCollection";
ClientContext clientContext = new ClientContext(siteUrl);
Web oWebsite = context.Web;
oWebsite.Title = "Updated Web Site";
oWebsite.Description = "This is an updated Web site.";
oWebsite.Update();
clientContext.ExecuteQuery();
}
}
}
Imports System
Imports Microsoft.SharePoint.Client
Namespace Microsoft.SDK.SharePointServices.Samples
Class UpdateWebSite
Shared Sub Main()
Dim siteUrl As String = "http://MyServer/sites/MySiteCollection"
Dim clientContext As New ClientContext(siteUrl)
Dim oWebsite As Web = clientContext.Web
oWebsite.Title = "Updated Web Site"
oWebsite.Description = "This is an updated Web site."
oWebsite.Update()
clientContext.ExecuteQuery()
End Sub
End Class
End Namespace
var siteUrl = '/sites/MySiteCollection ';
function updateWebSite() {
var clientContext = new SP.ClientContext(siteUrl);
this.oWebsite = clientContext.get_web();
this.oWebsite.set_title('Updated Web Site');
this.oWebsite.set_description('This is an updated Web site.');
this.oWebsite.update();
clientContext.load(this.oWebsite, 'Title', 'Description');
clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
}
function onQuerySucceeded(sender, args) {
alert('Title: ' + this.oWebsite.get_title() + ' Decription: ' + this.oWebsite.get_description());
}
function onQueryFailed(sender, args) {
alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
}
Web サイトを作成する
Web サイト オブジェクトを作成するには、WebCreationInformation (JavaScript: WebCreationInformation) クラスを使用してサイトのプロパティを定義してから、このオブジェクトを WebCollection (JavaScript: WebCollection) クラスの Add(WebCreationInformation) (JavaScript: add(parameters)) メソッドに渡します。
次の例は、新しい ブログ Web サイトをサイト コレクション内に作成します。
using System;
using Microsoft.SharePoint.Client;
namespace Microsoft.SDK.SharePointServices.Samples
{
class CreateWebSite
{
static void Main()
{
string siteUrl = "http://MyServer/sites/MySiteCollection";
string blogDescription = "A new blog Web site.";
int blogLanguage = 1033;
string blogTitle = "Blog Web Site";
string blogUrl = "blogwebsite";
bool blogPermissions = false;
string webTemplate = "BLOG#0";
ClientContext clientContext = new ClientContext(siteUrl);
Web oWebsite = clientContext.Web;
WebCreationInformation webCreateInfo = new WebCreationInformation();
webCreateInfo.Description = blogDescription;
webCreateInfo.Language = blogLanguage;
webCreateInfo.Title = blogTitle;
webCreateInfo.Url = blogUrl;
webCreateInfo.UseSamePermissionsAsParentSite = blogPermissions;
webCreateInfo.WebTemplate = webTemplate;
Web oNewWebsite = oWebsite.Webs.Add(webCreateInfo);
clientContext.Load(
oNewWebsite,
website => website.ServerRelativeUrl,
website => website.Created);
clientContext.ExecuteQuery();
Console.WriteLine("Server-relative Url: {0} Created: {1}", oNewWebsite.ServerRelativeUrl, oNewWebsite.Created);
}
}
}
Imports System
Imports Microsoft.SharePoint.Client
Namespace Microsoft.SDK.SharePointServices.Samples
Class CreateWebSite
Shared Sub Main()
Dim siteUrl As String = "http://MyServer/sites/MySiteCollection"
Dim blogDescription As String = "A new Blog Web site."
Dim blogLanguage As Integer = 1033
Dim blogTitle As String = "Blog Web Site"
Dim blogUrl As String = "blogwebsite"
Dim blogPermissions As Boolean = False
Dim webTemplate As String = "BLOG#0"
Dim clientContext As New ClientContext(siteUrl)
Dim oWebsite As Web = clientContext.Web
Dim webCreateInfo As New WebCreationInformation()
webCreateInfo.Description = blogDescription
webCreateInfo.Language = blogLanguage
webCreateInfo.Title = blogTitle
webCreateInfo.Url = blogUrl
webCreateInfo.UseSamePermissionsAsParentSite = blogPermissions
webCreateInfo.WebTemplate = webTemplate
Dim oNewWebsite As Web = oWebsite.Webs.Add(webCreateInfo)
clientContext.Load(oWebsite, _
Function(website) website.ServerRelativeUrl, _
Function(website) website.Created)
clientContext.ExecuteQuery()
Console.WriteLine("Server-relative Url: {0} Created: {1}", oWebsite.ServerRelativeUrl, oWebsite.Created)
End Sub
End Class
End Namespace
var siteUrl = '/sites/MySiteCollection ';
function createWebSite() {
var blogDescription = 'A new Blog Web site.';
var blogLanguage = 1033;
var blogTitle = 'Blog Web Site';
var blogUrl = 'blogwebsite';
var blogPermissions = false;
var webTemplate = 'BLOG#0';
var clientContext = new SP.ClientContext(siteUrl);
this.oWebsite = clientContext.get_web();
var webCreateInfo = new SP.WebCreationInformation();
webCreateInfo.set_description(blogDescription);
webCreateInfo.set_language(blogLanguage);
webCreateInfo.set_title(blogTitle);
webCreateInfo.set_url(blogUrl);
webCreateInfo.set_useSamePermissionsAsParentSite(blogPermissions);
webCreateInfo.set_webTemplate(webTemplate);
this.oNewWebsite = this.oWebsite.get_webs().add(webCreateInfo);
clientContext.load(this.oNewWebsite, 'ServerRelativeUrl', 'Created');
clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
}
function onQuerySucceeded(sender, args) {
alert('Title: ' + this.oWebsite.get_title() + ' Decription: ' + this.oWebsite.get_description());
}
function onQueryFailed(sender, args) {
alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
}
前の例では、LINQ クエリ式を使用して ServerRelativeUrl (JavaScript: serverRelativeUrl) プロパティおよび Created (JavaScript: created) プロパティを返しています。これらのプロパティの値は、明示的に要求するまで表示に使用することはできません。
注意
LINQ を使用してクライアント オブジェクト モデルに対するクエリを作成する場合は、LINQ to Objects を使用します。サーバー オブジェクト モデル用コードの作成だけに使用できる LINQ to SharePoint プロバイダーは使用しません。
SharePoint Foundation Silverlight オブジェクト モデルのコンテキスト内で Web サイトを処理する方法とコード例については、「Silverlight オブジェクト モデルを使用する」を参照してください。