Elemento CustomAction

Artículo
09/24/2014

Última modificación: miércoles, 13 de octubre de 2010

Hace referencia a: SharePoint Foundation 2010

En este artículo
Atributos
Elementos secundarios
Elementos primarios
Repeticiones

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.

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

Atributos

Atributo	Descripción
RequiredAdmin	Text opcional. 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	Text opcional. Especifica el ensamblado de un control que admite la acción personalizada.
ControlClass	Text opcional. Especifica una clase de control que admite la acción personalizada.
ControlSrc	Text opcional. Especifica la dirección URL relativa del archivo .ascx que funciona como origen para la acción personalizada (por ejemplo, "~/_controltemplates/myCustomAction.ascx").
Description	Text opcional. 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	Text opcional. Identifica la característica asociada con la acción personalizada.
GroupId	Text opcional. Identifica un grupo de acciones que contiene la acción, como"SiteManagement". Si se encuentra dentro de un grupo de acciones personalizadas, el valor del atributo GroupId debe ser igual que el identificador de grupo del elemento CustomActionGroup. Para obtener una lista de los identificadores de grupo predeterminados de las acciones personalizadas que se usan en Microsoft SharePoint Foundation, vea Ubicaciones e identificadores de acciones personalizadas predeterminadas.
Id	Text opcional. Especifica un identificador único para la acción personalizada. El identificador puede ser un GUID o un término único, como "HtmlViewer".
ImageUrl	Text opcional. Especifica un vínculo relativo al servidor virtual a una imagen que presenta un icono para el elemento.
Location	Text opcional. Especifica la ubicación de esta acción personalizada, por ejemplo "Microsoft.SharePoint.SiteSettings". Si el elemento CustomAction contiene un elemento CommandUIExtension secundario, el atributo Location debe comenzar con "CommandUI.Ribbon". Para obtener una lista de las ubicaciones predeterminadas que se usan con la Cinta de Server, vea Ubicaciones predeterminadas de las personalizaciones de la cinta de Server. Si la acción personalizada es un elemento de menú o un botón de la barra de herramientas, las opciones son EditControlBlock, NewFormToolbar, DisplayFormToolbar y EditFormToolbar. Si se encuentra dentro de un grupo de acciones personalizadas, el valor del atributo Location debe ser igual que la ubicación del elemento CustomActionGroup. Para obtener una lista de las ubicaciones predeterminadas de las acciones personalizadas que se usan en SharePoint Foundation, vea Ubicaciones e identificadores de acciones personalizadas predeterminadas.
RegistrationId	Text opcional. Especifica el identificador del tipo de contenido de lista o elemento al que está asociada esta acción, o el tipo de archivo o identificador de programación (ProgID).
RegistrationType	Text opcional. Especifica el archivo adjunto de registro para una acción por elemento. Entre los valores posibles se incluyen: None List ContentType ProgId FileType
RequireSiteAdministrator	Boolean opcional. Es TRUE para especificar que el elemento se muestra sólo si el usuario es un administrador de sitio; de lo contrario, es FALSE. No se admite el uso del atributo RequireSiteAdministrator para el menú desplegable de comandos de SharePoint Foundation asociados con elementos de lista.
Rights	Text opcional. Especifica un conjunto de derechos que el usuario debe tener para que el vínculo aparezca 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 de forma lógica conforme a la lógica AND, lo que significa que el 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	Boolean opcional. Es TRUE para implementar la acción personalizada solo en los sitios web raíz. Este atributo se aplica a acciones personalizadas de una solución de espacio aislado.
ScriptSrc	Text opcional. Especifica un archivo que contiene el script que se va a ejecutar. Este atributo solo es aplicable cuando se establece el atributo Location en ScriptLink.
ScriptBlock	Text opcional. Especifica un bloque de script que se va a ejecutar. Este atributo solo es aplicable cuando se establece el atributo Location en ScriptLink.
Sequence	Integer opcional. Especifica la prioridad de ordenación para las acciones.
ShowInLists	Este atributo está desusado y no se debe usar. Boolean opcional. Es TRUE si la acción personalizada solo se muestra para listas de la página de administración de tipos de contenido. El valor predeterminado es FALSE.
ShowInReadOnlyContentTypes	Boolean opcional. TRUE si la acción personalizada sólo se muestra para tipos de contenido de sólo lectura en la página de administración de tipos de contenido. El valor predeterminado es FALSE.
ShowInSealedContentTypes	Boolean opcional. TRUE si la acción personalizada sólo se muestra para tipos de contenido sellado en la página de administración de tipos de contenido. El valor predeterminado es FALSE.
Title	Text obligatorio. Especifica la descripción del usuario final para esta acción.
UIVersion	Integer opcional. Especifica la versión de la interfaz de usuario en la que debe enumerarse esta acción personalizada.

Elementos secundarios

CommandUIExtension

UrlAction

Elementos primarios

Elements

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, sólo se pueden agregar controles que creen instancias de elementos de menú a los menús desplegables de las barras de herramientas; no se pueden agregar elementos web o controles arbitrarios.

Ejemplo

El siguiente ejemplo forma parte de una característica que reemplaza a un botón de la Cinta de Server.

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

Vea también

Conceptos

Ubicaciones e identificadores de acciones personalizadas predeterminadas