Action 要素

[アーティクル]
08/24/2024

ユーザーが Button コントロールまたは Menu コントロールを選択したときに実行するアクションを指定します。

次の VersionOverrides スキーマでのみ有効です:

作業ウィンドウ 1.0
メール 1.0
メール 1.1

詳細については、「アドインのみのマニフェストでのバージョンのオーバーライド」を参照してください。

次の要件セットに関連付けられています:

親 <VersionOverrides> が Taskpane 1.0 型の場合、AddinCommands 1.1。
親 <VersionOverrides> が Mail 1.0 型の場合、Mailbox 1.3。
親 <VersionOverrides> が Mail 1.1 型の場合、Mailbox 1.5。

属性

属性	必須	説明
xsi:type	はい	実行する操作の種類

xsi:type

この属性は、ユーザーがボタンをクリックしたときに実行される操作の種類を指定します。次のいずれかを指定できます。

ExecuteFunction
ShowTaskpane

ユーザーが ExecuteFunction アクションを開始するボタンを選択すると、アドインはそれまでに完了していない場合、5 分後にタイムアウトします。

重要

Outlook: メールボックスとアイテムのイベントの登録は、xsi:type がExecuteFunctionされている場合は使用できません。

子要素

有効な子要素は、 xsi:type パラメーターの値に非常に依存します。

xsi:type は ExecuteFunction です

要素	説明
FunctionName	実行する関数の名前を指定します。

FunctionName

xsi:type がExecuteFunctionされている場合に必要な要素。実行する関数の名前を指定します。関数は、FunctionFile 要素に指定されたファイルに含まれています。

<Action xsi:type="ExecuteFunction">
  <FunctionName>getSubject</FunctionName>
</Action>

xsi:type は ShowTaskpane です

要素	説明
SourceLocation	この操作のソースファイルの場所を指定します。
TaskpaneId	作業ウィンドウコンテナーの ID を指定します。 Outlook アドインではサポートされていません。
Title	作業ウィンドウのカスタムタイトルを指定します。 Outlook アドインではサポートされていません。
SupportsPinning	作業ウィンドウがピン留めをサポートすることを指定します。これにより、ユーザーが選択を変更したときも作業ウィンドウが開いたままになります。 Outlook でのみサポートされます。
SupportsMultiselect	Outlook アドインが複数の選択したメッセージでアクティブ化できることを指定します。 Outlook でのみサポートされます。
SupportsNoItemContext	閲覧ウィンドウが有効になっていないか、メッセージが選択されていない状態で Outlook アドインをアクティブ化できることを指定します。 Outlook デスクトップクライアントでのみサポートされます。

SourceLocation

xsi:type がShowTaskpaneされている場合に必要な要素。この操作のソースファイルの場所を指定します。 resid 属性は 32 文字以下であり、Resources 要素の <Urls> 要素の <Url> 要素の id 属性の値に設定する必要があります。

<Action xsi:type="ShowTaskpane">
  <SourceLocation resid="readTaskPaneUrl" />
</Action>

TaskpaneId

xsi:type がShowTaskpaneされている場合の省略可能な要素。作業ウィンドウコンテナーの ID を指定します。複数のShowTaskpaneアクションがある場合は、それぞれに独立したウィンドウが必要な場合は>別の<TaskpaneId を使用します。同じウィンドウを共有するさまざまなアクションに対して、同じ <TaskpaneId> を使用します。ユーザーが同じ <TaskpaneId>を共有するコマンドを選択すると、ウィンドウコンテナーは開いたままですが、ウィンドウの内容は対応するアクション SourceLocationに置き換えられます。

アドインの種類: 作業ウィンドウ

次の VersionOverrides スキーマでのみ有効です:

作業ウィンドウ 1.0

詳細については、「アドインのみのマニフェストでのバージョンのオーバーライド」を参照してください。

次の要件セットに関連付けられています:

AddinCommands 1.1

注:

この要素は、Outlook ではサポートされていません。

次の例は、同じ <TaskpaneId>を共有する 2 つのアクションを示しています。

<Action xsi:type="ShowTaskpane">
  <TaskpaneId>MyPane</TaskpaneId>
  <SourceLocation resid="aTaskPaneUrl" />
</Action>

<Action xsi:type="ShowTaskpane">
  <TaskpaneId>MyPane</TaskpaneId>
  <SourceLocation resid="anotherTaskPaneUrl" />
</Action>

次の例では、異なる <TaskpaneId> を使用する 2 つのアクションを示します。これらの例をコンテキストで確認するには、「 Simple Add-in Commands Sample」を参照してください。

<Action xsi:type="ShowTaskpane">
   <TaskpaneId>MyTaskPaneID1</TaskpaneId>
   <SourceLocation resid="Contoso.Taskpane1.Url" />
</Action>

<Action xsi:type="ShowTaskpane">
   <TaskpaneId>MyTaskPaneID2</TaskpaneId>
   <SourceLocation resid="Contoso.Taskpane2.Url" />
</Action>

<bt:Urls>
   <bt:Url id="Contoso.Taskpane1.Url" DefaultValue="https://commandsimple.azurewebsites.net/Taskpane.html" />
   <bt:Url id="Contoso.Taskpane2.Url" DefaultValue="https://commandsimple.azurewebsites.net/Taskpane2.html" />
</bt:Urls>

タイトル

