Feature 要素 (フィーチャー)Feature Element (Feature)

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

指定された範囲でアクティブ化または非アクティブ化するフィーチャーを定義します。Defines a Feature to activate or deactivate at a specified scope.

定義Definition

<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>

要素と属性Elements and attributes

以下のセクションで、属性、子要素、親要素について説明します。The following sections describe attributes, child elements, and parent elements.

属性Attributes

属性Attribute

説明Description

**アクティブ/既定値****ActivateOnDefault**

オプションの **Boolean**。Optional **Boolean**. インストール時または Web アプリケーションの作成時に既定でフィーチャーがアクティブ化される場合は **TRUE**、フィーチャーがアクティブ化されない場合は **FALSE**。**TRUE** if the Feature is activated by default during installation or when a Web application is created; **FALSE** if the Feature is not activated. 既定では、この属性は **TRUE** です。This attribute equals **TRUE** by default. [**既定**] 属性は、サイトコレクション (**サイト**) または web サイト (**web**) を対象とした機能には適用されません。The **ActivateOnDefault** attribute does not apply to site collection (**Site**) or website (**Web**) scoped Features.

一般的に、**Farm** を対象範囲とするフィーチャーはインストール時にアクティブ化され、Web アプリケーションの作成時には、**Web application** を対象範囲とするインストールされるすべてのフィーチャーがアクティブ化されます。In general, **Farm**-scoped Features become activated during installation, and when a new Web application is created, all installed **Web application**-scoped Features in it become activated.

**always forceinstall****AlwaysForceInstall**

オプションの **Boolean**。Optional **Boolean**. フィーチャーが既にインストールされている場合でも、インストール時に強制的にフィーチャーがインストールされる場合は **TRUE**。**TRUE** if the Feature is installed by force during installation even if the Feature is already installed. たとえば、[ **TRUE**] に設定されている場合、機能展開イベントハンドラーは、ユーザーが (既にインストールされている場合でも) **scanforfeatures**または**installfeature**のどちらかを使用して、その機能をインストールしようとするたびに発生します。コマンドライン操作。For example, if set to **TRUE**, Feature deployment event handlers will always fire anytime a user tries to install the Feature (even if it is already installed) by using either the **scanforfeatures** or **installfeature** command-line operation. 既定では、この属性は **FALSE** です。This attribute equals **FALSE** by default. **AlwaysForceInstall** 属性は、すべての対象範囲のフィーチャーに影響します。The **AlwaysForceInstall** attribute affects Features of all scopes.

**AutoActivateInCentralAdmin****AutoActivateInCentralAdmin**

オプションの **Boolean**。Optional **Boolean**. **TRUE**の場合、機能は、管理 web サイト、サイトコレクション、または Web アプリケーションで既定でアクティブ化されます。**TRUE** if the Feature is activated by default in the Administrative website, site collection, or Web application. 既定では、この属性は **FALSE** です。This attribute equals **FALSE** by default. **AutoActivateInCentralAdmin** 属性は、**Farm** を対象範囲とするフィーチャーには適用されません。The **AutoActivateInCentralAdmin** attribute does not apply to **Farm**-scoped Features.

**Creator****Creator**

オプションの **Text**。Optional **Text**.

**DefaultResourceFile****DefaultResourceFile**

オプションの **Text**。Optional **Text**. 機能の XML リソースを取得するための共通リソース ファイルを示します。Indicates a common resource file for retrieving Feature XML resources. ファイルにリソースが指定されていない場合、SharePoint Foundation は既定で%ProgramFiles%\Common の Shared\web server extensions\15\TEMPLATES\FEATURES\*FeatureName \* \ resources/resourcesに表示されます。_Culture_。If you do not specify a resource in the file, SharePoint Foundation looks by default in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATES\FEATURES\*FeatureName\*\Resources\Resources._Culture_.resx.

