モジュールを使用してソリューションにファイルを追加する
ファイルの種類に関係なく、ファイルを SharePoint サーバーに配置する必要がある場合があります (新しいマスター ページなど)。これを行うには、モジュールを使用します。これは Visual Basic のコード モジュールとは異なります。モジュールは、SharePoint ソリューション内のファイルのコンテナーです。ソリューションを配置すると、SharePoint サーバー上の指定されたフォルダーにモジュール内のファイルがコピーされます。
モジュールの項目と要素
モジュールを作成するには、[新しい項目の追加] のダイアログ ボックスで選択してプロジェクトに追加します。次に、その Elements.xml ファイルを、配置するファイルの名前、システム上の場所、および、SharePoint サーバー上のコピー先の場所が含まれるように変更します。
モジュールの Elements.xml ファイルの例を次に示します。
<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
<Module Name="Module1">
<File Path="Module1\Sample.txt" Url="Module1/Sample.txt" />
</Module>
</Elements>
新たに作成されたモジュールには、既定で次のファイルが含まれています。
ファイル名 |
説明 |
---|---|
Elements.xml |
モジュールの定義ファイル。 |
Sample.txt |
モジュール内のファイルのサンプルとして機能するプレースホルダー ファイル。 |
Elements.xml ファイルには、次の要素が含まれています。
要素名 |
説明 |
---|---|
Elements |
モジュールで定義されているすべての要素が含まれています。 |
Module |
Module 要素には、"<Module Name="Module1">" 形式のモジュール名を指定する Name という単一の属性があります。
メモ
モジュールの名前 (またはその Folder Name プロパティ) を変更する場合は、Module 要素で手動で名前を更新する必要があります。
Module 要素でファイルのサブディレクトリを指定した場合、対応するディレクトリ構造が Windows SharePoint Services (WSS) によって自動的に作成されます。 |
ファイル |
File 要素には、Path と Url の 2 つのパラメーターがあります。
属性名説明
パスSharePoint ソリューションに含まれるファイルの名前および場所。形式は Path="Module1\Sample.txt" です。
Urlファイルの配置先となる SharePoint サーバー上の場所。形式は Url="Module1/Sample.txt" です。
型 GhostableInLibrary と Ghostable の 2 つの設定を持つ属性 (省略可能)。形式は Type="GhostableInLibrary" です。 GhostableInLibrary を指定した場合、SharePoint 内のドキュメント ライブラリにファイルを追加する際、そのファイルに付随するリスト項目もライブラリに追加されます。 Ghostable を指定した場合、ドキュメント ライブラリの外で SharePoint にファイルが追加されます。
|
Elements.xml には、配置するファイルごとに別個の <File> 要素エントリが必要です。