Share via

Office.Actions interface

  • Referência
Pacote:
office

Gerencia ações e atalhos de teclado.

Propriedades

associate

Associa a ID ou o nome de uma ação a uma função.

Métodos

areShortcutsInUse(shortcuts)

Verifica se um conjunto de combinações de atalhos está atualmente em uso para o usuário, conforme definido por outro suplemento ou pelo aplicativo do Office.
getShortcuts()

Obtém os atalhos existentes para o suplemento. O conjunto sempre inclui (1) os atalhos definidos no manifesto estendido do suplemento para atalhos de teclado e (2) os atalhos personalizados do usuário atual se eles existirem. O atalho pode ser null se ele entrar em conflito com o atalho de outro suplemento ou com o aplicativo do Office. Especificamente, seria null se, quando solicitado a escolher qual atalho usar, o usuário não escolhesse a ação do suplemento atual. Para obter mais informações sobre conflitos com atalhos, consulte Evitar combinações de chaves em uso por outros suplementos.
replaceShortcuts(shortcuts)

Substitui atalhos de suplemento existentes por atalhos personalizados para o usuário.

Detalhes da propriedade

associate

Associa a ID ou o nome de uma ação a uma função.

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

Valor da propriedade

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

Detalhes do método

areShortcutsInUse(shortcuts)

Verifica se um conjunto de combinações de atalhos está atualmente em uso para o usuário, conforme definido por outro suplemento ou pelo aplicativo do Office.

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

Parâmetros

shortcuts

string[]

Uma matriz de combinações de atalho. Por exemplo, ["Ctrl+1", "Ctrl+2"].

Retornos

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

Uma promessa que resolve para uma matriz de objetos. Cada objeto consiste em uma combinação de atalho e valor booliano. O valor será true se a combinação de atalho entrar em conflito com um atalho de outro suplemento ou com um atalho do aplicativo do Office; caso contrário, false. Por exemplo, [{shortcut:"Ctrl+1", inUse:true},{shortcut:"Ctrl+2", inUse:false}].

Comentários

Conjuntos de requisitos:

getShortcuts()

Obtém os atalhos existentes para o suplemento. O conjunto sempre inclui (1) os atalhos definidos no manifesto estendido do suplemento para atalhos de teclado e (2) os atalhos personalizados do usuário atual se eles existirem. O atalho pode ser null se ele entrar em conflito com o atalho de outro suplemento ou com o aplicativo do Office. Especificamente, seria null se, quando solicitado a escolher qual atalho usar, o usuário não escolhesse a ação do suplemento atual. Para obter mais informações sobre conflitos com atalhos, consulte Evitar combinações de chaves em uso por outros suplementos.

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

Retornos

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

Uma promessa que resolve para um objeto de atalhos, com chaves sendo as IDs das ações (conforme definido em um manifesto estendido) e valores sendo as combinações de atalho. Por exemplo, {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}.

Comentários

Conjuntos de requisitos:

replaceShortcuts(shortcuts)

Substitui atalhos de suplemento existentes por atalhos personalizados para o usuário.

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

Parâmetros

shortcuts

{[actionId: string]: string}

Um objeto de atalhos personalizados com chaves sendo as IDs das ações (conforme definido em um manifesto estendido) e valores sendo as combinações de atalho. Por exemplo, {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}. Para saber como especificar uma ID de ação válida e uma combinação de chaves, consulte Adicionar atalhos de teclado personalizados aos suplementos do Office. (Observe que uma combinação de chaves pode ser null, nesse caso, a ação mantém a combinação de chaves especificada no arquivo JSON.)

Retornos

Promise<void>

Uma promessa que é resolvida quando cada atribuição de atalho personalizada no shortcuts foi registrada. Mesmo que haja um conflito com atalhos existentes, o atalho personalizado será registrado. Caso contrário, a promessa será rejeitada com código de erro e mensagem de erro. Um código de erro "InvalidOperation" será retornado se alguma ID de ação em shortcuts não existir ou se a combinação de atalhos for inválida.

Comentários

Conjuntos de requisitos: