Freigeben über


RibbonGallery-Schnittstelle

Stellt ein Steuerelement dar, in dem ein Menü von RibbonDropDownItem-Objekten und RibbonButton-Steuerelementen angezeigt wird.

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

Syntax

'Declaration
<GuidAttribute("c1cff037-81e7-44a0-8f9d-150237dfd312")> _
Public Interface RibbonGallery _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable
[GuidAttribute("c1cff037-81e7-44a0-8f9d-150237dfd312")]
public interface RibbonGallery : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

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

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft Buttons Ruft die Auflistung von Schaltflächen in dieser RibbonGallery ab.
Öffentliche Eigenschaft ColumnCount Ruft die Anzahl der Item-Spalten in RibbonGallery ab oder legt sie fest.
Öffentliche Eigenschaft ControlSize Ruft die Größe des RibbonGallery-Steuerelements ab oder legt diese fest.
Öffentliche Eigenschaft Description Ruft den Text ab oder legt den Text fest, der auf diesem RibbonGallery-Steuerelement in einem Menü oder auf einer Trennschaltfläche angezeigt wird.
Öffentliche Eigenschaft Enabled Ruft einen Wert ab, der angibt, ob RibbonControl aktiviert ist, oder legt diesen fest. (Von RibbonControl geerbt.)
Öffentliche Eigenschaft Id Ruft eine Zeichenfolge ab, die von Microsoft Office zum Identifizieren dieses RibbonControl-Objekts verwendet wird. (Von RibbonControl geerbt.)
Öffentliche Eigenschaft Image Ruft das auf der Schaltfläche angezeigte Bild ab oder legt dieses fest.
Öffentliche Eigenschaft ImageName Ruft den Namen ab oder legt den Namen fest, mit dem RibbonGallery im LoadImage-Ereignishandler identifiziert wird.
Öffentliche Eigenschaft ItemImageSize Ruft eine Size ab, die die Dimensionen der von den Elementen in RibbonGallery angezeigten Bilder bestimmt, oder legt sie fest.
Öffentliche Eigenschaft Items Ruft eine Auflistung der RibbonDropDownItem-Komponenten in dieser RibbonGallery ab.
Öffentliche Eigenschaft KeyTip Ruft die Tastenkombination für RibbonGallery ab oder legt dieses fest.
Öffentliche Eigenschaft Label Ruft den Text ab oder legt den Text fest, der in RibbonGallery angezeigt wird.
Öffentliche Eigenschaft Name Ruft den Namen dieser RibbonComponent ab oder legt diesen fest. (Von RibbonComponent geerbt.)
Öffentliche Eigenschaft OfficeImageId Ruft das Bild ab bzw. legt das Bild fest, das auf dem Steuerelement angezeigt werden soll, wenn Sie ein integriertes Microsoft Office-Symbol verwenden möchten.
Öffentliche Eigenschaft Parent Ruft eine RibbonComponent ab, die die übergeordnete Komponente von RibbonComponent darstellt. (Von RibbonComponent geerbt.)
Öffentliche Eigenschaft Position Ruft die Position des Katalogs oder legt sie fest, falls sich der Katalog im Microsoft Office-Menü befindet.
Öffentliche Eigenschaft Ribbon Ruft das Ribbon-Objekt auf der obersten Ebene ab, das die Steuerelementhierarchie beinhaltet. (Von RibbonComponent geerbt.)
Öffentliche Eigenschaft 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.)
Öffentliche Eigenschaft RowCount Ruft die Anzahl der Zeilen von RibbonDropDownItem-Komponenten ab, die von RibbonGallery angezeigt werden.
Öffentliche Eigenschaft ScreenTip Ruft Tipptext ab, der angezeigt wird, wenn der Benutzer den Zeiger auf RibbonGallery richtet, oder legt diesen fest.
Öffentliche Eigenschaft SelectedItem Ruft das derzeit ausgewählte Element ab oder legt dieses fest.
Öffentliche Eigenschaft SelectedItemIndex Ruft den Index des derzeit ausgewählten RibbonDropDownItem ab oder legt diesen fest.
Öffentliche Eigenschaft ShowImage Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob das RibbonGallery zugeordnete Bild sichtbar ist.
Öffentliche Eigenschaft ShowItemImage Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob Bilder für die Elemente im Katalog angezeigt werden.
Öffentliche Eigenschaft ShowItemLabel Ruft einen Wert ab bzw. legt einen Wert fest, der angibt, ob für Elemente in RibbonGallery Bezeichnungen angezeigt werden.
Öffentliche Eigenschaft ShowItemSelection Ruft einen Wert ab bzw. legt einen Wert fest, der angibt, ob sich das derzeit ausgewählte RibbonDropDownItem visuell vom den übrigen nicht ausgewählten Elementen unterscheidet.
Öffentliche Eigenschaft ShowLabel Ruft einen Wert ab, der angibt, ob die Bezeichnung RibbonGallery sichtbar ist, oder legt diesen fest.
Öffentliche Eigenschaft Site Ruft die ISite ab, die IComponent zugeordnet ist, oder legt diese fest. (Von IComponent geerbt.)
Öffentliche Eigenschaft SuperTip Ruft mehrzeiligen Tipptext ab, der angezeigt wird, wenn der Benutzer den Zeiger auf RibbonGallery richtet, oder legt diesen fest.
Öffentliche Eigenschaft Tag Ruft anwendungsspezifische Daten ab, die RibbonComponent zugeordnet sind, oder legt diese fest. (Von RibbonComponent geerbt.)
Öffentliche Eigenschaft Visible Ruft einen Wert ab, der angibt, ob RibbonControl sichtbar ist, oder legt diesen fest. (Von RibbonControl geerbt.)

