élément Command

Représente une définition de commande.

Utilisation

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

Attributs

Attribut	Type	Obligatoire	Description
Commentaire	xs:string	Non	Utilisé pour annoter l’élément de commande. (xs:string) Chaîne composée de n’importe quelle séquence de caractères, y compris les espaces blancs et les caractères de saut de ligne. Longueur maximale : 250 caractères.
Id	xs:positiveInteger union xs:string	Non	ID de ressource unique. (Union de xs:positiveInteger et xs:string) Valeur entière comprise entre 2 et 59999, inclusive ou 0x2 et 0xea5f en hexadécimal, inclusive. La longueur maximale est de 10 caractères, y compris les zéros de début facultatifs.
Info-bulle	xs:string	Non	Chaîne qui représente le raccourci clavier d’un élément de commande. (xs:string) Chaîne composée de n’importe quelle séquence de caractères, y compris les espaces blancs.
LabelDescription	xs:string	Non	Chaîne qui représente le texte affiché sur un élément de commande. (xs:string) Chaîne composée de n’importe quelle séquence de caractères, y compris les espaces blancs et les caractères de saut de ligne.
LabelTitle	xs:string	Non	Chaîne qui représente le texte affiché sur un élément de commande. (xs:string) Chaîne composée de n’importe quelle séquence de caractères, y compris les espaces blancs et les caractères de saut de ligne.
Nom	xs:string	Non	(xs:string) Chaîne qui se compose d’une lettre ou d’un trait de soulignement suivi d’une séquence de chiffres, de lettres ou de traits de soulignement. Longueur maximale : 100 caractères.
Symbole	xs:string	Non	(xs:string) Chaîne qui se compose d’une lettre ou d’un trait de soulignement suivi d’une séquence de chiffres, de lettres ou de traits de soulignement. Longueur maximale : 100 caractères.
TooltipDescription	xs:string	Non	Chaîne qui représente le texte affiché sur un élément de commande. (xs:string) Chaîne composée de n’importe quelle séquence de caractères, y compris les espaces blancs et les caractères de saut de ligne.
Info-bulleTitle	xs:string	Non	Chaîne qui représente le texte affiché sur un élément de commande. (xs:string) Chaîne composée de n’importe quelle séquence de caractères, y compris les espaces blancs et les caractères de saut de ligne.

Éléments enfants

Élément	Description
Command.Comment	Peut se produire au plus une fois
Command.Id	Peut se produire au plus une fois
Command.Keytip	Peut se produire au plus une fois
Command.LabelDescription	Peut se produire au plus une fois
Command.LabelTitle	Peut se produire au plus une fois
Command.LargeHighContrastImages	Peut se produire au plus une fois
Command.LargeImages	Peut se produire au plus une fois
Command.Name	Peut se produire au plus une fois
Command.SmallHighContrastImages	Peut se produire au plus une fois
Command.SmallImages	Peut se produire au plus une fois
Command.Symbol	Peut se produire au plus une fois
Command.TooltipDescription	Peut se produire au plus une fois
Command.TooltipTitle	Peut se produire au plus une fois

Éléments parents

Élément
Application.Commands

Notes

Obligatoire.

Peut se produire une ou plusieurs fois pour chaque élément Application.Commands .

Les éléments enfants de l’élément Command peuvent se produire dans n’importe quel ordre.

En règle générale, les ressources de commande sont déclarées dans le balisage du ruban, mais elles peuvent également être définies au moment de l’exécution avec un appel à SetUICommandProperty. Par exemple, il est possible de définir la propriété UI_PKEY_Keytip pour une commande au lieu de déclarer une valeur dans le balisage avec l’élément Command.Keytip .

Dans les cas où les propriétés command, telles que les étiquettes et les images, ne peuvent pas être définies avec SetUICommandProperty , elles peuvent être invalidées avec un appel à InvalidateUICommand. Après l’invalidation, l’infrastructure interroge l’application hôte pour obtenir les détails de la ressource.

Notes

Une ressource ne peut pas être rétablie à partir de la table de ressource de balisage une fois qu’elle a été invalidée.

Une définition de commande est ajoutée au fichier d’en-tête de balisage du ruban pour chaque commande déclarée dans le balisage.

La valeur de l’info-bulle fait office d’accélérateur de clavier pour une commande, sauf si cette commande est exposée via un élément de menu. Dans ce cas, l’infrastructure ignore la valeur keytip et utilise à la place un caractère précédé d’un esperluette comme spécifié par LabelTitle ou UI_PKEY_Label. Si aucune esperluette n’est spécifiée par LabelTitle ou UI_PKEY_Label, aucune info-bulle ou accélérateur de clavier n’est exposée.

Exemples

L’exemple suivant montre un manifeste d’éléments Command pour un onglet Accueil .

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

Informations sur les éléments

• Système minimum pris en charge : Windows 7
• Peut être vide : Non