Compartir a través de

Elemento CustomAction

Se aplica a: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Define una extensión a la interfaz de usuario, como un botón de una barra de herramientas o un vínculo en una página de configuración del sitio.

Definición

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

En las siguientes secciones se describen los atributos, elementos secundarios y elementos primarios.

Atributos

Atributo Description
**RequiredAdmin** Opcional **Text**. Especifica los derechos administrativos necesarios para la acción personalizada que se aplicará. Este valor se usa para recortar los vínculos en Administración central. Los valores posibles son:

  • **Delegated**

  • **Farm**

  • **Machine**
**ControlAssembly** Opcional **Text**. Especifica el ensamblado de un control que admite la acción personalizada.
**ControlClass** Opcional **Text**. Especifica una clase de control que admite la acción personalizada.
**ControlSrc** Opcional **Text**. Especifica la dirección URL relativa del archivo .ascx que actúa como origen de la acción personalizada, por ejemplo, "~/_controltemplates/myCustomAction.ascx".
**Description** Opcional **Text**. Especifica una descripción más larga para la acción que se expone como una información sobre herramientas o subdescripción de la acción.
**FeatureId** Opcional **Text**. Identifica la característica asociada con la acción personalizada.
**GroupId** Opcional **Text**. Identifica un grupo de acciones que contiene la acción, por ejemplo, "SiteManagement". Si está contenido en un grupo de acciones personalizado, el valor del **GroupId** atributo debe ser igual al identificador de grupo del elemento CustomActionGroup .

Para obtener una lista de los identificadores de grupo de acciones personalizados predeterminados que se usan en Microsoft SharePoint Foundation, vea Ubicaciones e identificadores de acción personalizados predeterminados.
**Id** Opcional **Text**. Especifica un identificador único para la acción personalizada. El identificador puede ser un GUID o puede ser un término único, por ejemplo, "HtmlViewer".
**ImageUrl** Opcional **Text**. Especifica un vínculo relativo al servidor virtual a una imagen que presenta un icono para el elemento.
**Location** Opcional **Text**. Especifica la ubicación de esta acción personalizada, por ejemplo, "Microsoft.SharePoint.SiteSettings".

Si el **CustomAction** elemento contiene un **CommandUIExtension** elemento secundario, **Location** debe empezar por "CommandUI.Ribbon". Para obtener una lista de las ubicaciones predeterminadas que se usan con la cinta servidor, vea Ubicaciones predeterminadas de personalización de la cinta de opciones del servidor.

Si la acción personalizada es un elemento de menú o un botón de barra de herramientas, las opciones posibles son **EditControlBlock**, **NewFormToolbar**, **DisplayFormToolbar**y **EditFormToolbar**.

Si está incluido en un grupo de acciones personalizado, el valor del **Location** atributo debe ser igual a la ubicación del elemento CustomActionGroup .

Para obtener una lista de las ubicaciones de acción personalizadas predeterminadas que se usan en SharePoint Foundation, vea Ubicaciones e identificadores de acción personalizados predeterminados.
**RegistrationId** Opcional **Text**. Especifica el identificador del tipo de contenido de lista o elemento al que está asociada esta acción, o el tipo de archivo o el identificador de programación (**ProgID**).
**RegistrationType** Opcional **Text**. Especifica el archivo adjunto de registro para una acción por elemento. Entre los valores posibles se incluyen:

  • **None**

  • **List**

  • **ContentType**

  • **ProgId**

  • **FileType**
**RequireSiteAdministrator** Opcional **Boolean**. **TRUE** para especificar que el elemento se muestre solo si el usuario es un administrador del sitio; De lo contrario, **FALSE**. No se admite el uso del **RequireSiteAdministrator** atributo para el menú desplegable de comandos de SharePoint Foundation asociados a elementos de lista.
**Rights** Opcional **Text**. Especifica un conjunto de derechos que el usuario debe tener para que el vínculo sea visible, por ejemplo, "ViewListItems,ManageAlerts". Si no se especifica, la acción siempre aparecerá en la lista de acciones. Para especificar varios derechos, separe los valores mediante comas. El conjunto de derechos se agrupa lógicamente según la **AND** lógica, lo que significa que un usuario debe tener todos los derechos especificados para ver una acción. Para obtener una lista de los valores posibles, vea Microsoft.SharePoint.SPBasePermissions.
**RootWebOnly** Opcional **Boolean**. **TRUE** para implementar la acción personalizada solo en sitios web raíz. Este atributo se aplica a las acciones personalizadas en una solución de espacio aislado.
**ScriptSrc** Opcional **Text**. Especifica un archivo que contiene el script que se va a ejecutar. Este atributo solo es aplicable cuando el **Location** atributo se establece en **ScriptLink**.
**ScriptBlock** Opcional **Text**. Especifica un bloque de script que se va a ejecutar. Este atributo solo es aplicable cuando el **Location** atributo se establece en **ScriptLink**.
**Sequence** Opcional **Integer**. Especifica la prioridad de ordenación para las acciones.
**ShowInLists** Este atributo está desusado y no se debe usar.

Opcional **Boolean**. **TRUE** si la acción personalizada solo se muestra para las listas de la página para administrar los tipos de contenido. El valor predeterminado es **FALSE**.
**ShowInReadOnlyContentTypes** Opcional **Boolean**. **TRUE** si la acción personalizada solo se muestra para los tipos de contenido de solo lectura en la página para administrar los tipos de contenido. El valor predeterminado es **FALSE**.
**ShowInSealedContentTypes** Opcional **Boolean**. **TRUE** si la acción personalizada solo se muestra para los tipos de contenido sellados en la página para administrar los tipos de contenido. El valor predeterminado es **FALSE**.
**Title** Obligatorio **Text**. Especifica la descripción del usuario final para esta acción.
**UIVersion** Opcional **Integer**. Especifica la versión de la interfaz de usuario en la que debe enumerarse esta acción personalizada.

Elementos secundarios

CommandUIExtension

UrlAction

Elementos principales

Elementos

Repeticiones

Mínimo: 1

Máximo: sin límite

Comentarios

Puede usar el elemento CustomAction para agregar controles ASP.NET estándar y controles de usuario (por ejemplo, cuadros de texto o botones de opción) como acciones personalizadas de las barras de herramientas. Sin embargo, solo puede agregar controles que crean instancias de elementos de menú a los menús desplegables de las barras de herramientas; no se pueden agregar elementos web ni controles arbitrarios.

Ejemplo

El ejemplo siguiente forma parte de una característica que reemplaza un botón en la cinta 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>

Consulte también

  • Last updated on