構成要素: リストとドキュメントライブラリ

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

最終更新日: 2010年4月8日

適用対象: SharePoint Foundation 2010

この記事の内容
リストとドキュメントライブラリのオブジェクトモデル
リストとドキュメントライブラリで使用される XML
リストとドキュメントライブラリに関連する領域
リストとドキュメントライブラリの詳細情報

Microsoft SharePoint Foundation 2010 には、リストを操作するためのさまざまな API が用意されています。以下のマネージオブジェクトモデルが提供する型とメンバーを使用すると、リストプロパティを変更したり、リストテンプレートとリストアイテムを作成および管理できます。

サーバー上で動作するコードに対して、Microsoft.SharePoint 名前空間は、リストを表すコアクラスを提供します。Microsoft.SharePoint.Deployment 名前空間は、サイトコレクション間でコンテンツを移行するための API を提供します。
クライアント側の Microsoft .NET 3.5 アプリケーションまたは Silverlight アプリケーションのコンテキストで動作するマネージコードに対して、Microsoft.SharePoint.Client 名前空間は、サーバーオブジェクトモデルで使用できる型とメンバーのサブセットを提供します。
ブラウザーで動作するスクリプトに対して、SP 名前空間の ECMAScript (JavaScript、JScript) オブジェクトモデルは、サーバーオブジェクトモデルで使用できる型とメンバーのサブセットを提供します。
Lists Web サービスは、リストをリモートで操作するためのメソッドを提供します。

サーバー側オブジェクトモデルで SaveAsTemplate(String, String, String, Boolean) メソッドを使用すると、既存の SharePoint Foundation リストをリストテンプレートとして保存できます。または、SPListTemplate クラスとそのコレクションクラスを使用して、リストテンプレートを管理できます。SPListTemplate クラスは、カスタムリストテンプレートとリスト定義の両方を表します。カスタムリストテンプレートは、SaveAsTemplate(String, String, String, Boolean) メソッドを通じて作成したり、UI を通じて保存したりします。リスト定義は、フィーチャーとして %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\FEATURES ディレクトリへインストールし、アクティブ化します。

リストスキーマには、ベースタイプとリストテンプレートタイプの両方があります。SPBaseType 列挙によって、以下のリストベースタイプが識別されます。

大部分のリストにおける一般的なリストタイプ
ドキュメントライブラリ
ディスカッション掲示板
アンケート
案件
不明のベースタイプ

SPListTemplateType 列挙は、単一のリストベースタイプ定義にそれぞれ関連付けられている、SharePoint Foundation 内の既定のリストテンプレートタイプを識別します。SPList クラスは、すべてのリストに共通するリストプロパティへのアクセスを提供しますが、リストテンプレートタイプは、リストベースタイプから派生することもできます。たとえば、ドキュメントライブラリを表すリストオブジェクトを SPDocumentLibrary オブジェクトとしてキャストし、ドキュメントライブラリ固有のプロパティにアクセスできます。

Microsoft Microsoft Business Connectivity Services (BCS) は、外部リストで作業するための API を提供します。Business Connectivity Services の詳細については、「構成要素: 外部コンテンツタイプおよび外部リスト」を参照してください。

リストとドキュメントライブラリのオブジェクトモデル

サーバーオブジェクトモデルおよびクライアントオブジェクトモデルで以下のクラスを使用すると、リスト、リストテンプレート、およびリストアイテムを操作できます。

SPList – SharePoint Web サイト上のリストを表します。SPWeb または SPListCollection の GetList メソッドを使用すると、特定のリストを効率的に返すことができます。

クライアントオブジェクトモデル: List (JavaScript: List)
SPListDataSource – 外部リストに関する情報を提供します。

クライアントオブジェクトモデル: ListDataSource (JavaScript: ListDataSource)
SPListEventProperties – SharePoint リストイベントのプロパティを提供します。
SPListEventReceiver – リストに対して発生するイベントをトラップするメソッドを提供します。
SPListItem – リスト内のアイテムまたは行を表します。SPList または SPWeb の GetItem* メソッドを使用すると、リストアイテムまたは SPListItemCollection を効率的に返すことができます。

クライアントオブジェクトモデル: ListItem (JavaScript: ListItem)
SPListItemVersion – リストアイテムのバージョンを表します。
SPListTemplate – リストのフィールドおよびビューを定義する、リスト定義またはリストテンプレートを表します。リスト定義は %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\FEATURES ディレクトリ内のファイルに格納されていますが、リストテンプレートは、ユーザーインターフェイスまたはオブジェクトモデルを通じて、リストをテンプレートとして保存することで作成されます。

クライアントオブジェクトモデル: ListTemplate (JavaScript: ListTemplate)
SPListTemplateType – リスト定義またはリストテンプレートのタイプを指定する列挙。

クライアントオブジェクトモデル: ListTemplateType (JavaScript: SP.ListTemplateType)
SPBaseType – リストのベースタイプを指定する列挙。

クライアントオブジェクトモデル: BaseType (JavaScript: BaseType)
SPDocTemplate – ドキュメントライブラリで使用されるドキュメントテンプレートを表します。
SPDocumentLibrary – SharePoint Foundation 内のドキュメントライブラリを表します。

サーバーオブジェクトモデルにおけるリストの操作の詳細については、「リストのオブジェクトとコレクションを操作する」および「基本的なオブジェクトモデルのタスク」に含まれるプログラミングタスクを参照してください。クライアントオブジェクトモデルにおけるリストの操作の詳細については、「データ取得の概要」および「一般的なプログラミング作業」内のプログラミングタスクを参照してください。

リストとドキュメントライブラリで使用される XML

リスト定義は SharePoint Foundation 機能としてアクティブ化され、スキーマを含む Schema.xml ファイルが含まれます。ただし、ビュー定義の大部分は、%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\LAYOUTS\XSL ディレクトリ内の XSLT を通じて提供されます。List はlist schema内の最上位の要素ですが、サイト定義スキーマ内の Configuration 要素にも List 要素が含まれており、サイト定義を通じて作成される Web サイトの一部として特定のリストが格納されています。List Instance 機能を使用すると、リストタイプを準備する際に使用する既定のデータを指定できます。機能の使用方法については、「フィーチャーの使用」を参照してください。リスト定義機能の作成方法を示す例については、「[方法] カスタムリスト定義を作成する」を参照してください。