RibbonButton-Klasse (2007 System)

Artikel
08/23/2008

Aktualisiert: November 2007

Stellt eine Schaltfläche auf einer benutzerdefinierten Multifunktionsleiste dar.

Namespace: Microsoft.Office.Tools.Ribbon
Assembly: Microsoft.Office.Tools.Common.v9.0 (in Microsoft.Office.Tools.Common.v9.0.dll)

Syntax

<ToolboxBitmapAttribute(GetType(RibbonButton), "RibbonButton.bmp")> _
Public NotInheritable Class RibbonButton _
    Inherits RibbonControl

Dim instance As RibbonButton

[ToolboxBitmapAttribute(typeof(RibbonButton), "RibbonButton.bmp")]
public sealed class RibbonButton : RibbonControl

Hinweise

Visual Studio Tools for Office erstellt eine Instanz der RibbonButton-Klasse, wenn ein Button-Steuerelement von der Registerkarte Steuerelemente für Office-Multifunktionsleisten der Toolbox zum Multifunktionsleisten-Designer gezogen wird.

Außerdem kann während der Laufzeit eine Instanz dieses Steuerelements erstellt und einem dynamischen Menü hinzugefügt werden. Ein Menü wird als dynamisch bezeichnet, wenn dessen Dynamic-Eigenschaft auf true festgelegt wird.

Einige Eigenschaften dieses Steuerelements können nur festgelegt werden, bevor die Multifunktionsleiste in die Office-Anwendung geladen wird oder bevor das Steuerelement während der Laufzeit einem dynamischen Menü hinzugefügt wird. Informationen zum Festlegen dieser Eigenschaften finden Sie unter Multifunktionsleisten-Objektmodellübersicht.

Allgemeine Aufgaben

In der folgenden Tabelle werden Member aufgeführt, die nützlich bei allgemeinen Aufgaben sind.

Aufgabe	Member
Fügen Sie eine Schaltfläche einem Menü hinzu, dessen Dynamic-Eigenschaft auf true festgelegt ist (während der Laufzeit).	Erstellen Sie eine Instanz der RibbonButton-Klasse mit dem RibbonButton-Konstruktor. Fügen Sie die Instanz der Items-Auflistung des Menüs hinzu.
Ändern der Größe der Schaltfläche.	Legen Sie ControlSize auf den gewünschten Wert fest. Legen Sie die Größe für einer große Schaltfläche auf Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge fest.
Anzeigen eines Bilds auf der Schaltfläche.	Es gibt drei Möglichkeiten zum Anzeigen eines Bilds: Verwenden Sie die Image-Eigenschaft. Diese Eigenschaft bietet die umfassendsten Steuerungsmöglichkeiten. Legen Sie OfficeImageId auf die ID eines integrierten Microsoft Office-Bilds fest, das Sie als Symbol für die Schaltfläche anzeigen möchten. Verwenden Sie die ImageName-Eigenschaft zusammen mit dem LoadImage-Ereignis. Mit dieser Eigenschaft werden einige Leistungsverbesserungen erzielt.
Deaktivieren oder Ausblenden von Schaltflächen.	Legen Sie Enabled zum Deaktivieren einer Schaltfläche auf false fest. Legen Sie Visible zum Ausblenden einer Schaltfläche auf false fest.
Ausführen von Code, wenn ein Benutzer auf die Schaltfläche klickt.	Fügen Sie dem Click-Ereignishandler Code hinzu.

Beispiele

Im folgenden Beispiel werden eine neue Schaltfläche erstellt, verschiedene Eigenschaften der Schaltfläche festgelegt und anschließend die Schaltfläche einem Menü hinzugefügt. Zum Ausführen dieses Codebeispiels müssen zuerst die folgenden Schritte ausgeführt werden:

Fügen Sie einem Visual Studio Tools for Office-Projekt ein Element von Multifunktionsleiste (Visual Designer) hinzu.
Fügen Sie der benutzerdefinierten Registerkarte eine Gruppe hinzu.
Fügen Sie der Gruppe ein Menü hinzu.
Legen Sie die Dynamic-Eigenschaft des Menüs auf true fest.
Legen Sie die ItemSize-Eigenschaft des Menüs auf RibbonControlSizeLarge fest.

Private Sub AddButtonsToMenu()
    Dim tempButton As New RibbonButton()
    tempButton.Label = "Button 1"
    tempButton.ControlSize = _
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge
    tempButton.Description = "My Ribbon Button"
    tempButton.ShowImage = True
    tempButton.ShowImage = True
    tempButton.Image = My.Resources.Image1
    tempButton.Image = My.Resources.Image2
    tempButton.KeyTip = "A1"
    menu1.Items.Add(tempButton)
End Sub

private void AddButtonsToMenu()
{
    RibbonButton tempButton = new RibbonButton();
    tempButton.Label = "Button 1";
    tempButton.ControlSize = 
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge;
    tempButton.Description = "My Ribbon Button";
    tempButton.ShowImage = true;
    tempButton.ShowImage = true;
    tempButton.Image = Properties.Resources.Image1;
    tempButton.Image = Properties.Resources.Image2;
    tempButton.KeyTip = "A1";
    menu1.Items.Add(tempButton);

}

Vererbungshierarchie

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.Office.Tools.Ribbon.RibbonComponent
        Microsoft.Office.Tools.Ribbon.RibbonControl
          Microsoft.Office.Tools.Ribbon.RibbonButton

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.