Office.Actions interface

別のアドインまたは Office アプリケーションによって定義されている、ユーザーに対して現在使用されているショートカットの組み合わせのセットがあるかどうかを確認します。 詳細については、「 Office アドインにカスタム キーボード ショートカットを追加する」を参照してください。

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

パラメーター

戻り値

オブジェクトの配列に解決される promise。 各オブジェクトは、ショートカットの組み合わせとブール値で構成されます。 この値は、ショートカットの組み合わせが別のアドインのショートカットまたは Office アプリケーションのショートカットと競合する場合は true されます。それ以外の場合は、 false。 たとえば、 [{shortcut:"Ctrl+1", inUse:true},{shortcut:"Ctrl+2", inUse:false}]。

注釈

要件セット:

• KeyboardShortcuts 1.1

• SharedRuntime 1.1

アクションの ID または名前を関数に関連付けます。

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

パラメーター

戻り値

アドインの既存のショートカットを取得します。 セットには、常に (1) キーボード ショートカット用にアドインのマニフェストで定義されているショートカットと (2) 現在のユーザーのカスタム ショートカット (存在する場合) が含まれます。 ショートカットは、別のアドインのショートカットまたは Office アプリケーションと競合する場合に null できます。 具体的には、使用するショートカットの選択を求められたときに、ユーザーが現在のアドインのアクションを選択しなかった場合は、 null されます。 ショートカットとの競合の詳細については、「他のアドインでキーの組み合わせを使用しないようにする」を参照してください。

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

戻り値

キーが (マニフェストで定義されている) アクションの ID であり、値がショートカットの組み合わせである、ショートカットのオブジェクトに解決される promise。 たとえば、 {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}。

注釈

要件セット:

• KeyboardShortcuts 1.1

• SharedRuntime 1.1

既存のアドイン ショートカットをユーザーのカスタム ショートカットに置き換えます。

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

パラメーター

戻り値

shortcutsのすべてのカスタム ショートカット割り当てが登録されたときに解決される promise。 既存のショートカットと競合している場合でも、カスタマイズされたショートカットが登録されます。 それ以外の場合、エラー コードとエラー メッセージで promise が拒否されます。 shortcuts内のアクション ID が存在しない場合、またはショートカットの組み合わせが無効な場合は、"InvalidOperation" エラー コードが返されます。

注釈

要件セット:

• KeyboardShortcuts 1.1

• SharedRuntime 1.1