ただし、アプリケーションのすべての機能で共有されるコア リソース ファイルを提供する場合は、**DefaultResourceFile** を使用して、リソースにアクセスするために使用する代替ファイルを指定できます。However, if you want to provide a shared core resource file for all the Features in your application, you can specify an alternate file through which to access resources by using **DefaultResourceFile**. たとえば、 **DefaultResourceFile**= "_MyFile_" を設定した場合、SharePoint Foundation は%ProgramFiles%\Common の Shared\web server extensions\15\Resources\*MyFile \* を検索します。機能のローカライズされたリソースを取得するための_Culture_。For example, if you set **DefaultResourceFile**="_MyFile_", SharePoint Foundation looks in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\Resources\*MyFile\*._Culture_.resx to retrieve localized resources for your Feature.

**説明****Description**

文字列型 (**String**) の値を使用します。Optional **String**. フィーチャーが実行する内容の詳細な説明を返します。Returns a longer representation of what the Feature does.

**Hidden****Hidden**

オプションの **Boolean**。Optional **Boolean**. 既定では、この属性は **FALSE** です。This attribute equals **FALSE** by default.

**Id****Id**

必須の **Text**。Required **Text**. フィーチャーのグローバル一意識別子 (GUID) を格納します。Contains the globally unique identifier (GUID) for the Feature.

**ImageUrl****ImageUrl**

オプションの **Text**。Optional **Text**. ユーザーインターフェイス (UI) で\_機能を表すために使用するイメージの layouts または IMAGES ディレクトリに対する相対 URL が含まれています。Contains a URL relative to the \_layouts/IMAGES directory for an image to use to represent the Feature in the user interface (UI).

**imageurlalttext****ImageUrlAltText**

オプションの **Text**。Optional **Text**. フィーチャーを表す画像の代替テキストを格納します。Contains the alternate text for the image that represents the Feature.

**ReceiverAssembly****ReceiverAssembly**

オプションの **Text**。Optional **Text**. **ReceiverClass** と共に設定されている場合は、フィーチャーのイベントを処理するレシーバの読み込み元であるグローバル アセンブリ キャッシュにある署名されたアセンブリの厳密な名前を指定します。If set along with **ReceiverClass**, specifies the strong name of the signed assembly located in the global assembly cache from which to load a receiver to handle Feature events.

**ReceiverClass****ReceiverClass**

オプションの **Text**。Optional **Text**. **ReceiverAssembly** と共に設定されている場合は、フィーチャーのイベント プロセッサを実装するクラスを指定します。If set along with **ReceiverAssembly**, specifies the class that implements the Feature event processor.

**RequireResources****RequireResources**

オプションの **Boolean**。Optional **Boolean**. **TRUE**を指定すると、SharePoint Foundation は、そのフィーチャーの標準の "sentinel" リソースが特定のカルチャに対して存在するかどうかを確認することによって、そのフィーチャーのリソースが存在するかどうかを確認します。**TRUE** to specify that SharePoint Foundation check whether resources exist for the Feature by verifying that the standard "sentinel" resource for the Feature is present for a particular culture.

リソースファイルの名前は、'¥ resources\\ resources.`, where `.resx' は、カルチャを識別する名前です。The resource file is named according to the format `\Resources\Resources..resx`, where `` is the name that identifies the culture. SharePoint Foundation は、次の形式でカルチャ名をサポートします。SharePoint Foundation supports the following formats for culture names:

`ll-CC`

`ll-Ssss-CC`


**カルチャ名の例 :****Culture name examples:**

**en-us**英語 (米国)**en-US** English (United States)

**de**ドイツ語 (ドイツ) f**de-DE** German (Germany)f

**fr-fr**フランス語 (フランス)**fr-FR** French (France)

**ja-jp**日本語 (日本)**ja-JP** Japanese (Japan)

**Latn-CS**セルビア語 (ラテン、セルビア)**sr-Latn-CS** Serbian (Latin, Serbia)

インターネット技術標準化委員会 (IETF) の言語タグの`ll(l)-Ssss-CC`形式は、次のとおりです。The Internet Engineering Task Force (IETF) language tag format is `ll(l)-Ssss-CC`, where:

  • `ll(l)`必要な2文字の言語識別子を示します (言語に ISO 2 文字が含まれていない場合は3文字)。`ll(l)` denotes the required two-letter language identifier (or three-letter if there is no ISO two-letter code for the language).

  • `Ssss`省略可能なスクリプト識別子を示します。`Ssss` denotes an optional script identifier.

  • `CC`省略可能な地域識別子を示します。`CC` denotes an optional region identifier.

