Office.Actions interface

  • リファレンス
パッケージ:
office

アクションとキーボード ショートカットを管理します。

プロパティ

associate

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

メソッド

areShortcutsInUse(shortcuts)

別のアドインまたは Office アプリケーションによって定義されている、ユーザーに対して現在使用されているショートカットの組み合わせのセットがあるかどうかを確認します。
getShortcuts()

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

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

プロパティの詳細

associate

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

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

プロパティ値

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

メソッドの詳細

areShortcutsInUse(shortcuts)

別のアドインまたは Office アプリケーションによって定義されている、ユーザーに対して現在使用されているショートカットの組み合わせのセットがあるかどうかを確認します。

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

パラメーター

shortcuts

string[]

ショートカットの組み合わせの配列。 たとえば、 ["Ctrl+1", "Ctrl+2"]です。

戻り値

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

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

注釈

要件セット:

getShortcuts()

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

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

戻り値

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

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

注釈

要件セット:

replaceShortcuts(shortcuts)

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

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

パラメーター

shortcuts

{[actionId: string]: string}

キーがアクションの ID (拡張マニフェストで定義されている) であり、値がショートカットの組み合わせであるカスタム ショートカットのオブジェクト。 たとえば、 {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}です。 有効なアクション ID とキーの組み合わせを指定する方法については、「 Office アドインにカスタム キーボード ショートカットを追加する」を参照してください。(キーの組み合わせは である null場合があることに注意してください。この場合、アクションは JSON ファイルで指定されたキーの組み合わせを保持します)。

戻り値

Promise<void>

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

注釈

要件セット: