Élément CheckBox (ruban serveur)

Article
04/08/2023

S’applique à : | SharePoint 2016 SharePoint Foundation 2013 | | SharePoint Online SharePoint Server 2013

Définit un contrôle de case à cocher.

<CheckBox
     Alt="Text"
     Command="Text"
     Id="Text"
     LabelText="Text"
     MenuItemId="Text"
     QueryCommand="Text"
     Sequence="Integer"
     TemplateAlias="Text"
     ToolTipImage32by32="Url"
     ToolTipImage32by32Class="CSS Class Selector"
     ToolTipImage32by32Left="Negative Integer"
     ToolTipImage32by32Top="Negative Integer"
     ToolTipTitle="Text"
     ToolTipDescription="Text"
     ToolTipHelpKeyWord="Text"
     ToolTipShortcutKey="Text"
/>

Éléments et attributs

Les sections suivantes décrivent les attributs, les éléments enfants et les éléments parents.

Attributs

Attribut	Description
Alt	Facultatif. Texte de remplacement utilisé pour la case à cocher.
Commande	Facultatif. Nom de la commande à exécuter lorsque le contrôle est sélectionné. Si le contrôle se trouve dans un élément CommandUIDefinition, la valeur de l’attribut Command du contrôle doit être identique à la valeur de l’attribut Command d’un élément CommandUIHandler correspondant.
Id	Obligatoire. Identifie le contrôle. La valeur peut être une représentation de chaîne d’un GUID ou un terme unique, comme « Ribbon.Library.Share.NewRibbonCheckBox ».
LabelText	Facultatif. Texte de l’étiquette du contrôle.
MenuItemId	Facultatif. Chaîne qui identifie l’élément de menu où se trouve le bouton.
QueryCommand	Facultatif. Nom de la commande à exécuter lors de l’interrogation des informations d’état.
Sequence	Facultatif. Entier qui spécifie l’ordre d’emplacement dans les nœuds XML frères.
TemplateAlias	Facultatif. Chaîne qui correspond à la valeur de l’attribut TemplateAlias pour un élément ControlRef, un élément OverflowArea ou un élément OverflowSection dans un élément GroupTemplate. L’attribut TemplateAlias permet de dimensionner et de positionner les contrôles dans un groupe lorsqu’un modèle est appliqué au groupe.
Info-bulleImage32by32	Facultatif. URL relative du serveur vers un fichier qui contient une image de 32 pixels de 32 pixels à utiliser dans l’info-bulle, telle que « /_layouts/1033/images/formatmap32x32.png ».
Info-bulleImage32by32Class	Facultatif. Nom d’un sélecteur de classe CSS à appliquer à l’image de l’info-bulle.
Info-bulleImage32by32Left	Facultatif. Entier négatif qui représente un décalage pour le bord gauche de l’image. Utilisez cet attribut lorsque l’attribut ToolTipImage32by32 pointe vers un fichier image qui contient des images de nombreuses icônes. La valeur de l’attribut ToolTipImage32by32Left permet de définir l’attribut CSS left pour le style intraligne d’une balise HTML img.
Info-bulleImage32by32Top	Facultatif. Entier négatif qui représente un décalage pour le bord supérieur de l’image. Utilisez cet attribut lorsque l’attribut ToolTipImage32by32 pointe vers un fichier image qui contient les images de nombreuses icônes. La valeur de l’attribut ToolTipImage32by32Top permet de définir l’attribut CSS top pour le style intraligne d’une balise HTML img.
ToolTipTitle	Facultatif. Texte qui apparaît comme titre de l’info-bulle.
Info-bulleDescription	Facultatif. Texte qui apparaît dans le corps de l’info-bulle.
ToolTipHelpKeyWord	Facultatif. Mot clé utilisé par l’aide contextuelle.
ToolTipShortcutKey	Facultatif. Texte à afficher pour la touche de raccourci dans l’info-bulle. Par exemple, si la touche de raccourci du contrôle est Alt+J, la valeur de cet attribut est « Alt+J ». L’info-bulle affiche le texte de la touche de raccourci entre parenthèses après le titre de l’info-bulle : « (Alt+J) ».

Éléments enfants

Aucun

Éléments parents

CommandUIDefinition
Controls (Group)

Occurrences

Minimum : 0
Maximum : pas de limite

