次の方法で共有

Feature 要素 (フィーチャー)

  • [アーティクル]

最終更新日: 2015年3月9日

適用対象: SharePoint Foundation 2010

この記事の内容
属性
子要素
親要素

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

<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

オプションの Boolean。インストール時または Web アプリケーションの作成時に既定でフィーチャーがアクティブ化される場合は TRUE、フィーチャーがアクティブ化されない場合は FALSE。既定では、この属性は TRUE です。ActivateOnDefault 属性は、サイト コレクション (Site) または Web サイト (Web) を対象範囲とするフィーチャーには適用されません。

一般的に、Farm を対象範囲とするフィーチャーはインストール時にアクティブ化され、Web アプリケーションの作成時には、Web application を対象範囲とするインストールされるすべてのフィーチャーがアクティブ化されます。

AlwaysForceInstall

オプションの Boolean。フィーチャーが既にインストールされている場合でも、インストール時に強制的にフィーチャーがインストールされる場合は TRUE。たとえば、TRUE に設定されている場合、ユーザーが scanforfeatures または installfeature のコマンド ライン操作を使用してフィーチャーをインストールしようとすると (既にフィーチャーがインストールされている場合でも)、フィーチャー展開イベント ハンドラー は常に実行されます。既定では、この属性は FALSE です。AlwaysForceInstall 属性は、すべての対象範囲のフィーチャーに影響します。

AutoActivateInCentralAdmin

オプションの Boolean。フィーチャーが管理用 Web サイト、サイト コレクション、または Web アプリケーションで既定でアクティブ化される場合は TRUE。既定では、この属性は FALSE です。AutoActivateInCentralAdmin 属性は、Farm を対象範囲とするフィーチャーには適用されません。

Creator

オプションの Text。

DefaultResourceFile

オプションの Text。機能の XML リソースを取得するための共通リソース ファイルを示します。このファイルにリソースを指定していない場合、SharePoint Foundation は既定で %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATES\FEATURES\機能名\Resources\Resources.カルチャ.resx 内を検索します。ただし、アプリケーションのすべての機能で共有されるコア リソース ファイルを提供する場合は、DefaultResourceFile を使用して、リソースにアクセスするために使用する代替ファイルを指定できます。たとえば、「DefaultResourceFile="自分のファイル"」と設定した場合、SharePoint Foundation は %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\Resources\自分のファイル.カルチャ.resx 内を検索し、機能のローカライズされたリソースを取得します。

Description

オプションの String。フィーチャーが実行する内容の詳細な説明を返します。

Hidden

オプションの Boolean。既定では、この属性は FALSE です。

Id

必須の Text。フィーチャーのグローバル一意識別子 (GUID) を格納します。

ImageUrl

オプションの Text。ユーザー インターフェイス (UI) でフィーチャーを表すために使用する画像の、/_layouts/IMAGES ディレクトリからの相対 URL を格納します。

ImageUrlAltText

オプションの Text。フィーチャーを表す画像の代替テキストを格納します。

ReceiverAssembly

オプションの Text。ReceiverClass と共に設定されている場合は、フィーチャーのイベントを処理するレシーバの読み込み元であるグローバル アセンブリ キャッシュにある署名されたアセンブリの厳密な名前を指定します。

ReceiverClass

オプションの Text。ReceiverAssembly と共に設定されている場合は、フィーチャーのイベント プロセッサを実装するクラスを指定します。

RequireResources

オプションの Boolean。機能の標準の "標識" リソースが特定のカルチャについて存在することを検証することによって、機能のリソースが存在するかどうかを SharePoint Foundation が確認することを指定する場合は TRUE。

リソース ファイルには、<機能ディレクトリ>\Resources\Resources. <カルチャ名> の形式に従って名前が付けられます。ここで、<カルチャ名> はカルチャを識別する名前です。SharePoint Foundation がサポートしているカルチャ名の形式は次のとおりです。

ll-CC

ll-Ssss-CC

カルチャ名の例 :

en-US 英語 (米国)

de-DE ドイツ語 (ドイツ)

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

ja-JP 日本語 (日本)

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

Internet Engineering Task Force (IETF) の言語タグ形式は、ll(l)-Ssss-CC です。各要素の意味は次のとおりです。

  • ll(l) は、2 文字の必須の言語識別子です (ISO の 2 文字言語コードがない場合は 3 文字)。

  • Ssss は、スクリプト識別子です (省略可能)。

  • CC は、地域識別子です (省略可能)。

RequireResources 属性によって、フィーチャーの特定の言語のリソースが存在するかどうかに応じて、特定のフィーチャーの表示を制限することができます。

注意

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

特定の Web サイトまたはサイト コレクションの言語のファイルが存在しない場合、2 つの動作を使用できます。

  • 対応する言語のリソースが利用できない場合は、Web サイトまたはサイト コレクションのフィーチャーをアクティブ化するためのユーザー インターフェイスでフィーチャーを非表示にします。

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

    SharePoint Foundation は、大規模なサイト定義を構成する機能について、RequireResources を適用しません。たとえば、webtempThai.xml を %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\1054\XML に配置することによってタイ語バージョンのサイト定義を提供する場合は、このフォルダーに含まれる各機能について適切なリソースが存在することを検証する必要があります。

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

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

この属性の設定は、ユーザー インターフェイスによるフィーチャーのアクティブ化にのみ適用され、STSADM.EXE のコマンド ライン操作やオブジェクト モデルによるフィーチャーのアクティブ化には適用されません。

Scope

必須の Text。フィーチャーをアクティブにできる範囲を指定します。Farm (ファーム)、WebApplication (Web アプリケーション)、Site (サイト コレクション)、Web (Web サイト) のいずれかの値を格納します。範囲については、「要素の範囲」を参照してください。

SolutionId

オプションの Text。フィーチャーが属するソリューションを指定します。

Title

オプションの Text。フィーチャーのタイトルを返します。255 文字に制限されます。

UIVersion

オプションの Text。この機能のユーザー インターフェイス (UI) バージョンを指定します。UIVersion は複数の方法で指定されます。

  • =# - サイトの UIVersion は # と等しくなければなりません。

  • <# - サイトの UIVersion は # よりも小さくなければなりません。

  • ># - サイトの UIVersion は # よりも大きくなければなりません。

  • <=# - サイトの UIVersion は # 以下でなければなりません。

  • >=# - サイトの UIVersion は # 以上でなければなりません。

  • #;# - サイトの UIVersion の数値はセミコロンで区切られていなければなりません。

Version

オプションの Text。System.Version に準拠した表現でフィーチャーのバージョンを指定します。ピリオドで区切られた、バージョンを表す最大 4 つの数値を指定できます。

子要素

ActivationDependencies、ElementManifests、Properties、UpgradeActions 要素 (フィーチャー)

親要素

なし

コメント

SharePoint Foundation では、機能のフォルダー名やファイル名として、空白を除く、7 ビット ASCII 文字のみをサポートしています。

例

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