**RequireResources** 属性によって、フィーチャーの特定の言語のリソースが存在するかどうかに応じて、特定のフィーチャーの表示を制限することができます。The **RequireResources** attribute allows you to constrict the visibility of certain Features depending on whether resources exist in a particular language for the Feature.

**注**: SharePoint Foundation は、 **DefaultResourceFile**属性で指定されているファイルがある場合は、そのファイルを使用しません。1つは、機能の特定の言語のサポートを確認するためのバックアップファイルです。**Note**: SharePoint Foundation does not use the file specified by the **DefaultResourceFile** attribute, if there is one, as a backup file for verifying support of a particular language for a feature.

特定の web サイトまたはサイトコレクションの言語のファイルが存在しない場合は、次の2つの動作が発生する可能性があります。If the file is not present for the language of a particular website or site collection, then two behaviors can occur:

  • この機能は、その言語に対応するリソースが利用できない場合に、web サイトまたはサイトコレクション内の機能をアクティブ化するために、ユーザーインターフェイスに表示されません。The Feature will be hidden from the user interface for activation of Features in the website or site collection if the corresponding resources for the language are not available.

    **RequireResources** 属性は、ユーザー インターフェイスにのみ適用されることに注意してください。Keep in mind that the **RequireResources** attribute is enforced in the user interface only.特定の言語のリソースを持たないフィーチャーは、stsadm.exe を使用したコマンドライン操作またはオブジェクトモデルを介して、web サイトに対してアクティブ化することができます。 A Feature without resources for a particular language can still be activated for a website through command line operations with stsadm.exe or through the object model.

    SharePoint Foundation は、より大きなサイト定義の一部であるフィーチャーに**RequireResources**を強制しません。SharePoint Foundation does not enforce **RequireResources** for Features that are part of a larger site definition.たとえば、%ProgramFiles%\Common に含まれる webtempthai server extensions\15\TEMPLATE\1054\XML を使用して、サイト定義のタイ語バージョンを指定する場合は、フォルダーに含まれている各機能に、適切なリソース。 If you supply, for example, a Thai version of a site definition by putting a webtempThai.xml in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\1054\XML, you must verify that each Feature contained in the folder has the appropriate resources.


  • 一般に、SharePoint Foundation は、機能のユーザーインターフェイス拡張コンポーネントが、リソースを持たない web サイトに表示されないようにしますが、例外があります。In general, SharePoint Foundation ensures that user interface extension components of the Feature do not show up in websites that do not have resources, but there are exceptions. 慎重に **RequireResources** を設定し、一部の機能にリソースが存在しない場合にサイト定義を展開しないようにしても、リソースを利用できない機能がサイトに表示される可能性があります。Even if you do a careful job of setting **RequireResources** and not deploying site definitions unless all Features have resources in them, Features can still show up in sites where resources are not available.

    シナリオ例として、ユーザー設定のツールバーボタンとサイト設定のリンクを提供する2つの言語のリソースがあるカスタム機能と、1つの言語のルート web サイトで新しいサイトコレクションをプロビジョニングしたことを前提としています。As an example scenario, assume that you have a custom Feature with resources for two languages that provides custom toolbar buttons and site settings links, and that you have provisioned a new site collection with a root website in one of the languages. 次に、3番目の言語の言語パックをダウンロードしてインストールした後、元のルート web サイトの下にある3番目の言語で新しいサブサイトをプロビジョニングします。Then, after downloading and installing the language pack for a third language, you provision a new subsite in this third language under the original root website. **RequireResources**が**TRUE**に設定されていない場合は、カスタム機能によってフォールバックリソースがフォールバックされて使用され`Resources\Resources.resx`ます (つまり、と定義されている場合はカルチャを使用しません)。 フォールバックリソースがない場合、SharePoint Foundation は空の文字列を表示します。If **RequireResources** is not set to **TRUE**, the custom Feature will attempt to fall back and use fallback resources (in other words, those defined as `Resources\Resources.resx`, with no culture.)  If there are no fallback resources, SharePoint Foundation will render empty strings.ただし、**RequireResources** が **TRUE** に設定されている場合、リソースが利用できないときには、機能のユーザー インターフェイス拡張コンポーネント (CustomActionListTemplate、または FeatureSiteTemplateAssociation 要素を通じて定義されているコンポーネントなど) はサブサイトに表示されず、カスタム リンクおよびサイトの設定は自動的に非表示になります。 However, if *\*RequireResources** is set to *\*TRUE*\*, user interface extension components of the Feature (for example, those defined through a CustomAction, ListTemplate, or FeatureSiteTemplateAssociation element) will not show up in subsites if no resources are available, so that the custom links and site settings will be automatically hidden.

