RibbonMenu 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 ein Menü auf der Registerkarte des Menübands oder dem Microsoft Office-Menü dar.

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

[System.Runtime.InteropServices.Guid("59dc7f42-aca2-484a-9622-1ee34a6cfd7d")]
public interface RibbonMenu : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("59dc7f42-aca2-484a-9622-1ee34a6cfd7d")>]
type RibbonMenu = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonMenu
Implements IComponent, IDisposable, RibbonControl

Attribute: GuidAttribute

Implementiert: RibbonComponent RibbonControl IComponent IDisposable

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie ein Untermenü zur Laufzeit einem vorhandenen Menü hinzugefügt und aufgefüllt wird.

Ein umfangreicheres Beispiel, das Steuerelemente zur Laufzeit aktualisiert und das Abrufen von Daten aus der AdventureWorks-Beispieldatenbank mithilfe von Language-Integrated Queries (LINQ) umfasst, finden Sie unter Exemplarische Vorgehensweise: Aktualisieren der Steuerelemente auf einem Menüband zur Laufzeit.

Um dieses Codebeispiel auszuführen, müssen Sie zunächst die folgenden Schritte ausführen:

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

Auf diese Weise können Schaltflächen für das Menü während der Laufzeit hinzugefügt und entfernt werden, nachdem das Menüband in die Office-Anwendung geladen wurde.

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

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

Hinweise

Visual Studio erstellt ein RibbonMenu -Objekt, wenn Sie ein Menü-Steuerelement von der Registerkarte Office-Menübandsteuerelemente der Toolbox auf das Menüband Designer ziehen.

Sie können eine RibbonMenu zur Laufzeit 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 sind Elemente aufgeführt, die für allgemeine Aufgaben nützlich sind. Alle diese Aufgaben können zur Entwurfszeit ausgeführt werden. Einige dieser Aufgaben können zur Laufzeit nur ausgeführt werden, bevor das Menüband in die Office-Anwendung geladen wird oder bevor das Steuerelement zur Laufzeit einem dynamischen Menü hinzugefügt wird. Weitere Informationen finden Sie unter Übersicht über das Menübandobjektmodell.

Aufgabe	Mitglied
Anzeigen eines Bilds im Menü.	Verwenden Sie die Image - oder ImageName -Eigenschaft. Sie können auch Bilder wiederverwenden, die in integrierten Menüband-Steuerelementen angezeigt werden. Legen Sie hierzu auf die ID eines integrierten Microsoft Office-Images fest OfficeImageId , das Sie als Symbol für das Menü anzeigen möchten.
Ändern Sie die Größe des Menüs.	Legen Sie die ControlSize -Eigenschaft auf den gewünschten Wert fest. Legen Sie für ein großes Menü beispielsweise auf `Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge`fest.
Ändern Sie die Größe der Elemente im Menü.	Legen Sie die ItemSize -Eigenschaft auf den gewünschten Wert fest. Wenn Sie z. B. größere Elemente anzeigen möchten, legen Sie sie auf fest `Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge`.
Aktivieren Sie Änderungen am Menü zur Laufzeit (z. B. um das Hinzufügen von Steuerelementen zum Menü zur Laufzeit zu aktivieren).	Setzen Sie die Dynamic-Eigenschaft auf `true`.
Greifen Sie auf die Steuerelemente im Menü zu, fügen Sie Dem Menü Steuerelemente hinzu, oder entfernen Sie Steuerelemente aus dem Menü.	Verwenden Sie die Items-Eigenschaft.
Fügen Sie dem Microsoft Office-Menü, einer Gruppe oder einem anderen Steuerelement, das Menüs enthalten kann, ein Menü hinzu.	Fügen Sie der `Items` -Eigenschaft des Menüs, der Gruppe oder des Steuerelements von Microsoft Office hinzuRibbonMenu.

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 des Menüs ab oder legt diese fest.
Description	Ruft den Text ab, der im aktuellen Menü angezeigt wird, oder legt ihn fest.
Dynamic	Ruft einen Wert ab, der angibt, ob das Menü während der Laufzeit geändert werden kann, oder legt diesen Wert 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 dem Menü angezeigte Bild ab oder legt dieses fest.
ImageName	Ruft den Namen ab, den Sie im LoadImage-Ereignishandler zum Identifizieren eines Bilds für das Menü verwenden können, oder legt ihn fest.
Items	Ruft die Auflistung der Steuerelemente im Menü ab.
ItemSize	Ruft die Größe der Steuerelemente im Menü ab oder legt diese fest.
KeyTip	Ruft die Tastenkombination des Menüs 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. (Geerbt von RibbonComponent)
OfficeImageId	Ruft das Bild ab, oder legt das Bild fest, das im Menü 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 des Menüs ab oder legt sie fest, falls sich das Menü im Microsoft Office-Menü befindet.
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 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, der angibt, ob die Bezeichnung für das Menü sichtbar ist, oder legt diesen Wert fest.
SuperTip	Ruft mehrzeiligen Tipptext ab, der angezeigt wird, wenn der Benutzer mit dem Zeiger über das Menü fährt, oder legt diesen fest.
Tag	Ruft anwendungsspezifische Daten ab, die diesem RibbonComponent zugeordnet sind, oder legt diese fest. (Geerbt von RibbonComponent)
Title	Ruft den Titel ab, der angezeigt wird, wenn ein Benutzer ein Menü erweitert, das zum Microsoft Office-Menü hinzugefügt wurde, oder legt diesen Titel fest.
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

ItemsLoading

Tritt auf, wenn Steuerelemente oder verschachtelte Menüs zur Laufzeit in das aktuelle Menü geladen werden.

Gilt für:

Freigeben über