Zum Seitenanfang

Methoden

  Name Beschreibung
Öffentliche Methode Dispose Führt anwendungsspezifische Aufgaben aus, die mit dem Freigeben, Zurückgeben oder Zurücksetzen von nicht verwalteten Ressourcen zusammenhängen. (Von IDisposable geerbt.)
Öffentliche Methode 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.)
Öffentliche Methode 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.)
Öffentliche Methode ResumeLayout() Kehrt den Effekt der SuspendLayout-Methode um. (Von RibbonComponent geerbt.)
Öffentliche Methode ResumeLayout(Boolean) Kehrt den Effekt der SuspendLayout-Methode um. (Von RibbonComponent geerbt.)
Öffentliche Methode SuspendLayout Hindert die Microsoft Office-Anwendung am Aktualisieren des Zustands der Steuerelemente auf dem Menüband. (Von RibbonComponent geerbt.)

Zum Seitenanfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis ButtonClick Tritt auf, wenn ein Benutzer auf eine Schaltfläche in RibbonGallery klickt.
Öffentliches Ereignis Click Tritt auf, wenn ein Benutzer auf ein Element in RibbonGallery klickt.
Öffentliches Ereignis Disposed Stellt die Methode dar, die das Disposed-Ereignis einer Komponente behandelt. (Von IComponent geerbt.)
Öffentliches Ereignis ItemsLoading Tritt ein, wenn RibbonGallery geöffnet wird.

Zum Seitenanfang

Hinweise

Ebenso wie die RibbonDropDown-Schnittstelle zeigt RibbonGallery ein Menü von RibbonDropDownItem-Objekten und RibbonButton-Steuerelementen an.

Im Gegensatz zur RibbonDropDown-Schnittstelle werden von der RibbonGallery-Schnittstelle Click-Ereignisse und keine SelectionChanged-Ereignisse ausgelöst, wenn ein Benutzer auf ein RibbonDropDownItem klickt. Dies bedeutet beispielsweise, dass das Click-Ereignis zweimal ausgelöst wird, wenn ein Benutzer zweimal auf dasselbe RibbonDropDownItem klickt. (Das SelectionChanged-Ereignis wird höchstens einmal ausgelöst, wenn die ursprüngliche Auswahl für dasselbe Szenario in RibbonDropDown getroffen wurde, und zwar abhängig von der Auswahl vor dem ersten Klick.)

Mit der ShowItemSelection-Eigenschaft wird gesteuert, ob sich das derzeit ausgewählte RibbonDropDownItem visuell von den nicht ausgewählten Elementen unterscheidet. In RibbonGallery kann jeweils nur ein Element ausgewählt werden.

Mit der ItemImageSize-Eigenschaft können andere Bildgrößen als 16x16 und 32x32 angegeben werden.

So fügen Sie während der Entwurfszeit RibbonDropDownItem-Objekte hinzu

  1. Klicken Sie im Fenster Eigenschaften auf die Items-Eigenschaft.

  2. Klicken Sie auf die Ellipse ().

  3. Im Dropdownauflistungs-Editor werden neue Elemente hinzugefügt, sortiert und bearbeitet.

Sie können RibbonGallery während der Entwurfszeit RibbonButton-Steuerelemente hinzufügen.

So fügen Sie während der Entwurfszeit RibbonButton-Steuerelemente hinzu

  1. Klicken Sie im Fenster Eigenschaften auf die Buttons-Eigenschaft.

  2. Klicken Sie auf die Ellipse ().

  3. Im Schaltflächenauflistungs-Editor werden neue Schaltflächensteuerelemente hinzugefügt, sortiert und bearbeitet.

Sie können zur Laufzeit eine RibbonGallery erstellen, indem Sie die CreateRibbonGallery-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.

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.

Tipp

Diese Schnittstelle wird von der Visual Studio Tools for 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

In dieser Dokumentation wird die Version dieses Typs beschrieben, der in Office-Projekten mit der Zielversion .NET Framework 4 verwendet wird. In Projekten mit der Zielversion .NET Framework 3.5 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.

Siehe auch

Referenz

Microsoft.Office.Tools.Ribbon-Namespace

Weitere Ressourcen

Übersicht über die Multifunktionsleiste

Multifunktionsleisten-Designer

Multifunktionsleisten-Objektmodellübersicht

Gewusst wie: Erste Schritte beim Anpassen der Multifunktionsleiste