Office.Actions interface

Paquete:
office

Administra las acciones y los métodos abreviados de teclado.

Métodos

areShortcutsInUse(shortcuts)

Comprueba si se está usando un conjunto de combinaciones de métodos abreviados para el usuario, tal como se define en otro complemento o en la aplicación de Office. Para obtener más información, vea Agregar métodos abreviados de teclado personalizados a los complementos de Office.
associate(actionId, actionFunction)

Asocia el identificador o el nombre de una acción a una función.
getShortcuts()

Obtiene los accesos directos existentes para el complemento. El conjunto siempre incluye (1) los métodos abreviados definidos en el manifiesto del complemento para métodos abreviados de teclado y (2) los métodos abreviados personalizados del usuario actual, si existen. El método abreviado puede ser null si entra en conflicto con el método abreviado de otro complemento o con la aplicación de Office. Específicamente, sería si, cuando se null le pida que elija qué acceso directo usar, el usuario no eligió la acción del complemento actual. Para obtener más información sobre los conflictos con los métodos abreviados, vea Evitar combinaciones de teclas que usan otros complementos.
replaceShortcuts(shortcuts)

Reemplaza los accesos directos de complementos existentes por accesos directos personalizados para el usuario.

Detalles del método

areShortcutsInUse(shortcuts)

Comprueba si se está usando un conjunto de combinaciones de métodos abreviados para el usuario, tal como se define en otro complemento o en la aplicación de Office. Para obtener más información, vea Agregar métodos abreviados de teclado personalizados a los complementos de Office.

areShortcutsInUse(shortcuts: string[]): Promise<Array<{shortcut: string, inUse: boolean}>>;

Parámetros

shortcuts

string[]

Una matriz de combinaciones de métodos abreviados. Por ejemplo, ["Ctrl+1", "Ctrl+2"].

Devoluciones

Promise<Array<{shortcut: string, inUse: boolean}>>

Una promesa que se resuelve en una matriz de objetos. Cada objeto consta de una combinación de acceso directo y un valor booleano. El valor es si la combinación de métodos abreviados entra true en conflicto con un acceso directo de otro complemento o con un método abreviado de la aplicación de Office; en caso contrario, false. Por ejemplo, [{shortcut:"Ctrl+1", inUse:true},{shortcut:"Ctrl+2", inUse:false}].

Comentarios

Conjuntos de requisitos:

Ejemplos

// Checks if a specific keyboard shortcut is in use.
const shortcuts = ["Ctrl+Shift+1", "Ctrl+Shift+2"];
Office.actions.areShortcutsInUse(shortcuts)
    .then((shortcutsInUse) => {
        const availableShortcuts = shortcutsInUse.filter((shortcut) => { return !shortcut.inUse; });
        console.log(`Available keyboard shortcuts: ${availableShortcuts}`);
        const usedShortcuts = shortcutsInUse.filter((shortcut) => { return shortcut.inUse; });
        console.log(`Shortcuts in use: ${usedShortcuts}`);
});

associate(actionId, actionFunction)

Asocia el identificador o el nombre de una acción a una función.

associate(actionId: string, actionFunction: (arg?: any) => void): void;

Parámetros

actionId

string

Id. de una acción que se define en el manifiesto.

actionFunction

(arg?: any) => void

Función que se ejecuta cuando se invoca la acción.

Devoluciones

void

Ejemplos

// Maps the action ID to the showTaskPane function.
Office.actions.associate("ShowTaskpane", showTaskPane);

// Displays the add-in's task pane.
function showTaskPane() {
    return Office.addin.showAsTaskpane()
        .then(() => { console.log("Task pane is visible."); })
        .catch((error) => {
            console.log(error.code);
        });
}

getShortcuts()

Obtiene los accesos directos existentes para el complemento. El conjunto siempre incluye (1) los métodos abreviados definidos en el manifiesto del complemento para métodos abreviados de teclado y (2) los métodos abreviados personalizados del usuario actual, si existen. El método abreviado puede ser null si entra en conflicto con el método abreviado de otro complemento o con la aplicación de Office. Específicamente, sería si, cuando se null le pida que elija qué acceso directo usar, el usuario no eligió la acción del complemento actual. Para obtener más información sobre los conflictos con los métodos abreviados, vea Evitar combinaciones de teclas que usan otros complementos.

getShortcuts(): Promise<{[actionId: string]: string|null}>;

Devoluciones

Promise<{[actionId: string]: string|null}>

Una promesa que se resuelve en un objeto de accesos directos, donde las teclas son los identificadores de las acciones (como se define en un manifiesto) y los valores son las combinaciones de métodos abreviados. Por ejemplo, {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}.

Comentarios

Conjuntos de requisitos:

Ejemplos

// Gets the list of keyboard shortcuts for an add-in.
Office.actions.getShortcuts()
    .then((shortcuts) => {
        for (const action in shortcuts) {
            let shortcut = shortcuts[action];
            console.log(`${action}: ${shortcut}`);
        }
});

replaceShortcuts(shortcuts)

Reemplaza los accesos directos de complementos existentes por accesos directos personalizados para el usuario.

replaceShortcuts(shortcuts: {[actionId: string]: string}): Promise<void>;

Parámetros

shortcuts

{[actionId: string]: string}

Un objeto de métodos abreviados personalizados cuyas teclas son los identificadores de las acciones y los valores son las combinaciones de métodos abreviados. Por ejemplo, {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}. Para obtener información sobre cómo especificar un identificador de acción válido y una combinación de teclas, vea Agregar métodos abreviados de teclado personalizados a los complementos de Office. (Tenga en cuenta que una combinación de teclas puede ser null, en cuyo caso, la acción mantiene la combinación de teclas especificada en el archivo JSON).

Devoluciones

Promise<void>

Una promesa que se resuelve cuando se han registrado todas las asignaciones shortcuts de accesos directos personalizados. Incluso si hay un conflicto con los accesos directos existentes, se registrará el acceso directo personalizado. De lo contrario, la promesa será rechazada con un código y un mensaje de error. Se devuelve un OfficeExtension.ErrorCodes.invalidArgument código de error si no existe algún identificador de acción o shortcuts si la combinación de métodos abreviados no es válida.

Comentarios

Conjuntos de requisitos:

Ejemplos

// Replaces the keyboard shortcuts of an add-in.
const customShortcuts = {
    ShowTaskpane:"Ctrl+Shift+1",
    HideTaskpane:"Ctrl+Shift+2"
};
Office.actions.replaceShortcuts(customShortcuts)
    .then(() => { console.log("Keyboard shortcuts successfully registered."); })
    .catch((error) => {
        if (error.code === "InvalidOperation") {
            console.log("ActionId does not exist or shortcut combination is invalid.");
        }
});