Configuration 要素 (サイト)
最終更新日: 2015年3月9日
適用対象: SharePoint Foundation 2010
この記事の内容
属性
子要素
親要素
出現回数
Configuration 要素で表されたサイト定義の構成に基づく SharePoint Foundation Web サイトを作成するときに使用する、リストおよびモジュールを指定します。この要素は、Web テンプレートの構成も表します。このトピックの説明は Web テンプレート構成にも適用されますが、簡単にするために、このトピックでは "サイト定義の構成" という言葉を全体を通して使用しています。特に指定しない限り、以下の属性の説明は、サイト定義と Web テンプレートの両方の Configuration 要素に適用されます。
<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 |
オプションの Boolean。グローバルなフィーチャーの関連付けが、サイト定義の構成を使用して作成されたサイトで許可されるかどうかを指定します。 |
CustomMasterUrl |
オプションの Text。サイト定義の構成を介して作成される Web サイトのページで、これらのページをカスタマイズせずに使用できる代替 .master ページの URL を指定します。 注意 代替マスター ページを必要とするページ上で MasterPageFile 属性の値を変更するだけで、これらのページがカスタマイズされ、フロントエンド Web サーバーのファイル システムではなくコンテンツ データベースに格納されます。 CustomMasterUrl の値を使用する方法の詳細については、「アプリケーション ページのマスター ページ」を参照してください。 |
Description |
オプションの Text。SharePoint Foundation の UI に表示されるサイト定義の構成のロケール固有の説明を格納します。 |
DisplayCategory |
オプションの Text。SharePoint Foundation の UI に表示されるサイト定義の構成のカテゴリを指定します。たとえば、Collaboration、Meetings、またはカスタム名を指定します。 |
FilterCategories |
オプションの Text。この属性は SharePoint Foundation では使用されていません。これは、Microsoft SharePoint Server など、SharePoint Foundation に基づいて構築された拡張されたポータルまたはコンテンツ管理ソリューションで使用可能で、UI に表示される分類には正確に対応しないサイト定義の構成を分類する手段として使用されます (「DisplayCategory 属性」を参照)。 |
Hidden |
オプションの Boolean。SharePoint Foundation の UI にサイト定義の構成をオプションとして表示するかどうかを指定します。 |
ID |
必須の Integer。サイト定義内で一意のサイト定義の構成の ID を指定します。STS や MPS の定義は、WebTemp*.xml ファイル内の Template 要素、およびその定義に対応する Onet.xml ファイルによって定義されます。以下の「親要素」および「備考」を参照してください。 |
ImageUrl |
必須の Text。SharePoint Foundation の UI に表示されるプレビュー イメージの URL を格納します。 |
MasterUrl |
オプションの Text。サイト定義の構成を介して作成される Web サイトに使用する既定のマスター ページを指定します。 |
Name |
オプションの 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 |
オプションの Boolean。構成から作成されるサイトがサイト コレクション内のルート Web サイトとしてのみ存在することを指定する場合は TRUE。この属性は、ソリューション (.wsp ファイル) に格納されている Web テンプレートでは適用されません。 |
SubWebOnly |
オプションの Boolean。構成から作成されるサイトがサイト コレクション内のサブサイトとしてのみ存在することを指定する場合は TRUE。この属性は、ソリューション (.wsp ファイル) に格納されている Web テンプレートでは適用されません。 |
SupportsMultilingualUI |
オプションの Boolean。構成から作成されるサイトに対して管理者が第 2 言語を有効にできることを指定する場合は TRUE (既定)。FALSE を指定すると、管理者がこの機能を有効にできません。 |
Title |
オプションの Text。SharePoint Foundation の UI に表示されるサイト定義の構成のタイトルを格納します。 |
Type |
オプションの Text。STS や MPS のサイト定義を識別します。 |
VisibilityFeatureDependency |
オプションの Text。指定されたフィーチャーのアクティブ化の状態に基づいてサイト定義の構成を非表示にするために WebTemp*.xml ファイル内で使用されます。別のフィーチャーに依存するフィーチャーが構成に含まれている場合、この属性を設定することで、指定したフィーチャーがインストールまたはアクティブ化されていないときに、SharePoint Foundation の UI にオプションとして構成が表示されなくなります。この属性は、Web アプリケーションを範囲とするフィーチャーに対してはサポートされません。 |
子要素
親要素
出現回数
最小 : 0 最大 : 制約なし |
コメント
Configuration 要素は、サイト定義内で使用できるサイト定義の構成を識別するために WebTemp*.xml ファイル (WebTemp.xml を参照) で使用されます。この要素は、Onet.xml ファイルで使用され、サイト定義の構成からサイトを作成する際に使用するリスト、モジュール、およびフィーチャーの構成を定義します。WebTemp*.xml では、この要素は、サイト定義を指定する Template 要素内に含まれます。Onet.xml では、この要素は、Onet.xml でリストが定義される構成を指定する Configurations 要素内に含まれます。
サイト定義ごとに WebTemp*.xml ファイルに 1 つの Template 要素があります。また、Onet.xml ファイルも 1 つあります。
ID 属性により、WebTemp*.xml ファイル内の指定されたサイト定義の Configuration 要素が、Onet.xml ファイル内の同じサイト定義の対応する Configuration 要素に関連付けられます。
Web テンプレートは、サイト定義の構成とは異なり、SharePoint データベースに格納されている .wsp ファイル内の elements.xml ファイルの WebTemplate 要素で定義されています。また, .wsp ファイルには、Web テンプレートの詳細を指定する 1 つの Configuration 要素を持つ Onet.xml ファイルがあります。
例
次の例は、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>