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

適用されます: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint オンライン |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

ActivateOnDefaultActivateOnDefault

オプションの BooleanOptional Boolean. TRUEの機能はインストール時に既定で有効にする場合、または Web アプリケーションが作成されます。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. ActivateOnDefault属性は、サイト コレクション (サイト) には適用されませんまたは 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.

AlwaysForceInstallAlwaysForceInstall

オプションの Boolean。フィーチャーが既にインストールされている場合でも、インストール時に強制的にフィーチャーがインストールされる場合は TRUE。たとえば、TRUE に設定されている場合、ユーザーが scanforfeatures または installfeature のコマンド ライン操作を使用してフィーチャーをインストールしようとすると (既にフィーチャーがインストールされている場合でも)、フィーチャー展開イベント ハンドラー は常に実行されます。既定では、この属性は FALSE です。AlwaysForceInstall 属性は、すべての対象範囲のフィーチャーに影響します。Optional Boolean. TRUE if the Feature is installed by force during installation even if the Feature is already installed. 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. This attribute equals FALSE by default. The AlwaysForceInstall attribute affects Features of all scopes.

AutoActivateInCentralAdminAutoActivateInCentralAdmin

オプションの BooleanOptional 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属性は、ファームには適用されません-機能のスコープを設定します。The AutoActivateInCentralAdmin attribute does not apply to Farm-scoped Features.

作成者Creator

オプションの TextOptional Text.

DefaultResourceFileDefaultResourceFile

オプションの TextOptional Text. フィーチャーの XML リソースを取得するための共通のリソース ファイルを示します。Indicates a common resource file for retrieving Feature XML resources. ファイルにリソースを指定しないと、SharePoint Foundation が既定では、%ProgramFiles%\Common ファイルにサーバーの extensions\15\TEMPLATES\FEATURES 検索*FeatureName * \Resources\Resources。カルチャ_の .resx。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 ファイルにサーバーの extensions\15\Resources*MyFile *。フィーチャーのローカライズされたリソースを取得するために_カルチャ_の .resx。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

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

IdId

必須の TextRequired Text. フィーチャーのグローバル一意識別子 (GUID) が含まれています。Contains the globally unique identifier (GUID) for the Feature.

ImageUrlImageUrl

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

ImageUrlAltTextImageUrlAltText

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

ReceiverAssemblyReceiverAssembly

オプションの TextOptional 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.

ReceiverClassReceiverClass

オプションの TextOptional Text. かどうかクラスを指定すると、 ReceiverAssembly、設定を実装する機能のイベント プロセッサです。If set along with ReceiverAssembly, specifies the class that implements the Feature event processor.

RequireResourcesRequireResources

オプションの BooleanOptional Boolean. TRUEを指定する SharePoint Foundation チェック機能の標準的な「標識」リソースが特定のカルチャの存在を確認することで、機能のリソースが存在するかどうか。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。.resx, where' は、カルチャを識別する名前です。The resource file is named according to the format <Feature Directory>\Resources\Resources.<Culture Name>.resx, where <Culture Name> 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 DEF のドイツ語 (ドイツ)de-DE German (Germany)f

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

JA-JP日本語 (日本)ja-JP Japanese (Japan)

sr-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 文字の言語識別子、3 文字の言語の ISO の 2 文字コードがない場合) を示します。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 は、1 つとしての機能の特定の言語のサポートを確認するためのバックアップ ファイルを使用する必要がある場合は、 DefaultResourceFile属性で指定されたファイルを使用しません。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 ファイルにサーバーの extensions\15\TEMPLATE\1054\XML で、webtempThai.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 つの言語のリソースとユーザー設定機能があることと、言語のいずれかのルート 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. RequireResourcesTRUEに設定されていないカスタム機能しようとフォールバック、フォールバック リソースを使用する (として定義されているつまり、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. ただし、 RequireResourcesTRUEに設定されている場合に、ユーザー インターフェイス機能 (ユーザー設定アクションListTemplate、または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

必須の TextRequired Text. 機能をアクティブ化するスコープを指定し、次の値のいずれかが含まれています: (ファーム) のファームweb アプリケーション(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). スコープの詳細については、要素のスコープを参照してください。For information about scope, see Element Scope.

SolutionIdSolutionId

オプションの TextOptional Text. 機能が所属するソリューションを指定します。Specifies the solution to which the Feature belongs.

タイトルTitle

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

UIVersionUIVersion

オプションの Text。この機能のユーザー インターフェイス (UI) バージョンを指定します。UIVersion は複数の方法で指定されます。Optional Text. Specifies the user interface (UI) version for this Feature. 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.

VersionVersion

オプションの TextOptional Text. System.Versionを指定の機能のバージョンの準拠の形式です。Specifies a System.Version-compliant representation of the version of a Feature. バージョンを表す 10 進数で区切られた 4 つまでの番号を指定できます。This can be up to four numbers delimited by decimals that represent a version.

子要素Child elements

ActivationDependenciesElementManifestsプロパティUpgradeActions 要素 (機能)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.