Elemento CustomAction

Artigo
04/08/2023

Aplica-se a: SharePoint 2016 | SharePoint Foundation 2013 | | do SharePoint Online SharePoint Server 2013

Define uma extensão para a interface do usuário, como um botão em uma barra de ferramentas ou um link em uma página de configurações do site.

Definição

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

Elementos e atributos

As seções a seguir descrevem os atributos, os elementos filhos e os elementos pai.

Atributos

Atributo	Descrição
`RequiredAdmin`	Opcional `Text`. Especifica os direitos administrativos necessários para que a ação personalizada seja aplicada. Esse valor é usado para cortar links na Administração Central. Os valores possíveis são: `Delegated` `Farm` `Machine`
`ControlAssembly`	Opcional `Text`. Especifica o assembly de um controle que dá suporte à ação personalizada.
`ControlClass`	Opcional `Text`. Especifica uma classe de controle que dá suporte à ação personalizada.
`ControlSrc`	Opcional `Text`. Especifica a URL relativa do arquivo .ascx que serve como a origem da ação personalizada, por exemplo, `"~/_controltemplates/myCustomAction.ascx"`.
`Description`	Opcional `Text`. Especifica uma descrição mais longa para a ação que é exposta como uma dica de ferramenta ou subdescrição para a ação.
`FeatureId`	Opcional `Text`. Identifica o Recurso associado à ação personalizada.
`GroupId`	Opcional `Text`. Identifica um grupo de ações que contém a ação, por exemplo, `"SiteManagement"`. Se ele estiver contido em um grupo de ações personalizado, o valor do `GroupId` atributo deverá ser igual à ID do grupo do elemento CustomActionGroup . Para obter uma lista das IDs de grupo de ações personalizadas padrão usadas no Microsoft SharePoint Foundation, consulte Locais e IDs de ação personalizados padrão.
`Id`	Opcional `Text`. Especifica um identificador exclusivo para a ação personalizada. A ID pode ser um GUID ou pode ser um termo exclusivo, por exemplo, `"HtmlViewer"`.
`ImageUrl`	Opcional `Text`. Especifica um link relativo do servidor virtual para uma imagem que apresenta um ícone para o item.
`Location`	Opcional `Text`. Especifica o local dessa ação personalizada, por exemplo, `"Microsoft.SharePoint.SiteSettings"`. Se o `CustomAction` elemento contiver um `CommandUIExtension` elemento filho, o `Location` deverá começar com "CommandUI.Ribbon". Para obter uma lista de locais padrão que são usados com a faixa de opções do Servidor, consulte Locais de Personalização da Faixa de Opções do Servidor Padrão. Se a ação personalizada for um item de menu ou botão de barra de ferramentas, as opções possíveis incluem `EditControlBlock`, `NewFormToolbar`, `DisplayFormToolbar`e `EditFormToolbar`. Se ele estiver contido em um grupo de ações personalizado, o valor do `Location` atributo deverá ser igual ao local do elemento CustomActionGroup . Para obter uma lista dos locais de ação personalizados padrão usados no SharePoint Foundation, consulte Locais e IDs de Ação Personalizada Padrão.
`RegistrationId`	Opcional `Text`. Especifica o identificador da lista ou do tipo de conteúdo do item ao qual essa ação está associada, ou o tipo de arquivo ou identificador programático (`ProgID`).
`RegistrationType`	Opcional `Text`. Especifica o anexo de registro de uma ação por item. Os valores possíveis incluem: `None` `List` `ContentType` `ProgId` `FileType`
`RequireSiteAdministrator`	Opcional `Boolean`. `TRUE` para especificar se o item será exibido somente se o usuário for um administrador do site; caso contrário, `FALSE`. Não há suporte para usar o `RequireSiteAdministrator` atributo para o menu suspenso dos comandos do SharePoint Foundation associados a itens de lista.
`Rights`	Opcional `Text`. Especifica um conjunto de direitos que o usuário deve ter para que o link fique visível, por exemplo, `"ViewListItems,ManageAlerts"`. Se não for especificado, a ação sempre será exibida na lista de ações. Para especificar vários direitos, separe os valores usando vírgulas. O conjunto de direitos é agrupado logicamente de acordo com a `AND` lógica, o que significa que um usuário deve ter todos os direitos especificados para ver uma ação. Para obter uma lista de valores possíveis, consulte Microsoft.SharePoint.SPBasePermissions.
`RootWebOnly`	Opcional `Boolean`. `TRUE` para implantar a ação personalizada somente em sites raiz. Esse atributo se aplica a ações personalizadas em uma solução com área restrita.
`ScriptSrc`	Opcional `Text`. Especifica um arquivo que contém script a ser executado. Esse atributo só é aplicável quando o `Location` atributo é definido como `ScriptLink`.
`ScriptBlock`	Opcional `Text`. Especifica um bloco de script a ser executado. Esse atributo só é aplicável quando o `Location` atributo é definido como `ScriptLink`.
`Sequence`	Opcional `Integer`. Especifica a prioridade de ordenação para ações.
`ShowInLists`	Esse atributo é preterido e não deve ser usado. Opcional `Boolean`. `TRUE` se a ação personalizada for exibida apenas para listas na página para gerenciar tipos de conteúdo. O valor padrão é `FALSE`.
`ShowInReadOnlyContentTypes`	Opcional `Boolean`. `TRUE` se a ação personalizada for exibida apenas para tipos de conteúdo somente leitura na página para gerenciar tipos de conteúdo. O valor padrão é `FALSE`.
`ShowInSealedContentTypes`	Opcional `Boolean`. `TRUE` se a ação personalizada for exibida apenas para tipos de conteúdo selados na página para gerenciar tipos de conteúdo. O valor padrão é `FALSE`.
`Title`	Necessário `Text`. Especifica a descrição do usuário final para essa ação.
`UIVersion`	Opcional `Integer`. Especifica a versão da interface do usuário na qual essa ação personalizada deve ser listada.

