ControlRef-Element (Server-Menüband)

Artikel
10/16/2024

Gilt für: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Stellt einen Platzhalter für ein Steuerelement in einem GroupTemplate-Element dar.

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

Elemente und Attribute

In den folgenden Abschnitten werden Attribute, untergeordnete und übergeordnete Elemente erläutert.

Attribute

Attribut	Beschreibung
DisplayMode	Optional. Ein Enumerationswert, der bestimmt, wie ein Steuerelement gerendert wird: - Klein. Wird als kleines Symbol ohne Beschriftungstext gerendert. - Mittel. Wird als Symbol mit 16x16 Pixeln mit Beschriftungstext gerendert. - Groß. Wird als Symbol mit 32x32 Pixeln mit Beschriftungstext gerendert. - Menü. Wird als ein Nur-Text-Menüelement gerendert. - Menü16. Wird als ein Menüelement mit einem Symbol von 16x16 Pixeln gerendert. - Menü32. Wird als ein Menüelement mit einem Symbol von 32x32 Pixeln gerendert.
TemplateAlias	Optional. Eine Zeichenfolge, auf die ein Steuerelement in seinem eigenen TemplateAlias-Attribut verweisen kann. Das TemplateAlias-Attribut dient zum Bestimmen der Größe und Position von Steuerelementen in einer Gruppe, wenn eine Vorlage auf die Gruppe angewendet wird. Alle Elemente im selben GroupTemplate-Element müssen einen unterschiedlichen TemplateAlias-Wert haben.

Attribut

Beschreibung

DisplayMode

Optional. Ein Enumerationswert, der bestimmt, wie ein Steuerelement gerendert wird:

- Klein. Wird als kleines Symbol ohne Beschriftungstext gerendert.
- Mittel. Wird als Symbol mit 16x16 Pixeln mit Beschriftungstext gerendert.
- Groß. Wird als Symbol mit 32x32 Pixeln mit Beschriftungstext gerendert.
- Menü. Wird als ein Nur-Text-Menüelement gerendert.
- Menü16. Wird als ein Menüelement mit einem Symbol von 16x16 Pixeln gerendert.
- Menü32. Wird als ein Menüelement mit einem Symbol von 32x32 Pixeln gerendert.

TemplateAlias

Optional. Eine Zeichenfolge, auf die ein Steuerelement in seinem eigenen TemplateAlias-Attribut verweisen kann. Das TemplateAlias-Attribut dient zum Bestimmen der Größe und Position von Steuerelementen in einer Gruppe, wenn eine Vorlage auf die Gruppe angewendet wird. Alle Elemente im selben GroupTemplate-Element müssen einen unterschiedlichen TemplateAlias-Wert haben.

Untergeordnete Elemente

Keine

Übergeordnete Elemente

Row
Streifen

Vorkommen

Minimum: 0
Maximum: Unbegrenzt

Hinweise

Steuerelemente unterstützen nicht notwendigerweise alle Anzeigemodi. Die folgende Tabelle listet die Modi auf, die von allen Typen von Steuerelementen unterstützt werden.

Control	Small	Medium	Large	Menü	Menü16	Menü32
Button	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
Spinner		X
SplitButton	X	X	X
TextBox		X
ToggleButton	X	X	X

Beispiel

Das folgende Beispiel ist ein XML-Fragment, das die Beziehung zwischen dem TemplateAlias-Attribut für Steuerelemente in einem Group-Element und dasselbe Attribut für ControlRef-Elemente in einem GroupTemplate-Element zeigt.

Beachten Sie, dass das Group-Element drei Button-Elemente enthält, für die jeweils ein TemplateAlias-Attribut auf den Wert "row1", "row2"oder "row3"festgelegt ist.

Das GroupTemplate-Element enthält auch drei ControlRef-Elemente , deren Attribute auf den Wert "row1", "row2"oder "row3"festgelegt sind.

Bei Anwenden der Vorlage auf die Gruppe wird das Layout der Steuerelemente in der Gruppe durch Abgleichen des TemplateAlias-Attributs eines Button-Elements mit dem TemplateAlias-Attribut eines ControlRef-Elements bestimmt.

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

Freigeben über