Command 元素

表示命令定义。

使用情况

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

特性

属性	类型	必须	说明
注释	xs:string	否	用于批注命令元素。 (xs：string) 由任意字符序列组成的字符串，包括空格和换行符。 最大长度：250 个字符。
Id	xs：positiveInteger union xs：string	否	唯一的资源 ID。 (xs：positiveInteger 和 xs：string) 的并集 介于 2 和 59999 之间的整数值（含）或0x2和0xea5f十六进制（非独占）。 最大长度为 10 个字符，包括可选的前导零。
键提示	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	最多可能发生一次
Command.Id	最多可能发生一次
Command.Keytip	最多可能发生一次
Command.LabelDescription	最多可能发生一次
Command.LabelTitle	最多可能发生一次
Command.LargeHighContrastImages	最多可能发生一次
Command.LargeImages	最多可能发生一次
Command.Name	最多可能发生一次
Command.SmallHighContrastImages	最多可能发生一次
Command.SmallImages	最多可能发生一次
Command.Symbol	最多可能发生一次
Command.TooltipDescription	最多可能发生一次
Command.TooltipTitle	最多可能发生一次

父元素

元素
Application.Commands

备注

必需。

对于每个 Application.Commands 元素，可能发生一次或多次。

Command 元素的子元素可以按任意顺序出现。

通常，命令资源在功能区标记中声明，但也可以在运行时通过调用 SetUICommandProperty 来设置它们。 例如，可以设置 Command 的 UI_PKEY_Keytip 属性，而不是使用 Command.Keytip 元素在标记中声明值。

在无法使用 SetUICommandProperty 设置命令属性（如标签和图像）的情况下，可以通过调用 InvalidateUICommand 将其失效。 失效后，框架会向主机应用程序查询资源详细信息。

注意

资源在失效后无法从标记资源表恢复。

命令定义将添加到标记中声明的每个 命令 的功能区标记头文件。

键提示的值充当命令的键盘快捷键，除非该命令通过菜单项公开。 在这种情况下，框架会忽略 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
• 可以为空：否