Élément ControlRef (ruban serveur)

Article
04/08/2023

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

Représente un espace réservé pour un contrôle dans un élément GroupTemplate.

<ControlRef
  DisplayMode="Small | Medium | Large | Menu | Menu16 | Menu32"
  TemplateAlias="Text"
/>

Éléments et attributs

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

Attributs

Attribut	Description
DisplayMode	Facultatif. Valeur d’énumération qui détermine le rendu d’un contrôle : - Petite. S’affiche sous la forme d’une petite icône sans texte d’étiquette. - Moyen. S’affiche sous la forme d’une icône de 16 pixels de côté avec du texte d’étiquette. - Grand. S’affiche sous la forme d’une icône de 32 pixels de côté avec du texte d’étiquette. - Menu. S’affiche sous la forme d’un élément de menu composé de texte uniquement. - Menu 16. S’affiche sous la forme d’un élément de menu avec une icône de 16 pixels de côté. - Menu32. S’affiche sous la forme d’un élément de menu avec une icône de 32 pixels de côté.
TemplateAlias	Facultatif. Chaîne qu’un contrôle peut référencer dans son propre attribut TemplateAlias. L’attribut TemplateAlias permet de dimensionner et de positionner les contrôles dans un groupe lorsqu’un modèle est appliqué au groupe. Si deux éléments se trouvent dans le même élément GroupTemplate, ils doivent avoir une valeur TemplateAlias différente.

Attribut

Description

DisplayMode

Facultatif. Valeur d’énumération qui détermine le rendu d’un contrôle :

- Petite. S’affiche sous la forme d’une petite icône sans texte d’étiquette.
- Moyen. S’affiche sous la forme d’une icône de 16 pixels de côté avec du texte d’étiquette.
- Grand. S’affiche sous la forme d’une icône de 32 pixels de côté avec du texte d’étiquette.
- Menu. S’affiche sous la forme d’un élément de menu composé de texte uniquement.
- Menu 16. S’affiche sous la forme d’un élément de menu avec une icône de 16 pixels de côté.
- Menu32. S’affiche sous la forme d’un élément de menu avec une icône de 32 pixels de côté.

TemplateAlias

Facultatif. Chaîne qu’un contrôle peut référencer dans son propre attribut TemplateAlias. L’attribut TemplateAlias permet de dimensionner et de positionner les contrôles dans un groupe lorsqu’un modèle est appliqué au groupe. Si deux éléments se trouvent dans le même élément GroupTemplate, ils doivent avoir une valeur TemplateAlias différente.

Éléments enfants

Aucun

Éléments parents

Ligne
Bande

Occurrences

Minimum : 0
Maximum : pas de limite

Remarques

Les contrôles ne prennent pas nécessairement en charge tous les modes d’affichage. Le tableau suivant répertorie les modes pris en charge par chaque type de contrôle.

Contrôle	Small	Medium	Large	Menu	Menu16	Menu32
Bouton	X	X	X	X	X	X
CheckBox	X	X
Colorpicker				X
ComboBox		X
DropDown		X
FlyoutAnchor	X	X	X	X	X	X
GalleryButton			X	X
InsertTable				X
Label	X	X
MenuSection					X	X
MRUSplitButton	X	X	X
Bouton fléché		X
Splitbutton	X	X	X
TextBox		X
Togglebutton	X	X	X

Exemple

L’exemple suivant est un fragment XML qui montre la relation entre l’attribut TemplateAlias pour les contrôles dans un élément Group et le même attribut pour les éléments ControlRef dans un élément GroupTemplate.

Notez que l’élément Group contient trois éléments Button , chacun avec un attribut TemplateAlias défini sur la valeur "row1", "row2"ou "row3".

L’élément GroupTemplate contient également trois éléments ControlRef dont les attributs ont la valeur "row1", "row2"ou "row3".

Lorsque le modèle est appliqué au groupe, la disposition des contrôles dans le groupe est déterminée par la mise en correspondance de l’attribut TemplateAlias d’un élément Button avec l’attribut TemplateAlias d’un élément ControlRef.

<Group
  Id="Ribbon.CustomTabExample.CustomGroupExample"
  Description="This is a custom group."
  Title="Custom Group"
  Sequence="52"
  Template="Ribbon.Templates.CustomTemplateExample">
  <Controls Id="Ribbon.CustomTabExample.CustomGroupExample.Controls">
    <Button
      Id="Ribbon.CustomTabExample.CustomGroupExample.HelloWorld"
      Command="CustomTabExample.HelloWorldCommand"
      Sequence="15"
      Description="Says hello to the World!"
      LabelText="Hello!"
      TemplateAlias="row1"/>
    <Button
      Id="Ribbon.CustomTabExample.CustomGroupExample.GoodbyeWorld"
      Command="CustomTabExample.GoodbyeWorldCommand"
      Sequence="17"
      Description="Says goodbye to the World!"
      LabelText="Goodbye!"
      TemplateAlias="row2"/>
    <Button
      Id="Ribbon.CustomTabExample.CustomGroupExample.LaterWorld"
      Command="CustomTabExample.LaterWorldCommand"
      Sequence="19"
      Description="Says I will see you later to the World!"
      LabelText="Later!"
      TemplateAlias="row3"/>
  </Controls>
</Group>
<GroupTemplate Id="Ribbon.Templates.CustomTemplateExample">
  <Layout
    Title="OneLargeTwoMedium"
    LayoutTitle="OneLargeTwoMedium">
    <Section Alignment="Top" Type="OneRow">
      <Row>
        <ControlRef DisplayMode="Large" TemplateAlias="row1" />
      </Row>
    </Section>
    <Section Alignment="Top" Type="TwoRow">
      <Row>
        <ControlRef DisplayMode="Medium" TemplateAlias="row2" />
      </Row>
      <Row>
        <ControlRef DisplayMode="Medium" TemplateAlias="row3" />
      </Row>
    </Section>
  </Layout>
</GroupTemplate>

Partager via