Freigeben über

Button-Element (Menüband des Servers)

  • Artikel

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

Definiert ein Schaltflächensteuerelement.

<Button
     Alt="Text"
     Command="Text"
     CommandType="General | OptionSelect | IgnoredByMenu"
     CommandValueId="Text"
     Description="Text"
     Id="Text"
     Image32by32="Url"
     Image32by32Class="CSS Class Selector"
     Image32by32Left="Negative Integer"
     Image32by32Top="Negative Integer"
     Image16by16="Url"
     Image16by16Class="CSS Class Selector"
     Image16by16Left="Negative Integer"
     Image16by16Top="Negative Integer"
     LabelCss="Text"
     LabelText="Text"
     MenuItemId="Text"
     Sequence="Integer"
     TemplateAlias="Text"
     ToolTipImage32by32="Url"
     ToolTipImage32by32Class="Text"
     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 die Schaltfläche.
Befehl
Optional. Der Name des Befehls, der ausgeführt werden soll, wenn das Steuerelement ausgewählt ist. 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.
CommandType
Optional. Ein Enumerationswert, der den Befehlstyp angibt.

Allgemein. Kein bestimmter Befehlstyp.

OptionSelection. Ein Befehl, der generiert wird, wenn ein Benutzer eine Option in einer Optionsgruppe auswählt.

IgnoredByMenu. Ein Befehl, der für Steuerelemente verwendet wird, die das Menü bei Auswahl nicht schließen sollten.
CommandValueId
Optional. Eine Zeichenfolge, die mit dem Befehlsereignis gesendet wird, wenn die Schaltfläche ausgewählt ist.
Beschreibung
Optional. Eine Zeichenfolge, die die Schaltfläche beschreibt. Die Beschreibung wird nur angezeigt, wenn sich die Schaltfläche in einem Menü befindet und mit dem Menu32-Anzeigemodus gerendert wird.
ID
Erforderlich. Eine Zeichenfolge, die das Steuerelement identifiziert, beispielsweise Ribbon.Library.Share.NewRibbonButton.
Image32by32
Optional. Eine serverrelative URL zu einer Datei, die ein Bild mit 32 x 32 Pixeln enthält, das als Symbol verwendet werden soll, z. B. "/_layouts/1033/images/formatmap32x32.png".
Image32by32Class
Optional. Der Name einer CSS-Klassenauswahl, die auf das Bild angewendet werden soll.
Image32by32Left
Optional. Eine negative ganze Zahl, die den Offset für die linke Seite des Bilds darstellt. Verwenden Sie dieses Attribut, wenn das Image32by32-Attribut auf eine Bilddatei zeigt, die Bilder für viele Symbole enthält.

Mit dem Wert des Image32by32Left-Attributs wird das CSS-Attribut left für die Inlineformatvorlage eines HTML-Tags img festgelegt. Wenn Sie beispielsweise das Image32by32Left-Attribut auf "-160" und das Image32by32Top-Attribut auf "-448" festlegen, ergibt sich eine Inlineformatvorlage, die der im folgenden HTML-Markup ähnlich ist:
HTML<img src="/_layouts/1033/images/formatmap32x32.png" style="position: absolute;left: -160px;top: -448px;" />
Image32by32Top
Optional. Eine negative ganze Zahl, die den Offset für die obere Seite des Bilds darstellt. Verwenden Sie dieses Attribut, wenn das Image32by32-Attribut auf eine Bilddatei zeigt, die Bilder für viele Symbole enthält. Mit dem Wert des Image32by32Top-Attributs wird das top-CSS-Attribut für die Inlineformatvorlage eines img-HTML-Tags festgelegt.
Bild 16by16
Optional. Eine serverrelative URL zu einer Datei, die ein Bild mit 16 x 16 Pixeln enthält, das als Symbol verwendet werden soll, z. B. "/_layouts/1033/images/formatmap16x16.png".
Image16by16Class
Optional. Der Name einer CSS-Klassenauswahl, die auf das Bild angewendet werden soll.
Image16by16Left
Optional. Eine negative ganz Zahl, die den Offset für die linke Seite des Bilds darstellt. Verwenden Sie dieses Attribut, wenn das Image16by16-Attribut auf eine Bilddatei zeigt, die Bilder für viele Symbole enthält. Mit dem Wert des Image16by16Left-Attributs wird das left-CSS-Attribut für die Inlineformatvorlage eines img-HTML-Tags festgelegt.
Image16by16Top
Optional. Eine negative ganze Zahl, die den Offset für die obere Seite des Bilds darstellt. Verwenden Sie dieses Attribut, wenn das Image16by16-Attribut auf eine Bilddatei zeigt, die Bilder für viele Symbole enthält. Mit dem Wert des Image16by16Top-Attributs wird das CSS-Attribut top für die Inlineformatvorlage eines HTML-Tags img festgelegt.
LabelCs
Optional. Der Name einer CSS-Klassenauswahl, die auf das Etikett des Steuerelements angewendet werden soll.
LabelText
Optional. Der Beschriftungstext für das Steuerelement.
MenuItemId
Optional. Eine Zeichenfolge, die das Menüelement definiert, in dem sich die Schaltfläche befindet.
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 Bild mit 32 x 32 Pixeln 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 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 die Bilder für viele Symbole enthält. Der Wert des ToolTipImage32by32Left-Attributs wird zum Festlegen des CSS-Attributs left verwendet, wenn die Seite erstellt wird.
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 zeigt, die die Bilder für viele Symbole enthält. Der Wert des ToolTipImage32by32Top-Attributs wird zum Festlegen des CSS-Attributs top verwendet, wenn die Seite erstellt wird.
ToolTipTitle
Optional. Der als Titel der QuickInfo angezeigte Text.
ToolTipDescription
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 beispielsweise ALT+J lautet, lautet der Wert für dieses Attribut "ALT+J". Die QuickInfo zeigt den Text für die Tastenkombination in Klammern hinter dem QuickInfo-Titel an: "(ALT+J)".

Untergeordnete Elemente

Keines

Übergeordnete Elemente

Vorkommen

  • Minimum: 0
  • Maximum: Unbegrenzt

Beispiel

Das folgende Beispiel zeigt, wie Sie dem Menüband des Servers ein Schaltflächensteuerelement hinzufügen. Im Beispiel wird dem Menüband in derselben Gruppe wie die integrierten Steuerelemente "Neues Dokument", "Neuer Ordner" und "Dokument hochladen" eine Hilfeschaltfläche hinzugefügt:

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <CustomAction
    Id="NewUIRibbonControl"
    RegistrationType="List"
    RegistrationId="101"
    Location="CommandUI.Ribbon">
    <CommandUIExtension>
      <CommandUIDefinitions>
        <CommandUIDefinition
           Location="Ribbon.Documents.New.Controls._children">
          <Button
             Id="NewUIRibbonControl.ShowHelp"
             Alt="Help"
             Sequence="1981"
             Command="ShowHelp"
             Image32by32="/_layouts/images/newui/dochelp.png"
             LabelText="Help"
             TemplateAlias="o1"/>
        </CommandUIDefinition>
      </CommandUIDefinitions>
      <CommandUIHandlers>
        <CommandUIHandler
         Command="ShowHelp"
         CommandAction="javascript:window.open('https://msdn.microsoft.com/library/ee539395%28office.14%29.aspx');" />
      </CommandUIHandlers>
    </CommandUIExtension>
  </CustomAction>
</Elements>

Siehe auch