RibbonButton-Schnittstelle

Artikel
05/07/2013

Stellt eine Schaltfläche auf einem benutzerdefinierten Menüband dar.

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

Syntax

'Declaration
<GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")> _
Public Interface RibbonButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

Der RibbonButton-Typ macht die folgenden Member verfügbar.

Eigenschaften

	Name	Beschreibung
	ControlSize	Ruft die Größe der Schaltfläche ab oder legt sie fest.
	Description	Ruft den Text ab bzw. legt den Text fest, der auf dieser Schaltfläche in einem Menü angezeigt wird, wenn die ItemSize-Eigenschaft des Menüs auf Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge festgelegt wurde.
	Enabled	Ruft einen Wert ab, der angibt, ob RibbonControl aktiviert ist, oder legt diesen fest. (Von RibbonControl geerbt.)
	Id	Ruft eine Zeichenfolge ab, die von Microsoft Office zum Identifizieren dieses RibbonControl-Objekts verwendet wird. (Von RibbonControl geerbt.)
	Image	Ruft das auf der Schaltfläche angezeigte Bild ab oder legt dieses fest.
	ImageName	Ruft den Namen ab oder legt den Namen fest, mit dem die Schaltfläche im LoadImage-Ereignishandler identifiziert wird.
	KeyTip	Ruft die Tastenkombination der Schaltfläche ab oder legt sie fest.
	Label	Ruft den auf der Schaltfläche angezeigten Text ab oder legt diesen fest.
	Name	Ruft den Namen dieser RibbonComponent ab oder legt diesen fest. (Von RibbonComponent geerbt.)
	OfficeImageId	Ruft das Bild ab bzw. legt das Bild fest, das auf der Schaltfläche angezeigt werden soll, wenn Sie ein integriertes Microsoft Office-Symbol verwenden möchten.
	Parent	Ruft eine RibbonComponent ab, die die übergeordnete Komponente von RibbonComponent darstellt. (Von RibbonComponent geerbt.)
	Position	Ruft die Position der Schaltfläche ab oder legt sie fest, falls sich die Schaltfläche im Microsoft Office-Menü befindet.
	Ribbon	Ruft das Ribbon-Objekt auf der obersten Ebene ab, das die Steuerelementhierarchie beinhaltet. (Von RibbonComponent geerbt.)
	RibbonUI	Infrastruktur. Ruft die IRibbonUI-Instanz ab, die von der Microsoft Office-Anwendung für den Erweiterbarkeitscode des Menübands bereitgestellt wird. (Von RibbonComponent geerbt.)
	ScreenTip	Ruft QuickInfo-Text ab, der angezeigt wird, wenn der Benutzer den Zeiger auf die Schaltfläche richtet, oder legt diesen fest.
	ShowImage	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob das der Schaltfläche zugeordnete Bild sichtbar ist.
	ShowLabel	Ruft einen Wert ab bzw. legt einen Wert fest, der angibt, ob die Bezeichnung für die Schaltfläche sichtbar ist.
	Site	Ruft den dem IComponent zugeordneten ISite ab oder legt diesen fest. (Von IComponent geerbt.)
	SuperTip	Ruft mehrzeiligen Tipptext ab, der angezeigt wird, wenn der Benutzer den Zeiger auf die Schaltfläche richtet, oder legt diesen fest.
	Tag	Ruft anwendungsspezifische Daten ab, die RibbonComponent zugeordnet sind, oder legt diese fest. (Von RibbonComponent geerbt.)
	Visible	Ruft einen Wert ab, der angibt, ob RibbonControl sichtbar ist, oder legt diesen fest. (Von RibbonControl geerbt.)

Zum Seitenanfang