この属性の設定は、ユーザー インターフェイスによるフィーチャーのアクティブ化にのみ適用され、STSADM.EXE のコマンド ライン操作やオブジェクト モデルによるフィーチャーのアクティブ化には適用されません。Setting this attribute only applies to activating Features through the user interface, and not through STSADM.EXE command-line operations or the object model.

**Scope****Scope**

必須の **Text**。Required **Text**. フィーチャーをアクティブ化できる範囲を指定します。これには、 **farm** (farm)、 **WebApplication** (Web アプリケーション)、**サイト**(サイトコレクション)、 **web** (web サイト) のいずれかの値が含まれています。Specifies the scope in which the Feature can be activated and contains one of the following values: **Farm** (farm), **WebApplication** (Web application), **Site** (site collection), **Web** (website). 範囲の詳細については、「 Element scope」を参照してください。For information about scope, see Element Scope.

**SolutionId****SolutionId**

オプションの **Text**。Optional **Text**. フィーチャーが属するソリューションを指定します。Specifies the solution to which the Feature belongs.

**Title****Title**

オプションの **Text**。Optional **Text**. フィーチャーのタイトルを返します。Returns the title of the Feature. 255 文字に制限されます。Limited to 255 characters.

**UIVersion****UIVersion**

オプションの **Text**。Optional **Text**. この機能のユーザー インターフェイス (UI) バージョンを指定します。Specifies the user interface (UI) version for this Feature. UIVersion は複数の方法で指定されます。UIVersion is specified in multiple ways.

  • `=#`-サイトの uiversion はに`#`等しくなければなりません。`=#` - the site's UIVersion must be equal to `#`.

  • `<#` -="" the="" site's="" uiversion="" must="" be="" less="" than="">

  • `>#`-サイトの uiversion は、より`#`大きい必要があります。`>#` - the site's UIVersion must be greater than `#`.

  • `<=#` -="" the="" site's="" uiversion="" must="" be="" less="" than="" or="" equal="" to="">

  • `>=#`-サイトの uiversion は、以下の値である必要`#`があります。`>=#` - the site's UIVersion must be greater than or equal to `#`.

  • `#;#`-サイトの uiversion は、セミコロンで区切られた番号のリストに含まれている必要があります。`#;#` - the site's UIVersion must be in the semicolon-delimited list of numbers.

**バージョン****Version**

オプションの **Text**。Optional **Text**. **System.Version** に準拠した表現でフィーチャーのバージョンを指定します。Specifies a **System.Version**-compliant representation of the version of a Feature. ピリオドで区切られた、バージョンを表す最大 4 つの数値を指定できます。This can be up to four numbers delimited by decimals that represent a version.

子要素Child elements

ActivationDependenciesElementManifestsPropertiesUpgradeActions Element (Feature)ActivationDependencies, ElementManifests, Properties, UpgradeActions Element (Feature)

親要素Parent elements

なしNone

解説Remarks

SharePoint Foundation は、機能フォルダーとファイル名に対して、下位の ASCII 文字とスペースをサポートしません。SharePoint Foundation supports only low-order ASCII characters, and no spaces, for Feature folder and file names.

Example

この要素の使用方法の例については、「 Feature .xml ファイル」を参照してください。For an example of how this element is used, see Feature.xml Files.