CustomAction 要素

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

適用対象: SharePoint Foundation 2010

この記事の内容
属性
子要素
親要素
出現回数

ツールバー上のボタン、サイト設定ページ上のリンクなど、ユーザーインターフェイスの拡張を定義します。

<CustomAction
  RequiredAdmin = "Delegated | Farm | Machine"
  ControlAssembly = "Text"
  ControlClass = "Text"
  ControlSrc = "Text"
  Description = "Text"
  FeatureId = "Text"
  GroupId = "Text"
  Id = "Text"
  ImageUrl = "Text"
  Location = "Text"
  RegistrationId = "Text"
  RegistrationType = "Text"
  RequireSiteAdministrator = "TRUE" | "FALSE"
  Rights = "Text"
  RootWebOnly = "TRUE" | "FALSE"
  ScriptSrc = "Text"
  ScriptBlock = "Text"
  Sequence = "Integer"
  ShowInLists = "TRUE" | "FALSE"
  ShowInReadOnlyContentTypes = "TRUE" | "FALSE"
  ShowInSealedContentTypes = "TRUE" | "FALSE"
  Title = "Text"
  UIVersion = "Integer">
</CustomAction>

属性

属性	説明
RequiredAdmin	オプションの Text。カスタム アクションに適用する必要のある管理権限を指定します。この値を使用して、サーバーの全体管理内のリンクをトリミングします。以下のいずれかの値を使用できます。 Delegated Farm Machine
ControlAssembly	オプションの Text。カスタム アクションを操作するコントロールのアセンブリを指定します。
ControlClass	オプションの Text。カスタム アクションを操作するコントロールのクラスを指定します。
ControlSrc	オプションの Text。カスタム アクションのソースとして機能する .ascx ファイルの相対 URL を指定します (例 : "~/_controltemplates/myCustomAction.ascx")。
Description	オプションの Text。アクションの説明文で、ヒント、あるいは補助的な説明として表示します。
FeatureId	オプションの Text。カスタム アクションに関連付ける機能を特定します。
GroupId	オプションの Text。このアクションを含むアクション グループを特定します (例: "SiteManagement")。これがカスタム アクション グループに含まれる場合、GroupId 属性の値は、CustomActionGroup 要素のグループ ID と一致する必要があります。 Microsoft SharePoint Foundation で使用される既定のカスタム アクション グループ ID の一覧については、「カスタム アクションの既定の場所および ID」を参照してください。
Id	オプションの Text。カスタム アクションの一意識別子を指定します。ID には、GUID または一意の用語を指定できます (例: "HtmlViewer")。
ImageUrl	オプションの Text。アイテムに対応するアイコン画像を指す、仮想サーバーを基準とした相対リンクを指定します。
Location	オプションの Text。このカスタム アクションの場所を指定します (例: "Microsoft.SharePoint.SiteSettings")。 CustomAction 要素に CommandUIExtension 子要素が含まれる場合、Location は、"CommandUI.Ribbon" で始まる必要があります。Server リボンで使用される既定の場所の一覧については、「既定のサーバー リボンのカスタマイズの場所」を参照してください。 カスタム アクションがメニュー アイテムやツール バー ボタンの場合、EditControlBlock、NewFormToolbar、DisplayFormToolbar、および EditFormToolbar オプションを指定できます。 これがカスタム アクション グループに含まれる場合、Location 属性の値は、CustomActionGroup 要素の場所に一致する必要があります。 SharePoint Foundation で使用される既定のカスタム アクションの場所の一覧については、「カスタム アクションの既定の場所および ID」を参照してください。
RegistrationId	オプションの Text。このアクションに対応するリストまたはアイテムのコンテンツ タイプ識別子、ファイル型、プログラム ID (ProgID) のいずれかを指定します。
RegistrationType	オプションの Text。RegistrationId に指定したのが何であるかを指定します。以下のいずれかの値を使用できます。 None List ContentType ProgId FileType
RequireSiteAdministrator	オプションの Boolean。TRUE を指定すると、ユーザーがサイト管理者の場合にのみアイテムが表示されます。それ以外の場合は FALSE を指定します。リスト アイテムに関連付けられている SharePoint Foundation コマンドのドロップダウン メニューで RequireSiteAdministrator 属性を使用することはサポートされていません。
Rights	オプションの Text。リンクを表示するためにユーザーが持つ必要のある一連の権限を指定します (例: "ViewListItems,ManageAlerts")。これを指定しない場合、アクションはアクションの一覧に常に表示されます。複数の権限を指定するには、カンマを使用して値を区切ります。一連の権限は AND ロジックに従って論理的にグループ化されます。つまり、アクションを表示するには、ユーザーは指定されたすべての権限を持つ必要があります。使用できる値の一覧については、Microsoft.SharePoint.SPBasePermissions を参照してください。
RootWebOnly	オプションの Boolean。TRUE を指定すると、カスタム アクションはルート Web サイトにのみ表示されます。この属性は、サンドボックス ソリューション内のカスタム アクションに適用されます。
ScriptSrc	オプションの Text。実行するスクリプトが含まれるファイルを指定します。この属性を適用できるのは、Location 属性が ScriptLink に設定されている場合のみです。
ScriptBlock	オプションの Text。実行するスクリプトのブロックを指定します。この属性を適用できるのは、Location 属性が ScriptLink に設定されている場合のみです。
Sequence	オプションの Integer。アクションの適用順序 (優先順位) を指定します。
ShowInLists	この属性は使用されなくなるため、使用しないでください。 オプションの Boolean。コンテンツ タイプの管理ページ上の一覧にのみカスタム アクションを表示する場合は、TRUE を指定します。既定値は FALSE です。
ShowInReadOnlyContentTypes	オプションの Boolean。TRUE ならば、コンテンツ タイプの管理ページでは、読み込み専用と設定されているコンテンツ タイプに対してのみカスタム アクションを表示するようになります。既定値は FALSE です。
ShowInSealedContentTypes	オプションの Boolean。TRUE ならば、コンテンツ タイプの管理ページでは、シールされたコンテンツ タイプに対してのみカスタム アクションを表示するようになります。既定値は FALSE です。
Title	必須の Text。このアクションのエンド ユーザー向けの説明文を指定します。
UIVersion	オプションの Integer。このカスタム アクションを表示する必要のあるユーザー インターフェイスのバージョンを指定します。

子要素

CommandUIExtension

UrlAction

親要素

Elements

出現回数

最小 : 1 最大 : 制約なし

コメント

CustomAction 要素を使うと、標準的な ASP.NET コントロールやユーザー コントロール (たとえば、テキスト ボックス、またはオプション ボタン) を、カスタム アクションとしてツール バーに追加できます。ただし、ツール バーのドロップダウン メニューに追加できるのは、メニュー アイテムとして表示されるコントロールに限ります。Web パーツその他は、追加できません。

例

次の例は、Server リボン上のボタンを置き換える機能の一部です。

<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
  <CustomAction Id="Ribbon.Library.Actions.ReplacementButton"
    Location="CommandUI.Ribbon"
    RegistrationId="101"
    RegistrationType="List"
    Title="Replace a Ribbon Button">
    <CommandUIExtension>
      <CommandUIDefinitions>
        <CommandUIDefinition
          Location="Ribbon.Library.Actions.ConnectToClient">
             <Button Id="Ribbon.Library.Actions.ConnectToClient.ReplacementButton"
               Command="ReplacementButtonCommand"
               Image16by16="Insert an image URL here."
               Image32by32="Insert an image URL here."
               LabelText="Replaced Button"
               TemplateAlias="o2" />
        </CommandUIDefinition>
      </CommandUIDefinitions>
      <CommandUIHandlers>
        <CommandUIHandler
          Command="ReplacementButtonCommand"
          CommandAction="javascript:alert('This button has been replaced.');" />
      </CommandUIHandlers>
    </CommandUIExtension>
  </CustomAction>
</Elements>

関連項目

概念

カスタム アクションの既定の場所および ID