Elementos filho

CommandUIExtension

UrlAction

Elementos pai

Elementos

Occurrences

Mínimo: 1

Máximo: Desvinculado

Comentários

Você pode usar o elemento CustomAction para adicionar controles de ASP.NET padrão e controles de usuário (por exemplo, caixas de texto ou botões de opção) como ações personalizadas em barras de ferramentas. No entanto, você só pode adicionar controles instanciando itens de menu aos menus suspensos das barras de ferramentas; você não pode adicionar web parts ou controles arbitrários.

Exemplo

O exemplo a seguir faz parte de um recurso que substitui um botão na faixa de opções do Servidor.

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

Confira também

IDs e locais de ação personalizada padrão

Atributo	Descrição
`RequiredAdmin`	Opcional `Text`. Especifica os direitos administrativos necessários para que a ação personalizada seja aplicada. Esse valor é usado para cortar links na Administração Central. Os valores possíveis são: `Delegated` `Farm` `Machine`
`ControlAssembly`	Opcional `Text`. Especifica o assembly de um controle que dá suporte à ação personalizada.
`ControlClass`	Opcional `Text`. Especifica uma classe de controle que dá suporte à ação personalizada.
`ControlSrc`	Opcional `Text`. Especifica a URL relativa do arquivo .ascx que serve como a origem da ação personalizada, por exemplo, `"~/_controltemplates/myCustomAction.ascx"`.
`Description`	Opcional `Text`. Especifica uma descrição mais longa para a ação que é exposta como uma dica de ferramenta ou subdescrição para a ação.
`FeatureId`	Opcional `Text`. Identifica o Recurso associado à ação personalizada.
`GroupId`	Opcional `Text`. Identifica um grupo de ações que contém a ação, por exemplo, `"SiteManagement"`. Se ele estiver contido em um grupo de ações personalizado, o valor do `GroupId` atributo deverá ser igual à ID do grupo do elemento CustomActionGroup . Para obter uma lista das IDs de grupo de ações personalizadas padrão usadas no Microsoft SharePoint Foundation, consulte Locais e IDs de ação personalizados padrão.
`Id`	Opcional `Text`. Especifica um identificador exclusivo para a ação personalizada. A ID pode ser um GUID ou pode ser um termo exclusivo, por exemplo, `"HtmlViewer"`.
`ImageUrl`	Opcional `Text`. Especifica um link relativo do servidor virtual para uma imagem que apresenta um ícone para o item.
`Location`	Opcional `Text`. Especifica o local dessa ação personalizada, por exemplo, `"Microsoft.SharePoint.SiteSettings"`. Se o `CustomAction` elemento contiver um `CommandUIExtension` elemento filho, o `Location` deverá começar com "CommandUI.Ribbon". Para obter uma lista de locais padrão que são usados com a faixa de opções do Servidor, consulte Locais de Personalização da Faixa de Opções do Servidor Padrão. Se a ação personalizada for um item de menu ou botão de barra de ferramentas, as opções possíveis incluem `EditControlBlock`, `NewFormToolbar`, `DisplayFormToolbar`e `EditFormToolbar`. Se ele estiver contido em um grupo de ações personalizado, o valor do `Location` atributo deverá ser igual ao local do elemento CustomActionGroup . Para obter uma lista dos locais de ação personalizados padrão usados no SharePoint Foundation, consulte Locais e IDs de Ação Personalizada Padrão.
`RegistrationId`	Opcional `Text`. Especifica o identificador da lista ou do tipo de conteúdo do item ao qual essa ação está associada, ou o tipo de arquivo ou identificador programático (`ProgID`).
`RegistrationType`	Opcional `Text`. Especifica o anexo de registro de uma ação por item. Os valores possíveis incluem: `None` `List` `ContentType` `ProgId` `FileType`
`RequireSiteAdministrator`	Opcional `Boolean`. `TRUE` para especificar se o item será exibido somente se o usuário for um administrador do site; caso contrário, `FALSE`. Não há suporte para usar o `RequireSiteAdministrator` atributo para o menu suspenso dos comandos do SharePoint Foundation associados a itens de lista.
`Rights`	Opcional `Text`. Especifica um conjunto de direitos que o usuário deve ter para que o link fique visível, por exemplo, `"ViewListItems,ManageAlerts"`. Se não for especificado, a ação sempre será exibida na lista de ações. Para especificar vários direitos, separe os valores usando vírgulas. O conjunto de direitos é agrupado logicamente de acordo com a `AND` lógica, o que significa que um usuário deve ter todos os direitos especificados para ver uma ação. Para obter uma lista de valores possíveis, consulte Microsoft.SharePoint.SPBasePermissions.
`RootWebOnly`	Opcional `Boolean`. `TRUE` para implantar a ação personalizada somente em sites raiz. Esse atributo se aplica a ações personalizadas em uma solução com área restrita.
`ScriptSrc`	Opcional `Text`. Especifica um arquivo que contém script a ser executado. Esse atributo só é aplicável quando o `Location` atributo é definido como `ScriptLink`.
`ScriptBlock`	Opcional `Text`. Especifica um bloco de script a ser executado. Esse atributo só é aplicável quando o `Location` atributo é definido como `ScriptLink`.
`Sequence`	Opcional `Integer`. Especifica a prioridade de ordenação para ações.
`ShowInLists`	Esse atributo é preterido e não deve ser usado. Opcional `Boolean`. `TRUE` se a ação personalizada for exibida apenas para listas na página para gerenciar tipos de conteúdo. O valor padrão é `FALSE`.
`ShowInReadOnlyContentTypes`	Opcional `Boolean`. `TRUE` se a ação personalizada for exibida apenas para tipos de conteúdo somente leitura na página para gerenciar tipos de conteúdo. O valor padrão é `FALSE`.
`ShowInSealedContentTypes`	Opcional `Boolean`. `TRUE` se a ação personalizada for exibida apenas para tipos de conteúdo selados na página para gerenciar tipos de conteúdo. O valor padrão é `FALSE`.
`Title`	Necessário `Text`. Especifica a descrição do usuário final para essa ação.
`UIVersion`	Opcional `Integer`. Especifica a versão da interface do usuário na qual essa ação personalizada deve ser listada.

Partilhar via