次の方法で共有

Feature 要素 (フィーチャー)

  • [アーティクル]

適用対象: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013

指定された範囲でアクティブ化または非アクティブ化するフィーチャーを定義します。

定義

<Feature
  ActivateOnDefault = "TRUE" | "FALSE"
  AlwaysForceInstall = "TRUE" | "FALSE"
  AutoActivateInCentralAdmin = "TRUE" | "FALSE"
  Creator = "Text"
  DefaultResourceFile =  "Text"
  Description = "Text"
  Hidden = "TRUE" | "FALSE"
  Id = "Text"
  ImageUrl = "Text"
  ImageUrlAltText = "Text"
  ReceiverAssembly = "Text"
  ReceiverClass = "Text"
  RequireResources = "TRUE" | "FALSE"
  Scope = "Text"
  SolutionId = "Text"
  Title = "Text"
  UIVersion = "Text"
  Version = "Text" >
</Feature>

要素と属性

以下のセクションで、属性、子要素、親要素について説明します。

属性

属性 説明
ActivateOnDefault 省略可能 なブール値。 インストール時または Web アプリケーションの作成時に既定でフィーチャーがアクティブ化される場合は TRUE、フィーチャーがアクティブ化されない場合は FALSE。 既定では、この属性は TRUE です。 ActivateOnDefault 属性は、サイト コレクション (サイト) または Web (Web) スコープの機能には適用されません。

一般に、ファーム スコープの機能はインストール中にアクティブ化され、新しい Web アプリケーションが作成されると、その中にインストールされているすべての Web アプリケーションスコープの機能がアクティブになります。
AlwaysForceInstall 省略可能 なブール値。 フィーチャーが既にインストールされている場合でも、インストール時に強制的にフィーチャーがインストールされる場合は TRUE。 たとえば、TRUE に設定すると、ユーザーが scanforfeatures または installfeature コマンド ライン操作を使用して (既にインストールされている場合でも) 機能のインストールを試みると、常に機能展開イベント ハンドラーが起動します。 既定では、この属性は FALSE です。 AlwaysForceInstall 属性は、すべての対象範囲のフィーチャーに影響します。
AutoActivateInCentralAdmin 省略可能 なブール値。 管理 Web サイト、サイト コレクション、または Web アプリケーションで機能が既定でアクティブ化されている場合は TRUE。 既定では、この属性は FALSE です。 AutoActivateInCentralAdmin 属性は、Farm を対象範囲とするフィーチャーには適用されません。
Creator オプションの Text。
DefaultResourceFile オプションの Text。 機能の XML リソースを取得するための共通リソース ファイルを示します。 ファイルにリソースを指定しない場合、SharePoint Foundation は既定で %ProgramFiles%\Common Files\Microsoft Shared\Web サーバー拡張機能\15\TEMPLATES\FEATURES\*FeatureName*\Resources\Resources._Culture_.resx に表示されます。

ただし、アプリケーション内のすべての機能に共有コア リソース ファイルを指定する場合は、 DefaultResourceFile を使用してリソースにアクセスするための代替ファイルを指定できます。 たとえば、 DefaultResourceFile="_MyFile_" を設定した場合、SharePoint Foundation は %ProgramFiles%\Common Files\Microsoft Shared\Web サーバー拡張機能\15\Resources\*MyFile*._Culture_.resx を検索して、機能のローカライズされたリソースを取得します。
説明 文字列型 (String) の値を使用します。 フィーチャーが実行する内容の詳細な説明を返します。
Hidden 省略可能 なブール値。 既定では、この属性は FALSE です。
Id 必須の Text。 フィーチャーのグローバル一意識別子 (GUID) を格納します。
ImageUrl オプションの Text。 ユーザー インターフェイス (UI) で機能を表すために使用するイメージの \_layouts/IMAGES ディレクトリを基準とした URL が含まれます。
ImageUrlAltText オプションの Text。 フィーチャーを表す画像の代替テキストを格納します。
ReceiverAssembly オプションの Text。 ReceiverClass と共に設定されている場合は、フィーチャーのイベントを処理するレシーバの読み込み元であるグローバル アセンブリ キャッシュにある署名されたアセンブリの厳密な名前を指定します。
ReceiverClass オプションの Text。 ReceiverAssembly と共に設定されている場合は、フィーチャーのイベント プロセッサを実装するクラスを指定します。
RequireResources 省略可能 なブール値。 特定 のカルチャに対してフィーチャーの標準 "Sentinel" リソースが存在することを確認して、SharePoint Foundation がフィーチャーにリソースが存在するかどうかを確認することを指定する場合は TRUE。

リソース ファイルの名前は、 という形式 <Feature Directory>\Resources\Resources..resxで指定されます。ここで <Culture Name> 、 はカルチャを識別する名前です。 SharePoint Foundation では、カルチャ名の次の形式がサポートされています:
ll-Ssss-CC


ll-CC

カルチャ名の例:

en-US 英語 (米国)de-DE ドイツ語 (ドイツ)



fr-FR フランス語 (フランス)