xsi:type がShowTaskpaneされている場合の省略可能な要素。この操作に関する、作業ウィンドウのカスタムタイトルを指定します。

アドインの種類: 作業ウィンドウ

次の VersionOverrides スキーマでのみ有効です:

作業ウィンドウ 1.0

詳細については、「アドインのみのマニフェストでのバージョンのオーバーライド」を参照してください。

次の要件セットに関連付けられています:

AddinCommands 1.1

注:

この子要素は、Outlook アドインではサポートされていません。

次の例は、 <Title> 要素を使用するアクションを示しています。 <Title>を文字列に直接割り当てないでください。代わりに、マニフェストの <Resources> セクションで定義され、32 文字以下のリソース ID (レジド) を割り当てます。

<Action xsi:type="ShowTaskpane">
    <TaskpaneId>Office.AutoShowTaskpaneWithDocument</TaskpaneId>
    <SourceLocation resid="PG.Code.Url" />
    <Title resid="PG.CodeCommand.Title" />
</Action>

 ... Other markup omitted ...
<Resources>
    <bt:Images> ...
    </bt:Images>
    <bt:Urls>
        <bt:Url id="PG.Code.Url" DefaultValue="https://localhost:3000?commands=1" />
    </bt:Urls>
    <bt:ShortStrings>
        <bt:String id="PG.CodeCommand.Title" DefaultValue="Code" />
    </bt:ShortStrings>
 ... Other markup omitted ...
</Resources>

SupportsPinning

xsi:type がShowTaskpaneされている場合の省略可能な要素。 VersionOverrides 要素を含むには、xsi:type 属性値がVersionOverridesV1_1必要です。作業ウィンドウのピン留めをサポートする場合は、この要素に true の値を含めます。ユーザーは、作業ウィンドウをピン留めできるようになります。ピン留めすると、選択を変更したときも作業ウィンドウが開いたままになります。詳細については、「Outlook にピン留め可能な作業ウィンドウを実装する」を参照してください。

アドインの種類: メール

次の VersionOverrides スキーマでのみ有効です:

メール 1.1

詳細については、「アドインのみのマニフェストでのバージョンのオーバーライド」を参照してください。

次の要件セットに関連付けられています:

Mailbox 1.5

重要

SupportsPinning 要素は要件セット 1.5 で導入されましたが、現在は次を使用する Microsoft 365 サブスクライバーでのみサポートされています。

モダン Outlook on the web
新しい Outlook on Windows
Windows 上の Outlook 2016 以降 (ビルド 7628.1000 以降)
Outlook on Mac (ビルド 16.13.503 以降)

<Action xsi:type="ShowTaskpane">
  <SourceLocation resid="readTaskPaneUrl" />
  <SupportsPinning>true</SupportsPinning>
</Action>

SupportsMultiselect

xsi:type がShowTaskpaneされている場合の Outlook アドインの省略可能な要素。アドインが複数の選択したメッセージに対して特定の操作をアクティブ化および実行できるようにするには、 true の値を含めます。項目の複数選択はメッセージにのみ適用されるため、 ExtensionPoint 要素の xsi:type 属性値を MessageReadCommandSurface または MessageComposeCommandSurface に設定する必要があります。アイテムの複数選択の詳細については、「複数のメッセージで Outlook アドインをアクティブ化する」を参照してください。

アドインの種類: メール

次の VersionOverrides スキーマでのみ有効です:

メール 1.1

詳細については、「アドインのみのマニフェストでのバージョンのオーバーライド」を参照してください。

次の要件セットに関連付けられています:

メールボックス 1.13

<Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskpaneUrl" />
    <SupportsMultiSelect>true</SupportsMultiSelect>
</Action>

SupportsNoItemContext

xsi:type がShowTaskpaneされている場合の Outlook アドインの省略可能な要素。 [閲覧ウィンドウ] を有効にしたり、メッセージを選択したりせずにアドインをアクティブ化できるようにするには、 true の値を含めます。 <SupportsNoItemContext>がtrueに設定されている場合は、ExtensionPoint 要素の xsi:type 属性値を MessageReadCommandSurface に設定する必要があります。詳細については、「閲覧ウィンドウを有効にしたり、メッセージを選択せずに Outlook アドインをアクティブ化する」を参照してください。

アドインの種類: メール

次の VersionOverrides スキーマでのみ有効です:

メール 1.1

詳細については、「アドインのみのマニフェストでのバージョンのオーバーライド」を参照してください。

次の要件セットに関連付けられています:

メールボックス 1.13

注:

Outlook on the web と新しい Outlook on Windows ではメールボックス要件セット 1.13 がサポートされていますが、閲覧ウィンドウが非表示になっているか、メッセージが最初に選択されていない場合、アドインはアクティブになりません。詳細については、「 Outlook on the web および新しい Outlook on Windows での機能サポート」を参照してください。

<Action xsi:type="ShowTaskpane">
    <SourceLocation resid="Taskpane.Url"/>
    <SupportsNoItemContext>true</SupportsNoItemContext>
</Action>

次の方法で共有

Action 要素

属性

xsi:type

子要素

xsi:type は ExecuteFunction です

FunctionName

xsi:type は ShowTaskpane です

SourceLocation

TaskpaneId

タイトル

SupportsPinning

SupportsMultiselect

SupportsNoItemContext

その他のリソース