RibbonMenu-Schnittstelle

Artikel
05/07/2013

Stellt ein Menü auf einer Menübandregisterkarte oder im Microsoft Office-Menü dar.

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

Syntax

'Declaration
<GuidAttribute("59dc7f42-aca2-484a-9622-1ee34a6cfd7d")> _
Public Interface RibbonMenu _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("59dc7f42-aca2-484a-9622-1ee34a6cfd7d")]
public interface RibbonMenu : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

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

Eigenschaften

	Name	Beschreibung
	ControlSize	Ruft die Größe des Menüs ab oder legt sie fest.
	Description	Ruft den Text ab, der im aktuellen Menü angezeigt wird, oder legt den Text fest.
	Dynamic	Ruft einen Wert ab bzw. legt einen Wert fest, der angibt, ob das Menü während der Laufzeit geändert werden kann.
	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 im Menü angezeigte Bild ab oder legt dieses fest.
	ImageName	Ruft den Namen ab oder legt den Namen fest, den Sie im LoadImage-Ereignishandler zum Identifizieren eines Bilds für das Menü verwenden können.
	Items	Ruft die Auflistung von Steuerelementen ab, die sich im Menü befinden.
	ItemSize	Ruft die Größe der Steuerelemente im Menü ab oder legt diese fest.
	KeyTip	Ruft die Zugriffstaste für das Menü ab oder legt sie fest.
	Label	Ruft den im Menü 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 im Menü 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 des Menüs ab oder legt sie fest, falls sich das Menü 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 Tipptext ab, der angezeigt wird, wenn der Benutzer den Zeiger auf das Menü richtet, oder legt diesen fest.
	ShowImage	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob das dem Menü zugeordnete Bild sichtbar ist.
	ShowLabel	Ruft einen Wert ab bzw. legt einen Wert fest, der angibt, ob die Bezeichnung für das Menü 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 das Menü richtet, oder legt diesen fest.
	Tag	Ruft anwendungsspezifische Daten ab, die RibbonComponent zugeordnet sind, oder legt diese fest. (Von RibbonComponent geerbt.)
	Title	Ruft den Titel ab bzw. legt den Titel fest, der angezeigt wird, wenn der Benutzer ein Menü erweitert, das dem Microsoft Office-Menü hinzugefügt wird.
	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
	Disposed	Stellt die Methode dar, die das Disposed-Ereignis einer Komponente behandelt. (Von IComponent geerbt.)
	ItemsLoading	Tritt auf, wenn Steuerelemente oder geschachtelte Menüs während der Laufzeit in das aktuelle Menü geladen werden.

Zum Seitenanfang

Hinweise

Visual Studio erstellt ein RibbonMenu-Objekt, wenn Sie ein Menu-Steuerelement von der Registerkarte Steuerelemente für Office-Menübänder der Toolbox auf den Menüband-Designer ziehen.

Sie können zur Laufzeit eine RibbonMenu erstellen, indem Sie die CreateRibbonMenu-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.Alle diese Aufgaben können während der Entwurfszeit ausgeführt werden.Einige dieser Aufgaben können nur während der Laufzeit 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.Weitere Informationen finden Sie unter Multifunktionsleisten-Objektmodellübersicht.