ja-JP 日本語 (日本)

sr-Latn-CS セルビア語 (ラテン、セルビア)

インターネット エンジニアリング タスク フォース (IETF) 言語タグ形式はll(l)-Ssss-CC、ここで:

ll(l)* は、必要な 2 文字の言語識別子 (または、言語の ISO 2 文字コードがない場合は 3 文字) をSsss*
表します。省略可能なスクリプト識別子* CC
を示します。省略可能なリージョン識別子を示します。

RequireResources 属性を使用すると、リソースがフィーチャーの特定の言語に存在するかどうかに応じて、特定の機能の可視性を制限できます。

注: SharePoint Foundation では、DefaultResourceFile 属性で指定されたファイルが存在する場合は、機能に対する特定の言語のサポートを確認するためのバックアップ ファイルとして使用されません。

特定の Web サイトまたはサイト コレクションの言語に対してファイルが存在しない場合、2 つの動作が発生

する可能性があります。* 言語に対応するリソースが使用できない場合、Web サイトまたはサイト コレクションの機能をアクティブ化するために、機能はユーザー インターフェイスから非表示になります。

RequireResources 属性はユーザー インターフェイスでのみ適用されることに注意してください。 特定の言語のリソースを持たない機能は、stsadm.exeを使用したコマンド ライン操作またはオブジェクト モデルを使用して、Web サイトに対してアクティブ化できます。

SharePoint Foundation では、より大きなサイト定義の一部である機能に 対して RequireResources を適用しません。 たとえば、タイ語バージョンのサイト定義を指定する場合は、%ProgramFiles%\Common Files\Microsoft Shared\Web サーバー拡張機能\15\TEMPLATE\1054\XML にwebtempThai.xmlを配置して、フォルダーに含まれる各機能に適切なリソースがあることを確認する必要があります。

* 一般に、SharePoint Foundation は、機能のユーザー インターフェイス拡張機能コンポーネントがリソースを持たない Web サイトに表示されないようにしますが、例外があります。 RequireResources の設定を慎重に行い、すべての機能にリソースが含まれていない限りサイト定義を展開しない場合でも、リソースが使用できないサイトに機能が表示される可能性があります。

シナリオの例として、カスタム ツール バー ボタンとサイト設定リンクを提供する 2 つの言語のリソースを含むカスタム機能があり、いずれかの言語でルート Web サイトを使用して新しいサイト コレクションをプロビジョニングしたとします。 次に、3 番目の言語の言語パックをダウンロードしてインストールした後、元のルート Web サイトの下に、この 3 番目の言語で新しいサブサイトをプロビジョニングします。 RequireResources が TRUE に設定されていない場合、カスタム機能はフォールバックを試み、フォールバック リソース (つまり、 としてResources\Resources.resx定義されたものはカルチャなしで) を使用しようとします。フォールバック リソースがない場合、SharePoint Foundation は空の文字列をレンダリングします。 ただし、 RequireResources が TRUE に設定されている場合、機能のユーザー インターフェイス拡張機能コンポーネント ( CustomAction、 ListTemplate、 FeatureSiteTemplateAssociation 要素を使用して定義されたものなど) は、リソースが使用できない場合はサブサイトに表示されないため、カスタム リンクとサイト設定は自動的に非表示になります。

この属性の設定は、ユーザー インターフェイスを介したフィーチャーのアクティブ化にのみ適用され、コマンド ライン操作やオブジェクト モデルSTSADM.EXE適用されません。
スコープ 必須の Text。 機能をアクティブ化できるスコープを指定し、 ファーム (ファーム)、 WebApplication (Web アプリケーション)、 サイト (サイト コレクション)、 Web (Web サイト) のいずれかの値を含みます。 スコープの詳細については、「 要素スコープ」を参照してください。
SolutionId オプションの Text。 フィーチャーが属するソリューションを指定します。
Title オプションの Text。 フィーチャーのタイトルを返します。 255 文字に制限されます。
UIVersion オプションの Text。 この機能のユーザー インターフェイス (UI) バージョンを指定します。 UIVersion は複数の方法で指定されます。

* =#- サイトの UIVersion は と* <#
等しい#必要があります。 - サイトの UIVersion は 未満#* >#
である必要があります。サイトの UIVersion は、<=#
* より#大きくする必要があります
* >=##。サイトの UIVersion は、 以上である必要があります。サイトの UIVersion は、 以上#
* #;#である必要があります。サイトの UIVersion はセミコロンで区切られた数値の一覧に含まれている必要があります。
バージョン オプションの Text。 System.Version に準拠した表現でフィーチャーのバージョンを指定します。 ピリオドで区切られた、バージョンを表す最大 4 つの数値を指定できます。

子要素

ActivationDependencies、ElementManifests、Properties、UpgradeActions Element (Feature)

親要素

None

注釈

SharePoint Foundation では、フィーチャー フォルダー名とファイル名に対して、下位 ASCII 文字のみがサポートされ、スペースはサポートされません。

例

この要素の使用方法の例については、「 Feature.xml Files」を参照してください。