構成要素 (サイト)
適用対象: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013
Configuration 要素で表されるサイト定義の構成に基づく SharePoint Foundation Web サイトの作成に使用されるリストとモジュールを指定します。 この要素は、Web テンプレートの構成も表します。
このトピックの説明は Web テンプレート構成にも適用されますが、簡単にするために、このトピックでは "サイト定義の構成" という言葉を全体を通して使用しています。 特に指定がない場合を除き、次の属性の説明は、サイト定義と Web テンプレートの両方の 構成要素 に適用されます。
<Configuration
AllowGlobalFeatureAssociations = "TRUE" | "FALSE"
CustomMasterUrl = "Text"
Description = "Text"
DisplayCategory = "Text"
FilterCategories = "Text"
Hidden = "TRUE" | "FALSE"
ID = "Integer"
ImageUrl = "Text"
MasterUrl = "Text"
Name = "Text"
ProvisionAssembly = "Text"
ProvisionClass = "Text"
ProvisionData = "Text"
RootWebOnly = "TRUE" | "FALSE"
SubWebOnly = "TRUE" | "FALSE"
SupportsMultilingualUI = "TRUE" | "FALSE"
Title = "Text"
Type = "Text"
VisibilityFeatureDependency = "Text">
</Configuration>
要素と属性
以下のセクションで、属性、子要素、親要素について説明します。
属性
属性 | 説明 |
---|---|
AllowGlobalFeatureAssociations |
省略可能 なブール値。 グローバルなフィーチャーの関連付けが、サイト定義の構成を使用して作成されたサイトで許可されるかどうかを指定します。 |
CustomMasterUrl |
オプションの Text。 サイト定義の構成を使用して作成された Web サイト内のページで使用できる代替の .master ページの URL を、それらのページをカスタマイズせずに指定します。 注: 代替マスター ページが必要なページで MasterPageFile 属性の値を変更するだけで、これらのページがカスタマイズされ、フロントエンド Web サーバーのファイル システムではなくコンテンツ データベースに格納されます。 CustomMasterUrl の値の使用方法の詳細については、「アプリケーション ページのマスター ページ」を参照してください。 |
説明 |
オプションの Text。 SharePoint Foundation の UI に表示されるサイト定義構成のロケール固有の説明が含まれます。 |
DisplayCategory |
オプションの Text。 SharePoint Foundation の UI にサイト定義の構成を表示するカテゴリ ( コラボレーション、 会議、カスタム名など) を指定します。 |
FilterCategories |
オプションの Text。 この属性は SharePoint Foundation では使用されません。 Microsoft SharePoint Server などの SharePoint Foundation 上に構築された拡張ポータルまたはコンテンツ管理ソリューションでは、UI に表示される分類に正確にマップされない方法でサイト構成を分類する手段として使用できます。 ( DisplayCategory 属性も参照してください)。 |
Hidden |
省略可能 なブール値。 サイト定義の構成を SharePoint Foundation の UI にオプションとして表示するかどうかを指定します。 |
ID |
整数型 (Integer) の値を使用します。 サイト定義内で一意のサイト定義の構成の ID を指定します。 STS や MPS などの定義は、ファイル内WebTemp*.xml の Template 要素と、その定義に対応するOnet.xml ファイルによって定義されます。 以下の「親要素」および「備考」を参照してください。 |
ImageUrl |
必須の Text。 SharePoint Foundation の UI に表示されるプレビュー イメージの URL が含まれています。 |
MasterUrl |
オプションの Text。 サイト定義構成を使用して作成された Web サイトに使用する既定のマスター ページを指定します。 |
名前 |
オプションの Text。 サイト定義の構成の名前を格納します。 |
ProvisionAssembly |
オプションの Text。 プロビジョニング クラスが存在する場合は、そのクラスを含むアセンブリの名前を指定します。 (以下の 「ProvisionClass」 を参照してください)。例えば:ProvisionAssembly="MyCompany.SharePoint.ProvisionHelper, Version=1.0.0.0, Culture=neutral, PublicKeyToken=82f0cdf222f0530d" |
ProvisionClass |
オプションの Text。 ランタイムが構成からサイトの作成を完了したときに実行されるプロビジョニング機能を提供するクラスの完全修飾名を指定します。 このようなクラスは必要ありませんが、カスタム構成に必要な場合は、 SPWebProvisioningProvider から派生する必要があります。 以下に例を示します。ProvisionClass="MyCompany.SharePoint. ProvisionHelper.MySiteProvisioningProvider" |
ProvisionData |
オプションの Text。 ProvisionClass (上記参照) の Provision(SPWebProvisioningProperties) メソッドで使用されるデータを指定します。 構造化データが含まれるファイルのパスにできます。 以下に例を示します。ProvisionData="SiteTemplates\\MySiteManifest.xml" |
RootWebOnly |
省略可能 なブール値。 構成 から作成されたサイトがサイト コレクション内のルート Web サイトとしてのみ存在することを指定する場合は TRUE。 この属性は、ソリューション (.wsp ファイル) に格納されている Web テンプレートでは適用されません。 |
SubWebOnly |
省略可能 なブール値。 構成から作成されるサイトがサイト コレクション内のサブサイトとしてのみ存在することを指定する場合は TRUE。 この属性は、ソリューション (.wsp ファイル) に格納されている Web テンプレートでは適用されません。 |
SupportsMultilingualUI |
省略可能 なブール値。 構成から作成されるサイトに対して管理者が第 2 言語を有効にできることを指定する場合は TRUE (既定)。 FALSE を指定すると、管理者がこの機能を有効にできません。 |
Title |
オプションの Text。 SharePoint Foundation の UI に表示されるサイト定義構成のタイトルが含まれます。 |
Type |
オプションの Text。 STS や MPS のサイト定義を識別します。 |
VisibilityFeatureDependency |
オプションの Text。 指定した機能の WebTemp*.xml アクティブ化状態に基づいてサイト定義の構成を非表示にするためにファイルで使用されます。 構成に別の機能に依存する機能が含まれている場合、この属性を設定すると、指定した機能がインストールまたはアクティブ化されていない場合、SharePoint Foundation の UI で構成がオプションとして表示されなくなります。 この属性は、Web アプリケーションを範囲とするフィーチャーに対してはサポートされません。 |
子要素
親要素
Occurrences
- 最小 : 0
- 最大: 制約なし
注釈
Configuration 要素は、サイト定義内で使用可能なサイト定義の構成を識別するために、ファイルでWebTemp*.xml
使用されます (「WebTemp.xml」を参照)。
この要素は、Onet.xml ファイルで使用され、サイト定義の構成からサイトを作成する際に使用するリスト、モジュール、およびフィーチャーの構成を定義します。
ファイル内 WebTemp*.xml
では、この要素はサイト定義を指定する Template 要素に含まれています。 では Onet.xml
、この要素は、 内でリストが定義されている構成を指定する Configurations 要素内に Onet.xml
含まれています。
ファイルには WebTemp*.xml
1 つの Template 要素があり、サイト定義ごとに 1 つのOnet.xml
ファイルがあります。
ID 属性は、ファイル内の特定のサイト定義の構成要素を、 内WebTemp*.xml
の同じサイト定義の対応する構成要素にOnet.xml
関連付けます。
サイト定義構成とは異なる Web テンプレートは、SharePoint データベースに格納されている .wsp ファイル内のファイル内elements.xml
の WebTemplate 要素で定義されます。 また、.wsp ファイルには、 Onet.xml
Web テンプレートの詳細を指定する 1 つの Configuration 要素を含むファイルがあります。
例
WebTemp.xmlの次の例では、STS Web サイト定義の 3 つの構成を指定します。
<Template Name="STS" ID="1">
<Configuration ID="0" Title="Team Site" Hidden="FALSE" ImageUrl="/_layouts/images/stts.png" Description="A site for teams to quickly organize, author, and share information. It provides a document library, and lists for managing announcements, calendar items, tasks, and discussions." DisplayCategory="Collaboration" > </Configuration>
<Configuration ID="1" Title="Blank Site" Hidden="FALSE" ImageUrl="/_layouts/images/stbs.png" Description="A blank site for you to customize based on your requirements." DisplayCategory="Collaboration" AllowGlobalFeatureAssociations="False" > </Configuration>
<Configuration ID="2" Title="Document Workspace" Hidden="FALSE" ImageUrl="/_layouts/images/stdw.png" Description="A site for colleagues to work together on a document. It provides a document library for storing the primary document and supporting files, a tasks list for assigning to-do items, and a links list for resources related to the document." DisplayCategory="Collaboration" > </Configuration>
</Template>