RibbonButton Schnittstelle

Referenz

Definition

Namespace:: Microsoft.Office.Tools.Ribbon

Assembly:: Microsoft.Office.Tools.Common.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

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

public interface class RibbonButton : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent

[System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")>]
type RibbonButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonButton
Implements IComponent, IDisposable, RibbonControl

Attribute: GuidAttribute

Implementiert: RibbonComponent RibbonControl IComponent IDisposable

Beispiele

Im folgenden Beispiel wird eine neue Schaltfläche erstellt, verschiedene Eigenschaften der Schaltfläche festgelegt und anschließend einem Menü hinzugefügt. Um dieses Codebeispiel auszuführen, müssen Sie zunächst die folgenden Schritte ausführen:

Fügen Sie ein Menübandelement (Visual Designer) zu einem Projekt hinzu, das mithilfe von Office-Entwicklungstools in Visual Studio erstellt wurde.
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 fest true.
Legen Sie die ItemSize-Eigenschaft des Menüs auf RibbonControlSizeLarge fest.

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

}

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

Hinweise

Visual Studio erstellt eine instance einer Klasse, die die RibbonButton Schnittstelle implementiert, wenn Sie ein Schaltflächen-Steuerelement von der Registerkarte Office-Menübandsteuerelemente der Toolbox auf das Menüband Designer ziehen.

Sie können auch zur Laufzeit eine instance dieses Steuerelements erstellen und einem dynamischen Menü hinzufügen. Ein Menü ist dynamisch, wenn Sie seine Dynamic -Eigenschaft auf truefestlegen.

Einige Eigenschaften dieses Steuerelements können nur vor dem Laden des Menübands in die Office-Anwendung oder vor dem Hinzufügen des Steuerelements zu einem dynamischen Menü zur Laufzeit festgelegt werden. Informationen zum Festlegen dieser Eigenschaften finden Sie unter Übersicht über das Menübandobjektmodell.

Sie können eine RibbonButton zur Laufzeit 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 sind Elemente aufgeführt, die für allgemeine Aufgaben nützlich sind.

Aufgabe	Mitglied
Fügen Sie zur Laufzeit eine Schaltfläche zu einem Menü hinzu, dessen -Eigenschaft auf true festgelegt ist Dynamic .	Erstellen Sie eine instance einer Klasse, die die RibbonButton -Schnittstelle mithilfe von implementiert.CreateRibbonButton -Methode der RibbonFactory -Klasse. Weitere Informationen finden Sie unter Globaler Zugriff auf Objekte in Office-Projekten. Fügen Sie der Sammlung des Menüs `Items` die instance hinzu.
Ändern Sie die Größe der Schaltfläche.	Legen Sie auf den gewünschten Wert fest ControlSize . Legen Sie z. B. für eine große Schaltfläche auf fest `Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge`.
Zeigen Sie ein Bild auf der Schaltfläche an.	Es gibt drei Möglichkeiten zum Anzeigen eines Bilds: – Verwenden Sie die Image -Eigenschaft. Diese Eigenschaft bietet die größte Kontrolle. – 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. Diese Eigenschaft bietet einige Leistungsvorteile.
Deaktivieren oder Ausblenden von Schaltflächen.	Um eine Schaltfläche zu deaktivieren, legen Sie auf `false`festEnabled. Um eine Schaltfläche auszublenden, legen Sie auf `false`festVisible.
Führen Sie Code aus, 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 Visual Studio Tools for Office Runtime Overview.

Verbrauch

Diese Dokumentation beschreibt die Version des Typs, der in Office-Projekten verwendet wird, die auf .NET Framework 4 und höher 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. Eine Dokumentation dieser Art von Projekten, die auf den .NET Framework 3.5 abzielen, erhalten Sie in den folgenden Verweisabschnitten in der Dokumentation zu Visual Studio 2008: http://go.microsoft.com/fwlink/?LinkId=160658.

Eigenschaften

ControlSize	Ruft die Größe der Schaltfläche ab oder legt sie fest.
Description	Ruft den Text ab, der auf dieser Schaltfläche in einem Menü angezeigt wird, wenn die ItemSize -Eigenschaft des Menüs auf Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge festgelegt ist, oder legt diesen fest.
Enabled	Ruft einen Wert ab, der angibt, ob das RibbonControl aktiviert ist, oder legt einen Wert fest. (Geerbt von RibbonControl)
Id	Ruft eine Zeichenfolge ab, die Microsoft Office zum Identifizieren dieses RibbonControl-Objekts verwendet. (Geerbt von RibbonControl)
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. (Geerbt von RibbonComponent)
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 ein RibbonComponent ab, das das übergeordnete Element von RibbonComponent darstellt. (Geerbt von RibbonComponent)
Position	Ruft die Position der Schaltfläche ab, falls sich die Schaltfläche im Microsoft Office-Menü befindet, oder legt diese fest.
Ribbon	Ruft das Ribbon-Objekt der obersten Ebene ab, das die Hierarchie der Steuerelemente enthält. (Geerbt von RibbonComponent)
RibbonUI	Ruft die IRibbonUI-Instanz ab, die von der Microsoft Office-Anwendung für den Erweiterbarkeitscode des Menübands bereitgestellt wird. (Geerbt von RibbonComponent)
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.
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 diesem RibbonComponent zugeordnet sind, oder legt diese fest. (Geerbt von RibbonComponent)
Visible	Ruft einen Wert ab, der angibt, ob das RibbonControl sichtbar ist, oder legt den Wert fest. (Geerbt von RibbonControl)

Methoden

PerformDynamicLayout()	Ruft die Microsoft.Office.Core.IRibbonUI.InvalidateControl-Methode des übergeordneten Steuerelements auf, wenn die RibbonComponent-Schnittstelle über ein dynamisches übergeordnetes Element verfügt (z.B. ein dynamisches Menü), und das Layout nicht angehalten wird. (Geerbt von RibbonComponent)
PerformLayout()	Ruft die Microsoft.Office.Core.IRibbonUI.InvalidateControl-Methode auf, wenn RibbonComponent über ein übergeordnetes Element verfügt und das Layout nicht angehalten wird. (Geerbt von RibbonComponent)
ResumeLayout()	Kehrt den Effekt der SuspendLayout()-Methode um. (Geerbt von RibbonComponent)
ResumeLayout(Boolean)	Kehrt den Effekt der SuspendLayout()-Methode um. (Geerbt von RibbonComponent)
SuspendLayout()	Hindert die Microsoft Office-Anwendung am Aktualisieren des Zustands der Steuerelemente auf dem Menüband. (Geerbt von RibbonComponent)

Ereignisse

Click

Tritt ein, wenn der Benutzer auf die Schaltfläche klickt.

Gilt für:

Freigeben über