Поделиться через

Элемент CustomAction

  • Статья

Дата последнего изменения: 9 марта 2015 г.

Применимо к: 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. Указывает относительный 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

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

Elements

Вхождения

Минимум: 1

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

Примечания

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

Пример

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

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

См. также

Концепции

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