Command 要素

[アーティクル]
06/13/2023

コマンド定義を表します。

使用法

<Command
  Name = "xs:string"
  Symbol = "xs:string"
  Id = "xs:positiveInteger union xs:string"
  Comment = "xs:string"
  LabelTitle = "xs:string"
  LabelDescription = "xs:string"
  TooltipTitle = "xs:string"
  TooltipDescription = "xs:string"
  Keytip = "xs:string">
  child elements
</Command>

属性

属性	Type	必須	説明
解説	xs:string	いいえ	コマンド要素に注釈を付けるために使用します。 (xs:string) 空白文字や改行文字など、任意の文字シーケンスで構成される文字列。最大長: 250 文字。
Id	xs:positiveInteger union xs:string	いいえ	一意のリソース ID。 (xs:positiveInteger と xs:string の和集合) 2 ~ 59999 の整数値 (16 進数を含む) または 0x2と0xea5f。最大長は 10 文字で、省略可能な先行ゼロを含みます。
Keytip	xs:string	いいえ	コマンド要素のキーボードショートカットを表す文字列。 (xs:string) 空白を含む任意の文字シーケンスで構成される文字列。
LabelDescription	xs:string	いいえ	コマンド要素に表示されるテキストを表す文字列。 (xs:string) 空白文字や改行文字など、任意の文字シーケンスで構成される文字列。
LabelTitle	xs:string	いいえ	コマンド要素に表示されるテキストを表す文字列。 (xs:string) 空白文字や改行文字など、任意の文字シーケンスで構成される文字列。
名前	xs:string	いいえ	(xs:string) 文字またはアンダースコアの後に数字、文字、またはアンダースコアのシーケンスが続く文字列。最大長: 100 文字。
記号	xs:string	いいえ	(xs:string) 文字またはアンダースコアの後に数字、文字、またはアンダースコアのシーケンスが続く文字列。最大長: 100 文字。
TooltipDescription	xs:string	いいえ	コマンド要素に表示されるテキストを表す文字列。 (xs:string) 空白文字や改行文字など、任意の文字シーケンスで構成される文字列。
TooltipTitle	xs:string	いいえ	コマンド要素に表示されるテキストを表す文字列。 (xs:string) 空白文字や改行文字など、任意の文字シーケンスで構成される文字列。

子要素

要素	説明
Command.Comment	最大で 1 回発生する可能性があります
Command.Id	最大で 1 回発生する可能性があります
Command.Keytip	最大で 1 回発生する可能性があります
Command.LabelDescription	最大で 1 回発生する可能性があります
Command.LabelTitle	最大で 1 回発生する可能性があります
Command.LargeHighContrastImages	最大で 1 回発生する可能性があります
Command.LargeImages	最大で 1 回発生する可能性があります
Command.Name	最大で 1 回発生する可能性があります
Command.SmallHighContrastImages	最大で 1 回発生する可能性があります
Command.SmallImages	最大で 1 回発生する可能性があります
Command.Symbol	最大で 1 回発生する可能性があります
Command.TooltipDescription	最大で 1 回発生する可能性があります
Command.TooltipTitle	最大で 1 回発生する可能性があります

親要素

要素
Application.Commands

解説

必須。

Application.Commands 要素ごとに 1 回以上発生する可能性があります。

Command 要素の子要素は、任意の順序で発生する可能性があります。

通常、コマンドリソースはリボンマークアップで宣言されますが、 実行時に SetUICommandProperty を呼び出して設定することもできます。たとえば、Command.Keytip 要素を使用してマークアップの値を宣言する代わりに、Command のUI_PKEY_Keytip プロパティを設定できます。

ラベルやイメージなどの Command プロパティを SetUICommandProperty で設定できない場合は、 InvalidateUICommand の呼び出しで無効にすることができます。無効化後、フレームワークはホストアプリケーションに対してリソースの詳細を照会します。

Note

マークアップリソーステーブルが無効になった後、リソースを復元することはできません。

コマンド定義は、マークアップで宣言された各 コマンド のリボンマークアップヘッダーファイルに追加されます。

Keytip の値は、そのコマンドがメニュー項目を介して公開されない限り、Command のキーボードアクセラレータとして機能します。この場合、フレームワークは Keytip 値を無視し、 代わりに LabelTitle または UI_PKEY_Label で指定されたアンパサンドの前に文字を使用します。 LabelTitle または UI_PKEY_Label でアンパサンドが指定されていない場合、キーヒントまたはキーボードアクセラレータは公開されません。

例

次の例は、[ホーム] タブの Command 要素のマニフェストを示しています。

<Application.Commands>

<Command Name="cmdHomeTab"
         LabelTitle="Home"
         Keytip="H" />
<Command Name="cmdClipboardGroup"
         Symbol="IDR_CMD_CLIPBOARD"
         Id="10000"
         Comment="Command definition for clipboard group"
         LabelTitle="Clipboard"
         Keytip="CB" />
<Command Name="cmdCopy"
         Symbol="IDR_CMD_COPY"
         LabelTitle="Copy"
         LabelDescription="Copy"
         Keytip="C"
         TooltipTitle="Copy"
         TooltipDescription="Click to copy">
  <Command.SmallImages>
    <Image>res/copyS_16.bmp</Image>
  </Command.SmallImages>
  <Command.LargeImages>
    <Image>res/copyL_32.bmp</Image>
  </Command.LargeImages>
</Command>
<Command Name="cmdPaste"
         Symbol="IDR_CMD_PASTE" >
  <Command.LabelTitle>Paste</Command.LabelTitle>
  <Command.LabelDescription>
    <String Content="Paste contents of clipboard"
            Id="10001"
            Symbol="IDR_RES_LABELDESC_PASTE" />
  </Command.LabelDescription>
  <Command.Keytip>P</Command.Keytip>
  <Command.TooltipTitle>
    <String Content="Paste contents of clipboard"
            Id="10002"
            Symbol="IDR_RES_TOOLTIP_PASTE"/>
  </Command.TooltipTitle>
  <Command.TooltipDescription>
    <String Content="Click to paste contents of clipboard"/>
  </Command.TooltipDescription>
  <Command.SmallImages>
    <Image
      Id="10010"
      MinDPI="96"
      Symbol="IDR_RES_SMALL_IMAGE96">
      <Image.Source>res/pasteS_96bpp.bmp</Image.Source>
    </Image>
    <Image Source="res/pasteS_120bpp.bmp"
           Id="10011"
           MinDPI="120"
           Symbol="IDR_RES_SMALL_IMAGE120" />
  </Command.SmallImages>
  <Command.LargeImages>
    <Image>res/pasteL_32.bmp</Image>
  </Command.LargeImages>
</Command>
<Command Name="cmdMinimize"
         Symbol="IDR_CMD_MINIMIZE"
         Id="10001"
         LabelTitle="Minimize" />

</Application.Commands>

要素情報

サポートされている最小システム: Windows 7
空にできます: いいえ

Command 要素

使用法

属性

子要素

親要素

解説

例

要素情報

フィードバック

フィードバック

その他のリソース