Button 型の Control 要素

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

注:

この記事では、要素の属性に関する重要な情報を含む基本的な Control リファレンス記事 について理解していることを前提としています。

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

重要

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

子要素

要素	必須	説明
Label	はい	ボタンのテキストです。
<ツールヒント>	不要	ボタンのヒントです。 resid 属性は 32 文字以内で、String> 要素の id 属性の値に<設定する必要があります。 <String> 要素は、Resources 要素の<子である LongStrings> 要素の子です。
Supertip	はい	このボタンのヒントです。 重要: スーパーヒントは、Office デスクトップ クライアントでのみサポートされます。
Icon	はい	ボタンの画像です。
Action	はい	実行するアクションを指定します。 Control> 要素の<Action> 子は 1 つだけ<です。
Enabled (有効)	不要	アドインの起動時にコントロールを有効にするかどうかを指定します。
OverriddenByRibbonApi	不要	カスタム コンテキスト タブをサポートするアプリケーションとプラットフォームの組み合わせにボタンを表示するかどうかを指定します。 を使用する場合は、 最初 の子要素である必要があります。

Label

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

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

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

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

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

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

• 親 <VersionOverrides が Taskpane 1.0 型の場合、AddinCommands> 1.1。
• 親 <VersionOverrides が「Mail 1.0」と入力されている場合の>メールボックス 1.3。
• 親 <VersionOverrides が「Mail 1.1」と入力されている場合の>メールボックス 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>