Элемент CustomAction

Область применения: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Определяет расширение пользовательского интерфейса, такое как кнопка на панели инструментов или ссылка на странице настроек веб-сайта.

Определение

<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`. Указывает относительный URL-адрес ASCX-файла, который служит источником для настраиваемого действия, например `"~/_controltemplates/myCustomAction.ascx"`.
`Description`	Необязательный параметр `Text`. Указывает длинное описание для действия, которое выводится в виде подсказки, или вложенное описание для действия.
`FeatureId`	Необязательный параметр `Text`. Определяет компонент, связанный с настраиваемым действием.
`GroupId`	Необязательный параметр `Text`. Определяет группу действий, содержащую действие, например `"SiteManagement"`. Если он содержится в настраиваемой группе действий, значение атрибута `GroupId` должно равняться идентификатору группы элемента CustomActionGroup . Список идентификаторов настраиваемых групп действий по умолчанию, используемых в Microsoft SharePoint Foundation, см. в разделе Расположения и идентификаторы настраиваемых действий по умолчанию.
`Id`	Необязательный параметр `Text`. Указывает уникальный идентификатор для настраиваемого действия. Идентификатор может быть идентификатором GUID или уникальным термином, например `"HtmlViewer"`.
`ImageUrl`	Необязательный параметр `Text`. Указывает ссылку виртуального сервера на изображение, представляющее значок для элемента.
`Location`	Необязательный параметр `Text`. Указывает расположение этого настраиваемого действия, например `"Microsoft.SharePoint.SiteSettings"`. `CustomAction` Если элемент содержит дочерний `CommandUIExtension` элемент, `Location` он должен начинаться с CommandUI.Ribbon. Список расположений по умолчанию, используемых с лентой сервера, см. в разделе Расположения настройки ленты сервера по умолчанию. Если настраиваемое действие является элементом меню или кнопкой панели инструментов, возможные параметры: `EditControlBlock`, `NewFormToolbar`, `DisplayFormToolbar`и `EditFormToolbar`. Если он содержится в настраиваемой группе действий, значение атрибута `Location` должно равняться расположению элемента CustomActionGroup . Список расположений настраиваемых действий по умолчанию, используемых в SharePoint Foundation, см. в разделе Расположения и идентификаторы настраиваемых действий по умолчанию.
`RegistrationId`	Необязательный параметр `Text`. Указывает идентификатор типа контента списка или элемента, с которым связано это действие, или тип файла или программный идентификатор (`ProgID`).
`RegistrationType`	Необязательный параметр `Text`. Указывает вложения для регистрации для поэлементного действия. Возможные значения: `None` `List` `ContentType` `ProgId` `FileType`
`RequireSiteAdministrator`	Необязательный параметр `Boolean`. `TRUE` значение , чтобы указать, что элемент будет отображаться только в том случае, если пользователь является администратором сайта; В противном случае — `FALSE`значение . Использование атрибута `RequireSiteAdministrator` для раскрывающегося меню команд SharePoint Foundation, связанных с элементами списка, не поддерживается.
`Rights`	Необязательный параметр `Text`. Указывает набор прав, которые должны быть у пользователя, чтобы ссылка была видимой, например `"ViewListItems,ManageAlerts"`. Если набор не задан, действие всегда будет отображаться в списке действий. Чтобы указать несколько прав, разделите значения запятыми. Набор прав логически группируется в соответствии с `AND` логикой, что означает, что пользователь должен иметь все указанные права для просмотра действия. Список возможных значений см. в статье Microsoft.SharePoint.SPBasePermissions.
`RootWebOnly`	Необязательный параметр `Boolean`. `TRUE` для развертывания настраиваемого действия только на корневых веб-сайтах. Этот атрибут применяется к пользовательским действиям в изолированном решении.
`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

Родительские элементы

Элементы

Occurrences

Минимум: 1

Максимум: без ограничений

Замечания

Элемент CustomAction используется для добавления стандартных элементов управления ASP.NET и пользовательских элементов управления (например, текстовых полей и переключателей) в качестве пользовательских действий на панели элементов. Однако в раскрывающиеся меню панелей инструментов можно добавлять только элементы управления, создающие экземпляры. нельзя добавлять веб-части или произвольные элементы управления.

Пример

Следующий пример является частью компонента, который заменяет кнопку на ленте сервера.

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

См. также