Aufgabe	Member
Anzeigen eines Bilds im Menü.	Verwenden Sie die Image-Eigenschaft oder die ImageName-Eigenschaft. Sie können auch Bilder wieder verwenden, die in integrierten Menüband-Steuerelementen angezeigt werden.Legen Sie dazu OfficeImageId auf die ID eines integrierten Microsoft Office-Bilds fest, das Sie als Symbol für das Menü anzeigen möchten.
Ändern der Größe des Menüs.	Legen Sie die ControlSize-Eigenschaft auf den gewünschten Wert fest.Legen Sie die Größe für ein großes Menü beispielsweise auf Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge fest.
Ändern der Größe von Elementen im Menü.	Legen Sie die ItemSize-Eigenschaft auf den gewünschten Wert fest.Legen Sie die Eigenschaft zum Anzeigen größerer Elemente auf Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge fest.
Ermöglichen von Änderungen am Menü während der Laufzeit (beispielsweise das Hinzufügen von Steuerelementen zum Menü während der Laufzeit ermöglichen).	Legen Sie die Dynamic-Eigenschaft auf true fest.
Zugreifen auf die Steuerelemente im Menü, Hinzufügen von Steuerelementen zum Menü oder Entfernen von Steuerelementen aus dem Menü.	Verwenden Sie die Items-Eigenschaft.
Hinzufügen eines Menüs zum Microsoft Office-Menü, zu einer Gruppe oder zu einem anderen Steuerelement, das Menüs beinhalten kann.	Fügen Sie ein RibbonMenu der Items-Eigenschaft des Microsoft Office-Menüs, der Gruppe oder des Steuerelements 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 wird dargestellt, wie zur Laufzeit einem bestehenden Menü ein Untermenü hinzugefügt wird und wie dieses aufgefüllt wird.

Ein umfangreicheres Beispiel, in dem Steuerelemente zur Laufzeit aktualisiert und Daten mithilfe von Language-Integrated Queries (LINQ) aus der AdventureWorks-Beispieldatenbank abgerufen werden, finden Sie unter Exemplarische Vorgehensweise: Aktualisieren der Steuerelemente in einer Multifunktionsleiste zur Laufzeit.

Zum Ausführen dieses Codebeispiels müssen zuerst die folgenden Schritte ausgeführt werden:

Fügen Sie einem Office-Projekt ein Menüband (Visual Designer)-Element hinzu.
Fügen Sie der benutzerdefinierten Registerkarte eine Gruppe hinzu.
Fügen Sie der Gruppe ein Menü hinzu.
Legen Sie die (Name)-Eigenschaft des Menüs auf CustomerMenu fest.
Legen Sie die Label-Eigenschaft des Menüs auf Customers fest.
Legen Sie die Dynamic-Eigenschaft des Menüs auf true fest.

Dadurch können Sie Steuerelemente für das Menü während der Laufzeit hinzufügen und entfernen, nachdem das Menüband in die Office-Anwendung geladen wurde.

Private Sub PopulateCustomerMenu()
    ' Add two sub-menus to EmployeeMenu and populate each sub-menu
    ' First sub-menu
    Dim subMenu1 As RibbonMenu = Me.Factory.CreateRibbonMenu()
    subMenu1.Dynamic = True
    subMenu1.Label = "A - M"
    subMenu1.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu1.Items.Last(), RibbonToggleButton).Label = "Hall, Don"
    subMenu1.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu1.Items.Last(), RibbonToggleButton).Label = "Valdez, Rachel"
    CustomerMenu.Items.Add(subMenu1)

    ' Second sub-menu
    Dim subMenu2 As RibbonMenu = Me.Factory.CreateRibbonMenu()
    subMenu2.Dynamic = True
    subMenu2.Label = "N - Z"
    subMenu2.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu2.Items.Last(), RibbonToggleButton).Label = "Robinson, Alex"
    CustomerMenu.Items.Add(subMenu2)

End Sub

private void PopulateCustomerMenu()
{
    // Add two sub-menus to EmployeeMenu and populate each sub-menu
    // First sub-menu
    RibbonMenu subMenu1 = this.Factory.CreateRibbonMenu();
    subMenu1.Dynamic = true;
    subMenu1.Label = "A - M";
    subMenu1.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu1.Items.Last()).Label = "Hall, Don";
    subMenu1.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu1.Items.Last()).Label = "Valdez, Rachel";
    CustomerMenu.Items.Add(subMenu1);

    // Second sub-menu
    RibbonMenu subMenu2 = this.Factory.CreateRibbonMenu();
    subMenu2.Dynamic = true;
    subMenu2.Label = "N - Z";
    subMenu2.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu2.Items.Last()).Label = "Robinson, Alex";
    CustomerMenu.Items.Add(subMenu2);
}