Button-Element

Artikel
09/24/2014

Letzte Änderung: Dienstag, 15. November 2011

Gilt für: SharePoint Foundation 2010

Inhalt dieses Artikels
Attribute
Untergeordnete Elemente
Übergeordnete Elemente
Vorkommen

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

Attribute

Attribut	Beschreibung
Alt	Optional. Alternativer Text für die Schaltfläche.
Command	Optional. Der Name des auszuführenden Befehls, wenn auf das Steuerelement geklickt 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.
CommandType	Optional. Ein Enumerationswert, der den Befehlstyp angibt. General. 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, mit denen das Menü nicht geschlossen werden soll, wenn darauf geklickt wird.
CommandValueId	Optional. Eine Zeichenfolge, die mit dem Befehlsereignis gesendet wird, wenn auf die Schaltfläche geklickt wird.
Description	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 als Symbol zu verwendendes Bild mit 32 x 32 Pixeln enthält, wie beispielsweise /_layouts/1033/images/formatmap32x32.png.
Image32by32Class	Optional. Der Name einer CSS-Klasse, 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 left-CSS-Attribut für die Inlineformatvorlage eines img-HTML-Tags festgelegt. Wenn Sie beispielsweise das Image32by32Left-Attribut auf -160 und das Image32by32Top-Attribut auf -448 festlegen, ergibt sich ein ähnliches Inlineformat wie im folgenden HTML-Markup: `<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.
Image16by16	Optional. Eine serverrelative URL zu einer Datei, die ein als Symbol zu verwendendes Bild mit 16 x 16 Pixeln enthält, wie beispielsweise /_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 top-CSS-Attribut für die Inlineformatvorlage eines img-HTML-Tags festgelegt.
LabelCss	Optional. Der Name einer CSS-Klassenauswahl, die auf das Etikett des Steuerelements angewendet werden soll.
LabelText	Optional. Der Text für das Etikett des Steuerelements.
MenuItemId	Optional. Eine Zeichenfolge, die das Menüelement definiert, in dem sich die Schaltfläche befindet.
Sequence	Optional. Eine ganze Zahl, die die Reihenfolge in der Platzierung von 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 mit einem Bild mit 32 x 32 Pixeln, das in der QuickInfo verwendet wird, beispielsweise /_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 left-CSS-Attributs 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 top-CSS-Attributs 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 Schlüsselwort.
ToolTipShortcutKey	Optional. Der für die Tastenkombination in der QuickInfo anzuzeigende Text. Wenn die Tastenkombination für das Steuerelement beispielsweise ALT+J ist, besitzt das Attribut den Wert ALT+J. In der QuickInfo wird der Text für die Tastenkombination in Klammern hinter dem Titel der QuickInfo angezeigt: (ALT + J).

Untergeordnete Elemente

Keine

Übergeordnete Elemente

CommandUIDefinition

Controls (Group)

Controls (MenuSection)

Vorkommen

Minimum: 0

Maximum: Unbegrenzt

Beispiel

Im folgenden Beispiel wird gezeigt, wie Sie dem Menüband für die Serverkomponente ein Schaltflächensteuerelement hinzufügen. Im Beispiel wird dem Menüband in der gleichen Gruppe, in der sich die integrierten Steuerelemente Neues Dokument, Neuer Ordner und Dokumentupload befinden, eine Hilfeschaltfläche hinzugefügt:

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://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/en-us/library/ee539395%28office.14%29.aspx');" />
      </CommandUIHandlers>
    </CommandUIExtension>
  </CustomAction>
</Elements>

Siehe auch

Aufgaben

Exemplarische Vorgehensweise: Hinzufügen einer Schaltfläche zum Servermenüband

Freigeben über