Button 型のコントロール要素

アクションを実行する、または作業ウィンドウを起動するボタンを定義します。

注:

この記事は、要素の属性に関する重要な情報を含む基本的な コントロール リファレンス記事 に精通していることを前提としています。

ボタンは、ユーザーが選択したときに 1 つのアクションを実行します。 関数を実行するか、作業ウィンドウを表示します。 各ボタン コントロールには、マニフェスト内のすべての <Control> 要素の中で一意の id 属性値が必要です。

重要

"ボタン" タイプのコントロールは、モバイル プラットフォームでは無視されます。 モバイル プラットフォームをサポートするには、種類が "Button" のすべてのコントロールに対して種類が "MobileButton" のコントロールも必要です。

子要素

要素 必須 説明
Label はい ボタンのテキストです。
Supertip はい このボタンのヒントです。

重要: スーパーヒントは Office デスクトップ クライアントでのみサポートされています。
Icon はい ボタンの画像です。
Action はい 実行するアクションを指定します。 <Control> 要素の <Action> 子は 1 つだけ存在できます。
Enabled (有効) 不要 アドインの起動時にコントロールを有効にするかどうかを指定します。
OverriddenByRibbonApi 不要 カスタム コンテキスト タブをサポートするアプリケーションとプラットフォームの組み合わせにボタンを表示するかどうかを指定します。 使う場合は、 最初の 子要素である必要があります。

Label

唯一の属性 resid を使用してボタンのテキストを指定します。resid は 32 文字以内であり、Resources 要素の子である <ShortStrings> 要素の <String> 要素の id 属性の値に設定する必要があります。

アドインの種類: 作業ウィンドウ、メール

次の 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

次の例では、ボタンによって機能が実行されます。 また、アドインの起動時に無効になるように構成されています。 これはプログラムで有効にすることができます。 詳細については、「 アドイン コマンドの可用性を変更する」を参照してください。

<Control xsi:type="Button" id="Contoso.msgReadFunctionButton">
  <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
  <Label resid="funcReadButtonLabel" />
  <Supertip>
    <Title resid="funcReadSuperTipTitle" />
    <Description resid="funcReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="blue-icon-16" />
    <bt:Image size="32" resid="blue-icon-32" />
    <bt:Image size="80" resid="blue-icon-80" />
  </Icon>
  <Action xsi:type="ExecuteFunction">
    <FunctionName>getSubject</FunctionName>
  </Action>
  <Enabled>false</Enabled>
</Control>

次の例では、ボタンによって作業ウィンドウが表示されます。

<Control xsi:type="Button" id="Contoso.msgReadOpenPaneButton">
  <Label resid="paneReadButtonLabel" />
  <Supertip>
    <Title resid="paneReadSuperTipTitle" />
    <Description resid="paneReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="green-icon-16" />
    <bt:Image size="32" resid="green-icon-32" />
    <bt:Image size="80" resid="green-icon-80" />
  </Icon>
  <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskPaneUrl" />
  </Action>
</Control>