Exemple

L’exemple suivant est un fragment XML qui définit un groupe de contrôles comprenant un élément CheckBox.

<Group
  Id="Ribbon.Image.Image.Size"
  Sequence="50"
  Command="ImageSizeGroup"
  Description=""
  Title="$Resources:core,GrpSize;"
  Image32by32Popup="/_layouts/$Resources:core,Language;/images/formatmap32x32.png" Image32by32PopupTop="-128" Image32by32PopupLeft="0"
  Template="Ribbon.Templates.Flexible2"
>
  <Controls Id="Ribbon.Image.Image.Size.Controls">
    <Label
      Id="Ribbon.Image.Image.Size.HorizontalSizeLabel"
      LabelText="$Resources:core,LabelHorizSize;"
      Command="ImageHorizontalLabel"
      ForId="Ribbon.Image.Image.Size.HorizontalSize"
      Image16by16="/_layouts/$Resources:core,Language;/images/formatmap16x16.png" Image16by16Top="-80" Image16by16Left="-16"
      TemplateAlias="o1"
      Sequence="10"
    />
    <Spinner
       Id="Ribbon.Image.Image.Size.HorizontalSize"
       DefaultUnit="pixel"
       DefaultValue="10"
       AltUpArrow="$Resources:core,cui_spnUpAlt;"
       AltDownArrow="$Resources:core,cui_spnDownAlt;"
       AccelerationInterval="125"
       MultiplierInterval="2000"
       ImeEnabled="false"
       Command="ImageWidth"
       QueryCommand="QueryImageWidth"
       ToolTipTitle="$Resources:core,LabelHorizSize;"
       ToolTipDescription="$Resources:core,cui_stt_ButSizeMenuHorizontalSizeTooltip;"
       TemplateAlias="o2"
      Sequence="20"
    >
      <Unit
          Name="pixel"
          MinimumValue="1"
          MaximumValue="2000"
          DecimalDigits="0"
          Interval="5"
        >
        <UnitAbbreviation Value="px" />
      </Unit>
      <Unit
          Name="percent"
          MinimumValue="1"
          MaximumValue="100"
          DecimalDigits="0"
          Interval="1"
        >
        <UnitAbbreviation Value="%" />
      </Unit>
    </Spinner>
    <Label
      Id="Ribbon.Image.Image.Size.VertSizeLabel"
      LabelText="$Resources:core,LabelVertSize;"
      Command="ImageVerticalLabel"
      ForId="Ribbon.Image.Image.Size.VerticalSize"
      Image16by16="/_layouts/$Resources:core,Language;/images/formatmap16x16.png" Image16by16Top="-208" Image16by16Left="-224"
      TemplateAlias="o1"
      Sequence="30"
    />
    <Spinner
      Id="Ribbon.Image.Image.Size.VerticalSize"
      DefaultUnit="pixel"
      DefaultValue="10"
      AltUpArrow="$Resources:core,cui_spnUpAlt;"
      AltDownArrow="$Resources:core,cui_spnDownAlt;"
      AccelerationInterval="125"
      MultiplierInterval="2000"
      Command="ImageHeight"
      ImeEnabled="false"
      QueryCommand="QueryImageHeight"
      ToolTipTitle="$Resources:core,LabelVertSize;"
      ToolTipDescription="$Resources:core,cui_stt_ButSizeMenuVerticalSizeTooltip;"
      TemplateAlias="o2"
      Sequence="40"
    >
      <Unit
          Name="pixel"
          MinimumValue="1"
          MaximumValue="2000"
          DecimalDigits="0"
          Interval="5"
        >
        <UnitAbbreviation Value="px" />
      </Unit>
      <Unit
          Name="percent"
          MinimumValue="1"
          MaximumValue="100"
          DecimalDigits="0"
          Interval="1"
        >
        <UnitAbbreviation Value="%" />
      </Unit>
    </Spinner>
    <CheckBox
      Id="Ribbon.Image.Image.Size.LockAspect"
      Command="ImageLockRatio"
      QueryCommand="QueryImageLockRatio"
      LabelText="$Resources:core,LabelLockAspect;"
      Alt="$Resources:core,ButLockAspectAlt;"
      TemplateAlias="o2"
      Sequence="50"
    />
  </Controls>
</Group>

Partager via