SP. UserCustomAction object (sp.js)

Artículo
01/19/2016

Representa una acción personalizada asociada con una lista, un sitio web o un subsitio de SharePoint.

Última modificación: lunes, 9 de marzo de 2015

Hace referencia a: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var object = new SP.UserCustomAction()

Miembros

El objeto UserCustomAction tiene los siguientes miembros.

Constructor

El objeto UserCustomAction tiene el siguiente constructor.

Constructor	Descripción
UserCustomAction	Inicializa una nueva instancia del objeto SP.UserCustomAction.

Métodos

El objeto UserCustomAction tiene los siguientes métodos.

Método	Descripción
deleteObject	Elimina la acción personalizada.
initPropertiesFromJson
actualización	Actualiza la acción personalizada.

Propiedades

El objeto UserCustomAction tiene las siguientes propiedades.

Propiedad	Descripción
commandUIExtension	Obtiene o establece un valor que especifica un fragmento XML específico de la implementación que determina las propiedades de la interfaz de usuario de la acción personalizada.
Descripción	Obtiene o establece la descripción de la acción personalizada.
grupo	Obtiene o establece un valor que especifica un valor específico de la implementación que determina la posición de la acción personalizada en la página.
Id.	Obtiene un valor que especifica el identificador de la acción personalizada.
imageUrl	Obtiene o establece la dirección URL de la imagen asociada con la acción personalizada.
Ubicación	Obtiene o establece la ubicación de la acción personalizada.
Nombre	Obtiene o establece el nombre de la acción personalizada.
registrationId	Obtiene o establece el valor que especifica el identificador del objeto asociado con la acción personalizada.
registrationType	Obtiene o establece el valor que especifica el tipo de objeto asociado con la acción personalizada.
derechos	Obtiene o establece el valor que especifica los permisos necesarios para la acción personalizada.
ámbito	Obtiene un valor que especifica el ámbito de la acción personalizada.
scriptBlock	Obtiene o establece el valor que especifica el ECMAScript que se ejecutará cuando se lleve a cabo la acción personalizada.
scriptSrc	Obtiene o establece un valor que especifica el URI de un archivo que contiene el ECMAScript para ejecutar en la página.
secuencia	Obtiene o establece el valor que especifica un valor específico de la implementación que determina el orden de la acción personalizada que aparece en la página.
Título	Obtiene o establece el título para mostrar de la acción personalizada.
dirección URL	Obtiene o establece la dirección URL, el URI o la función ECMAScript (JScript, JavaScript) asociados con la acción.
versionOfUserCustomAction	Obtiene un valor que especifica un identificador de versión específico de la implementación.

Ejemplo

En el ejemplo siguiente se crea un botón de entrada en una página de aplicación que se agrega un nuevo elemento de menú al menú Acciones del sitio del sitio Web actual.

<asp:Content ID="Main" ContentPlaceHolderID="PlaceHolderMain" runat="server">
<script type="text/ecmascript" language="ecmascript">

function runCode() {
    var clientContext = new SP.ClientContext();
    var site = clientContext.get_web();
    var UserCustomActions = site.get_userCustomActions();

    var newUserCustomAction = UserCustomActions.add();
    newUserCustomAction.set_location('Microsoft.SharePoint.StandardMenu');
    newUserCustomAction.set_group('SiteActions');
    newUserCustomAction.set_sequence(1000);
    newUserCustomAction.set_title('New Menu Item');
    newUserCustomAction.set_imageUrl('/_layouts/images/myIcon.jpg');
    newUserCustomAction.set_description('Menu item added via ECMAScript');
    newUserCustomAction.set_url('/_layouts/create.aspx');
    newUserCustomAction.update();
    clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
}

function onQuerySucceeded(sender, args) {
    alert('New menu item added to Site Actions menu.\n\nTo view the new menu item, refresh the page.');
}

function onQueryFailed(sender, args) {
    alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
}

</script>

    <input id="Button1" type="button" value="Run Code" onclick="runCode()" />

</asp:Content>

Extremo del recurso de REST

Para obtener más información, vea recurso UserCustomAction .

Estructura de URI de extremo

http://<sitecollection>/<site>/_api/web/UserCustomActions(usercustomactionid)

Solicitudes HTTP

Este recurso admite los siguientes comandos HTTP:

Delete

Sintaxis de DELETE

DELETE http://<sitecollection>/<site>/_api/web/UserCustomActions(usercustomactionid)

Sintaxis de MERGE

MERGE http://<sitecollection>/<site>/_api/web/UserCustomActions(usercustomactionid)

Sintaxis de POST

POST http://<sitecollection>/<site>/_api/web/UserCustomActions(usercustomactionid)

Sintaxis de PUT

PUT http://<sitecollection>/<site>/_api/web/UserCustomActions(usercustomactionid)

Compartir a través de