CheckBox-Element (Server-Menüband)

Artikel
04/08/2023

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

Definiert ein Kontrollkästchen-Steuerelement.

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

Elemente und Attribute

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

Attribute

Attribut	Beschreibung
Alt	Optional. Alternativer Text für das Kontrollkästchen.
Befehl	Optional. Der Name des Befehls, der ausgeführt werden soll, wenn das Steuerelement ausgewählt wird. Falls sich das Steuerelement in einem CommandUIDefinition-Element befindet, sollte der Wert des Command-Attributs des Steuerelements mit dem Wert des Command-Attributs eines entsprechenden CommandUIHandler-Elements übereinstimmen.
Id	Erforderlich. Identifiziert das Steuerelement. Der Wert kann eine Zeichenfolgendarstellung einer GUID oder eines eindeutigen Begriffs wie "Ribbon.Library.Share.NewRibbonCheckBox" sein.
LabelText	Optional. Der Beschriftungstext für das Steuerelement.
MenuItemId	Optional. Eine Zeichenfolge, die das Menüelement definiert, in dem sich die Schaltfläche befindet.
QueryCommand	Optional. Der Name des auszuführenden Befehls, wenn Statusinformationen abgerufen werden.
Sequence	Optional. Eine ganze Zahl, die die Reihenfolge der Platzierung unter gleichgeordneten XML-Knoten angibt.
Templatealias	Optional. Eine Zeichenfolge, die mit dem Wert des TemplateAlias-Attributs für ein ControlRef-Element, ein OverflowArea-Element oder ein OverflowSection-Element in einem GroupTemplate-Element übereinstimmt. Das TemplateAlias-Attribut wird für die Größenänderung und Positionierung von Steuerelementen innerhalb einer Gruppe verwendet, wenn eine Vorlage auf die Gruppe angewendet wird.
ToolTipImage32by32	Optional. Eine serverrelative URL zu einer Datei, die ein 32 x 32 Pixel großes Bild enthält, das in der QuickInfo verwendet werden soll, z. B. "/_layouts/1033/images/formatmap32x32.png".
ToolTipImage32by32Class	Optional. Der Name einer CSS-Klassenauswahl, die auf das QuickInfo-Bild angewendet werden soll.
ToolTipImage32by32Left	Optional. Eine negative ganze Zahl, die einen Abstand für die linke Kante des Bilds angibt. Verwenden Sie dieses Attribut, wenn das ToolTipImage32by32-Attribut auf eine Bilddatei zeigt, die Bilder für viele Symbole enthält. Mit dem Wert des ToolTipImage32by32Left-Attributs wird das CSS-Attribut left für die Inlineformatvorlage eines HTML-Tags img festgelegt.
ToolTipImage32by32Top	Optional. Eine negative ganze Zahl, die einen Abstand für die obere Kante des Bilds angibt. Verwenden Sie dieses Attribut, wenn das ToolTipImage32by32-Attribut auf eine Bilddatei verweist, die die Bilder für viele Symbole enthält. Mit dem Wert des ToolTipImage32by32Top-Attributs wird das CSS-Attribut top für die Inlineformatvorlage eines HTML-Tags img festgelegt.
ToolTipTitle	Optional. Der als Titel der QuickInfo angezeigte Text.
QuickInfoDescription	Optional. Der im Textkörper der QuickInfo angezeigte Text.
ToolTipHelpKeyWord	Optional. Das von der kontextabhängigen Hilfe verwendete Stichwort.
ToolTipShortcutKey	Optional. Der für die Tastenkombination in der QuickInfo anzuzeigende Text. Wenn die Tastenkombination für das Steuerelement z. B. ALT+J ist, lautet der Wert für dieses Attribut "ALT+J". Die QuickInfo zeigt den Text für die Tastenkombination in Klammern nach dem QuickInfo-Titel an: "(Alt+J)".

Untergeordnete Elemente

Keine

Übergeordnete Elemente

CommandUIDefinition
Controls (Group)

Vorkommen

Minimum: 0
Maximum: Unbegrenzt

Beispiel

Im folgenden XML-Fragment wird eine Gruppe von Steuerelementen definiert, die ein CheckBox-Element enthält.

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

Freigeben über