Methoden

	Name	Beschreibung
	Dispose	Führt anwendungsspezifische Aufgaben aus, die mit dem Freigeben, Zurückgeben oder Zurücksetzen von nicht verwalteten Ressourcen zusammenhängen. (Von IDisposable geerbt.)
	PerformDynamicLayout	Ruft die Microsoft.Office.Core.IRibbonUI.InvalidateControl-Methode des übergeordneten Steuerelements ab, wenn die RibbonComponent über ein dynamisches übergeordnetes Element, z. B. ein dynamisches Menü, verfügt; das Layout wird nicht gesperrt. (Von RibbonComponent geerbt.)
	PerformLayout	Ruft Microsoft.Office.Core.IRibbonUI.InvalidateControl auf, falls RibbonComponent über ein übergeordnetes Element verfügt und das Layout nicht angehalten wurde. (Von RibbonComponent geerbt.)
	ResumeLayout()	Kehrt den Effekt der SuspendLayout-Methode um. (Von RibbonComponent geerbt.)
	ResumeLayout(Boolean)	Kehrt den Effekt der SuspendLayout-Methode um. (Von RibbonComponent geerbt.)
	SuspendLayout	Hindert die Microsoft Office-Anwendung am Aktualisieren des Zustands der Steuerelemente auf dem Menüband. (Von RibbonComponent geerbt.)

Zum Seitenanfang

Ereignisse

	Name	Beschreibung
	Click	Tritt ein, wenn der Benutzer auf die Schaltfläche klickt.
	Disposed	Stellt die Methode dar, die das Disposed-Ereignis einer Komponente behandelt. (Von IComponent geerbt.)

Zum Seitenanfang

Hinweise

Visual Studio erstellt eine Instanz einer Klasse, die die RibbonButton-Schnittstelle implementiert, wenn Sie ein Button-Steuerelement von der Registerkarte Steuerelemente für Office-Menübänder der Toolbox auf den Menüband-Designer ziehen.

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 das Menüband 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.

Sie können zur Laufzeit eine RibbonButton erstellen, indem Sie die CreateRibbonButton-Methode des RibbonFactory-Objekts verwenden.

Es gibt zwei Möglichkeiten, um auf das RibbonFactory-Objekt zuzugreifen:

Mithilfe der Factory-Eigenschaft der Ribbon-Klasse.Verwenden Sie diesen Ansatz aus Code in der Ribbon-Klasse.
Mithilfe der Globals.Factory.GetRibbonFactory-Methode.Verwenden Sie diesen Ansatz aus Code außerhalb der Ribbon-Klasse.

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 einer Klasse, die die RibbonButton-Schnittstelle mit CreateRibbonButton implementiert. Methode der RibbonFactory-Klasse.Weitere Informationen finden Sie unter Globaler Zugriff auf Objekte in Office-Projekten. 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.

Hinweis
Diese Schnittstelle wird von der Visual Studio-Tools für Office-Laufzeit implementiert. Es ist nicht vorgesehen, dass der Typ direkt vom Code implementiert wird. Weitere Informationen finden Sie unter Übersicht über die Visual Studio Tools for Office-Laufzeit.

Verwendung

Diese Dokumentation beschreibt die Version des Typs, der in Office-Projekten verwendet wird, die auf .NET Framework 4 und .NET Framework 4.5 ausgerichtet sind. In Projekten, die auf .NET Framework 3.5 abzielen, verfügt dieser Typ möglicherweise über unterschiedliche Member, und die für diesen Typ bereitgestellten Codebeispiele funktionieren möglicherweise nicht. Dokumentation zu diesem Typ in Projekten mit der Zielversion .NET Framework 3.5 finden Sie im folgenden Verweisabschnitt in der Visual Studio 2008-Dokumentation: https://go.microsoft.com/fwlink/?LinkId=160658.

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 ein Menüband (Visual Designer)-Element zu einem Projekt hinzu, in dem Sie die Office-Entwicklungstools in Visual Studio verwenden.
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 = Me.Factory.CreateRibbonButton()
    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 = this.Factory.CreateRibbonButton();
    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);

}