Расположения и идентификаторы дополнительных действий по умолчанию

Last updated on 2023-04-08

Атрибут	Описание
`RequiredAdmin`	Необязательный параметр `Text`. Определяет административные права, необходимые для применения настраиваемого действия. Это значение используется для усечения ссылок в центре администрирования. Возможные значения: `Delegated` `Farm` `Machine`
`ControlAssembly`	Необязательный параметр `Text`. Указывает сборку элемента управления, поддерживающую настраиваемое действие.
`ControlClass`	Необязательный параметр `Text`. Указывает класс элемента управления, поддерживающий настраиваемое действие.
`ControlSrc`	Необязательный параметр `Text`. Указывает относительный URL-адрес ASCX-файла, который служит источником для настраиваемого действия, например `"~/_controltemplates/myCustomAction.ascx"`.
`Description`	Необязательный параметр `Text`. Указывает длинное описание для действия, которое выводится в виде подсказки, или вложенное описание для действия.
`FeatureId`	Необязательный параметр `Text`. Определяет компонент, связанный с настраиваемым действием.
`GroupId`	Необязательный параметр `Text`. Определяет группу действий, содержащую действие, например `"SiteManagement"`. Если он содержится в настраиваемой группе действий, значение атрибута `GroupId` должно равняться идентификатору группы элемента CustomActionGroup . Список идентификаторов настраиваемых групп действий по умолчанию, используемых в Microsoft SharePoint Foundation, см. в разделе Расположения и идентификаторы настраиваемых действий по умолчанию.
`Id`	Необязательный параметр `Text`. Указывает уникальный идентификатор для настраиваемого действия. Идентификатор может быть идентификатором GUID или уникальным термином, например `"HtmlViewer"`.
`ImageUrl`	Необязательный параметр `Text`. Указывает ссылку виртуального сервера на изображение, представляющее значок для элемента.
`Location`	Необязательный параметр `Text`. Указывает расположение этого настраиваемого действия, например `"Microsoft.SharePoint.SiteSettings"`. `CustomAction` Если элемент содержит дочерний `CommandUIExtension` элемент, `Location` он должен начинаться с CommandUI.Ribbon. Список расположений по умолчанию, используемых с лентой сервера, см. в разделе Расположения настройки ленты сервера по умолчанию. Если настраиваемое действие является элементом меню или кнопкой панели инструментов, возможные параметры: `EditControlBlock`, `NewFormToolbar`, `DisplayFormToolbar`и `EditFormToolbar`. Если он содержится в настраиваемой группе действий, значение атрибута `Location` должно равняться расположению элемента CustomActionGroup . Список расположений настраиваемых действий по умолчанию, используемых в SharePoint Foundation, см. в разделе Расположения и идентификаторы настраиваемых действий по умолчанию.
`RegistrationId`	Необязательный параметр `Text`. Указывает идентификатор типа контента списка или элемента, с которым связано это действие, или тип файла или программный идентификатор (`ProgID`).
`RegistrationType`	Необязательный параметр `Text`. Указывает вложения для регистрации для поэлементного действия. Возможные значения: `None` `List` `ContentType` `ProgId` `FileType`
`RequireSiteAdministrator`	Необязательный параметр `Boolean`. `TRUE` значение , чтобы указать, что элемент будет отображаться только в том случае, если пользователь является администратором сайта; В противном случае — `FALSE`значение . Использование атрибута `RequireSiteAdministrator` для раскрывающегося меню команд SharePoint Foundation, связанных с элементами списка, не поддерживается.
`Rights`	Необязательный параметр `Text`. Указывает набор прав, которые должны быть у пользователя, чтобы ссылка была видимой, например `"ViewListItems,ManageAlerts"`. Если набор не задан, действие всегда будет отображаться в списке действий. Чтобы указать несколько прав, разделите значения запятыми. Набор прав логически группируется в соответствии с `AND` логикой, что означает, что пользователь должен иметь все указанные права для просмотра действия. Список возможных значений см. в статье Microsoft.SharePoint.SPBasePermissions.
`RootWebOnly`	Необязательный параметр `Boolean`. `TRUE` для развертывания настраиваемого действия только на корневых веб-сайтах. Этот атрибут применяется к пользовательским действиям в изолированном решении.
`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`. Определяет версию пользовательского интерфейса, в котором должно быть указано это настраиваемое действие.