CustomAction 要素CustomAction Element

適用されます: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint オンライン |SharePoint Server 2013Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

ツールバー上のボタン、サイト設定ページ上のリンクなど、ユーザーインターフェイスの拡張を定義します。Defines an extension to the user interface, such as a button on a toolbar or a link on a site settings page.

定義Definition

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

要素と属性Elements and attributes

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

属性Attributes

属性Attribute

説明Description

RequiredAdminRequiredAdmin

テキストを指定します。Optional Text. 適用するカスタム動作に必要な管理者権限を指定します。Specifies the administrative rights that are required for the custom action to apply. この値は、サーバーの全体管理内のリンクをトリムするのには使用されます。This value is used to trim links in Central Administration. 使用可能な値は次のとおりです。Possible values are:

  • 委任Delegated

  • ファームFarm

  • マシンMachine

ControlAssemblyControlAssembly

テキストを指定します。Optional Text. カスタム動作をサポートするコントロールのアセンブリを指定します。Specifies the assembly of a control that supports the custom action.

ControlClassControlClass

テキストを指定します。Optional Text. カスタム動作をサポートするコントロール クラスを指定します。Specifies a control class that supports the custom action.

ControlSrcControlSrc

テキストを指定します。Optional Text. など、カスタム アクションのソースとして機能する .ascx ファイルの相対 URL を指定する"~/_controltemplates/myCustomAction.ascx"Specifies the relative URL of the .ascx file that serves as the source for the custom action, for example, "~/_controltemplates/myCustomAction.ascx".

説明Description

テキストを指定します。Optional Text. ツール ヒントとして公開されている操作の詳しい説明や操作の部分の説明を指定します。Specifies a longer description for the action that is exposed as a tooltip or sub-description for the action.

FeatureIdFeatureId

テキストを指定します。Optional Text. カスタム アクションに関連付けられている機能を識別します。Identifies the Feature that is associated with the custom action.

グループ IdGroupId

テキストを指定します。Optional Text. などのアクションを含むアクションのグループを識別する"SiteManagement"Identifies an action group that contains the action, for example, "SiteManagement". カスタム アクションのグループの内で含まれている場合、グループ Id属性の値は、 CustomActionGroup要素のグループ ID を等しくなければなりません。If it is contained within a custom action group, the value of the GroupId attribute must equal the group ID of the CustomActionGroup element.

既定のカスタム アクション グループは、Microsoft SharePoint Foundation で使用する Id のリストは、既定のカスタム アクションの場所と Idを参照してください。For a list of the default custom action group IDs that are used in Microsoft SharePoint Foundation, see Default Custom Action Locations and IDs.

IdId

テキストを指定します。Optional Text. カスタム アクションの一意の識別子を指定します。Specifies a unique identifier for the custom action. ID は GUID である場合がありますか、固有の用語では、たとえば、 "HtmlViewer"The ID may be a GUID, or it may be a unique term, for example, "HtmlViewer".

ImageUrlImageUrl

テキストを指定します。Optional Text. アイテムのアイコンが表示されるイメージへの仮想サーバーの相対リンクを指定します。Specifies a virtual server relative link to an image that presents an icon for the item.

LocationLocation

テキストを指定します。Optional Text. たとえば、カスタム アクションの場所を指定"Microsoft.SharePoint.SiteSettings"Specifies the location of this custom action, for example, "Microsoft.SharePoint.SiteSettings".

CustomAction要素にCommandUIExtensionの子要素が含まれている場合、場所は、"CommandUI.Ribbon"で始まらなければなりません。If the CustomAction element contains a CommandUIExtension child element, the Location must start with "CommandUI.Ribbon". サーバー リボンで使用される既定の場所のリストは、既定のサーバー リボンのカスタマイズの場所を参照してください。For a list of default locations that are used with the Server ribbon, see Default Server Ribbon Customization Locations.

カスタム アクションがメニュー項目またはツール バー ボタンの場合は、使用可能なオプションには、 EditControlBlockNewFormToolbarDisplayFormToolbar、およびEditFormToolbarが含まれます。If the custom action is a menu item or toolbar button, the possible options include EditControlBlock, NewFormToolbar, DisplayFormToolbar, and EditFormToolbar.

カスタム アクションのグループの内で含まれている場合、場所の属性の値は、 CustomActionGroup要素の位置を等しくなければなりません。If it is contained within a custom action group, the value of the Location attribute must equal the location of the CustomActionGroup element.

SharePoint Foundation で使用されるカスタム アクションの既定の場所のリストは、既定のカスタム アクションの場所と Idを参照してください。For a list of the default custom action locations that are used in SharePoint Foundation, see Default Custom Action Locations and IDs.

RegistrationIdRegistrationId

テキストを指定します。Optional Text. このアクションが関連付けられているリストまたはアイテム コンテンツ タイプまたはファイルの種類の id またはプログラム識別子 (ProgID) を指定します。Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier (ProgID).

RegistrationTypeRegistrationType

テキストを指定します。Optional Text. 項目ごとのアクションの登録の添付ファイルを指定します。Specifies the registration attachment for a per-item action. 以下のいずれかの値を使用できます。Possible values include:

  • NoneNone

  • ListList

  • ContentTypeContentType

  • ProgIdProgId

  • FileTypeFileType

