アドインのインストール時に作業ウィンドウを自動的に開く

アドインの作業ウィンドウは、インストール後すぐに起動するように構成できます。 この機能により使用量が増加します。

ヒント

この記事では、アドインがエンド ユーザーによって インストールされたときに アドインの作業ウィンドウを開くことができるようにする機能について説明します。 この機能のスコープは 1 つのドキュメント (アドインのインストール時に開かれているドキュメント) に限定されます。 この機能は、次の 3 つの同様の機能とは異なります。

  • アドインは、ドキュメントが開いたときに自動的にアドインの作業ウィンドウを開くようにプログラムでドキュメントを構成できます。 この手法には ドキュメント スコープがあり、各ドキュメントに個別に適用する必要があります。 詳細については、「 ドキュメントを含む作業ウィンドウを自動的に開く」を参照してください。
  • アドインは、ドキュメントを開いたときにコードを実行するようにプログラムで構成できます。 また、この機能は各ドキュメントに個別に適用する必要があります。 詳細については、「 ドキュメントを開くときにコードを実行するように構成する」を参照してください。
  • アドインをマニフェストで構成し 、ドキュメントが 開かれたときにコードを実行することができます。 この機能は、 Office アプリケーション スコープです。 Microsoft 365 テナントの管理ポータルで Microsoft 365 管理者がアドインをインストールすると、アドインがサポートするようにマニフェストで構成されている Office アプリケーションで開かれているすべての Office ドキュメントに対してアドインが起動され、コードが実行されます。 詳細については、「 イベントでアドインをアクティブ化する」を参照してください。特に OnDocumentOpened イベントに関する情報。

既定では、アドイン コマンドを含まない作業ウィンドウ アドインは、インストール後すぐに作業ウィンドウを開きます。 ただし、アドインに 1 つ以上のアドイン コマンドがある場合、ユーザーには新しいアドインの通知が表示されますが、アドインは自動的に起動しません。 この歴史的な既定の動作は変更されるため、状況によっては、アドイン コマンドを持つアドインが自動的に起動します。 また、アドインに複数の作業ウィンドウ ページがある場合は、インストール時にアドインを起動するかどうかを制御することも、起動する場合は作業ウィンドウで開くページを制御することもできます。

注:

  • この機能は、エンド ユーザーによってインストールされたアドインにのみ適用され、一元的に展開されたアドインには適用されません。
  • この機能は、コンテンツ アドインまたはメール (Outlook) アドインには適用されません。
  • この機能は、 "作業ウィンドウ コマンド" タイプのアドイン コマンドが少なくとも 1 つあるアドインにのみ適用されます。

新しい動作

新しい動作は次のとおりです。

  • アドインの 作業ウィンドウ コマンドが 1 つしかない場合は、アドインのリボン タブが選択され、インストール時に作業ウィンドウが自動的に開きます。 何も設定する必要はありません。
  • アドインに複数の作業ウィンドウ コマンドがあり、その 1 つが既定として構成されている場合 ( 「既定の作業ウィンドウの構成」を参照)、アドインのリボン タブが選択され、インストール時に既定の作業ウィンドウが自動的に開きます。
  • アドインに複数の作業ウィンドウ コマンドがあり、どれも既定に構成されていない場合は、インストール時にアドインのリボン タブが自動的に選択され、その近くに吹き出しが表示され、ユーザーに新しいアドインを通知する吹き出しが表示されますが、作業ウィンドウは開かれません。 これは、過去の既定の動作と同じです。

注:

何らかの理由で、作業ウィンドウを起動するアドイン コマンドを起動時にユーザーが手動で選択できない場合 (起動時に 無効にするように構成されている場合 など)、構成に関係なく自動的に開きません。

マニフェストの既定の作業ウィンドウを構成する

既定の作業ウィンドウを指定するプロセスは、アドインで使用されているマニフェストの種類によって異なります。

既定の作業ウィンドウを指定するには、既定にするページの URL に "code.page" プロパティが設定されている "runtimes" 配列でランタイム オブジェクトを見つけます。 この同じランタイム オブジェクト内の "actions" 配列に、 "type" 値が "openPage" のアクションが少なくとも 1 つあることを確認します。 このアクション オブジェクトに "view" プロパティを追加し、 "Office.AutoShowTaskpaneWithDocument" に設定します。 この値は 1 つのアクション オブジェクトに対してのみ設定でき、タイプ "openPage" のアクションである必要があります。 複数のアクションでこの値を設定すると、値の最初の出現が既定として認識され、それ以外は無視されます。

次の例は、"Office.AutoShowTaskpaneWithDocument" に設定された"view"値を示しています。

"runtimes": [
    {
        ...
        "code": {
            "page": "https://contoso.com/taskpane.html"
        },
        "actions": [
            {
                "id": "ShowTaskPane",
                "type": "openPage",
                "view": "Office.AutoShowTaskpaneWithDocument"
            }
        ]
    }
]

ヒント

ユーザーがドキュメントを再度開くたびにアドインが自動的に起動するようにするには、さらに構成手順を実行する必要があります。 この機能を使用する場合の詳細とアドバイスについては、「 ドキュメントを含む作業ウィンドウを自動的に開く」を参照してください。

関連項目

  • Last updated on