Compartir a través de

Office.Actions interface

  • Referencia
Paquete:
office

Administra acciones y métodos abreviados de teclado.

Métodos

areShortcutsInUse(shortcuts)

Comprueba si un conjunto de combinaciones de accesos directos está actualmente en uso para el usuario, tal como lo define otro complemento o por 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 accesos directos definidos en el manifiesto del complemento para los métodos abreviados de teclado y (2) los accesos directos personalizados del usuario actual si existen. El acceso directo puede ser null si entra en conflicto con el acceso directo de otro complemento o con la aplicación de Office. En concreto, sería null si, cuando se le pide 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 accesos directos, vea Evitar combinaciones de teclas en uso por otros complementos.
replaceShortcuts(shortcuts)

Reemplaza los accesos directos de complemento existentes por métodos abreviados personalizados para el usuario.

Detalles del método

areShortcutsInUse(shortcuts)

Comprueba si un conjunto de combinaciones de accesos directos está actualmente en uso para el usuario, tal como lo define otro complemento o por 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[]

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 true si la combinación de accesos directos entra en conflicto con un acceso directo de otro complemento o con un acceso directo 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

Identificador de una acción definida 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 accesos directos definidos en el manifiesto del complemento para los métodos abreviados de teclado y (2) los accesos directos personalizados del usuario actual si existen. El acceso directo puede ser null si entra en conflicto con el acceso directo de otro complemento o con la aplicación de Office. En concreto, sería null si, cuando se le pide 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 accesos directos, vea Evitar combinaciones de teclas en uso por 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, siendo las teclas los identificadores de las acciones y los valores 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 complemento existentes por métodos abreviados personalizados para el usuario.

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

Parámetros

shortcuts

{[actionId: string]: string}

Objeto de accesos directos personalizados con teclas que son los identificadores de las acciones y los valores que 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 ha registrado cada asignación de accesos directos personalizados en shortcuts . Incluso si hay un conflicto con los accesos directos existentes, se registrará el acceso directo personalizado. De lo contrario, la promesa se rechazará con el código de error y el mensaje de error. Se devuelve un código de error "InvalidOperation" si no existe ningún identificador de acción en shortcuts o si la combinación de acceso directo 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.");
        }
});