RequireSiteAdministratorRequireSiteAdministrator

省略可能なブール値です。Optional Boolean. 該当項目をユーザーがサイトの管理者である場合にのみ表示するように指定するのにはそれ以外の場合、 false を指定します。TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. リスト アイテムに関連付けられている SharePoint Foundation のコマンドのドロップ ダウン メニューのRequireSiteAdministrator属性を使用することはサポートされていません。Using the RequireSiteAdministrator attribute for the drop-down menu of SharePoint Foundation commands that are associated with list items is not supported.

Rights

テキストを指定します。Optional Text. ユーザーいる必要がありますが表示されるへのリンクなど、権限のセットを指定する"ViewListItems,ManageAlerts"Specifies a set of rights that the user must have for the link to be visible, for example, "ViewListItems,ManageAlerts". このオプションを指定しない場合は、アクションの一覧で常に、アクションが表示されます。If it is not specified, the action always appears in the list of actions. 複数の権限を指定するには、コンマを使用して値を区切ります。To specify multiple rights, separate the values by using commas. 権限のセットに分類されて論理的なANDロジックは、ユーザー アクションを表示するのには指定されたすべての権限がある必要があることを意味します。The set of rights are grouped logically according to AND logic, which means that a user must have all the specified rights to see an action. 使用可能な値のリストは、 Microsoft.SharePoint.SPBasePermissionsを参照してください。For a list of possible values, see Microsoft.SharePoint.SPBasePermissions.

RootWebOnlyRootWebOnly

省略可能なブール値です。Optional Boolean. TRUEルート web サイトに対してのみカスタム アクションを展開します。TRUE to deploy the custom action only on root websites. この属性は、サンド ボックス ソリューション内のカスタム動作に適用されます。This attribute applies to custom actions in a sandboxed solution.

ScriptSrcScriptSrc

テキストを指定します。Optional Text. 実行するスクリプトを含むファイルを指定します。Specifies a file that contains script to be executed. この属性は、 ScriptLink場所の属性が設定されている場合にのみ適用されます。This attribute is only applicable when the Location attribute is set to ScriptLink.

スクリプト ブロックScriptBlock

テキストを指定します。Optional Text. 実行するスクリプトのブロックを指定します。Specifies a block of script to be executed. この属性は、 ScriptLink場所の属性が設定されている場合にのみ適用されます。This attribute is only applicable when the Location attribute is set to ScriptLink.

SequenceSequence

省略可能な整数です。Optional Integer. アクションの順序の優先順位を指定します。Specifies the ordering priority for actions.

ShowInListsShowInLists

この属性は使用されなくなるため、使用しないでください。This attribute is deprecated and should not be used.

省略可能なブール値です。Optional Boolean. TRUEの場合は、カスタム動作にのみ表示されます。 コンテンツ タイプを管理するためのページに一覧表示されます。TRUE if the custom action is only displayed for lists on the page for managing content types. 既定値は、 false を指定します。The default value is FALSE.

ShowInReadOnlyContentTypesShowInReadOnlyContentTypes

省略可能なブール値です。Optional Boolean. TRUEの場合、カスタム動作は、コンテンツ タイプを管理するため、ページ上の読み取り専用のコンテンツ タイプにのみ表示されます。。TRUE if the custom action is only displayed for read-only content types on the page for managing content types. 既定値は、 false を指定します。The default value is FALSE.

ShowInSealedContentTypesShowInSealedContentTypes

省略可能なブール値です。Optional Boolean. のカスタム アクションが表示されるのみである場合に、コンテンツ タイプを管理するため、ページ上のコンテンツ タイプがシールされています。TRUE if the custom action is only displayed for sealed content types on the page for managing content types. 既定値は、 false を指定します。The default value is FALSE.

TitleTitle

テキストが必要です。Required Text. このアクションのエンド ・ ユーザーの説明を指定します。Specifies the end-user description for this action.

UIVersionUIVersion

省略可能な整数です。Optional Integer. このカスタム アクションを表示するユーザー インターフェイスのバージョンを指定します。Specifies the version of the user interface in which this custom action should be listed.

子要素Child elements

CommandUIExtensionCommandUIExtension

UrlActionUrlAction

親要素Parent elements

要素Elements

出現回数Occurrences

最小: 1Minimum: 1

最大: 制約なしMaximum: Unbounded

解説Remarks

CustomAction要素を使用すると、標準の ASP.NET コントロールとユーザーのコントロール (たとえば、テキスト ボックスやオプション ボタン) をツールバーにカスタム動作として追加します。You can use the CustomAction element to add standard ASP.NET controls and user controls (for example, text boxes or option buttons) as custom actions in toolbars. ただし、できるだけコントロールを追加するツールバーのドロップ ダウン メニューのメニュー項目のインスタンスを作成します。web パーツまたは任意のコントロールを追加することはできません。However, you can only add controls instantiating menu items to the drop-down menus of toolbars; you cannot add web parts or arbitrary controls.

Example

次の使用例は、Server リボン上のボタンを置換する機能の一部です。The following example is part of a Feature that replaces a button on the Server ribbon.

    <Elements xmlns="http://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>


関連項目See also