Freigeben über


RibbonToggleButton-Schnittstelle

Stellt eine Umschaltfläche auf einem Menüband dar.

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

Syntax

'Declaration
<GuidAttribute("fc50977f-187c-4082-ab53-087e81f4ded1")> _
Public Interface RibbonToggleButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable
[GuidAttribute("fc50977f-187c-4082-ab53-087e81f4ded1")]
public interface RibbonToggleButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

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

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft Checked Ruft einen Wert ab, der angibt, ob die Umschaltfläche gedrückt wird oder nicht, oder legt diesen Wert fest.
Öffentliche Eigenschaft ControlSize Ruft die Größe des RibbonToggleButton-Steuerelements ab oder legt diese fest.
Öffentliche Eigenschaft Description Ruft den Text ab bzw. legt den Text fest, der in einem Menü auf diesem RibbonToggleButton-Steuerelement 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 dem Steuerelement angezeigte Bild ab oder legt dieses fest.
Öffentliche Eigenschaft ImageName Ruft den Namen ab oder legt den Namen fest, den Sie im LoadImage-Ereignishandler zum Identifizieren eines Bilds für das Steuerelement verwenden können.
Öffentliche Eigenschaft KeyTip Ruft die Tastenkombination der Umschaltfläche ab oder legt sie fest.
Öffentliche Eigenschaft Label Ruft den Text auf der Umschaltfläche ab oder legt ihn fest.
Ö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 für RibbonToggleButton 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 von RibbonToggleButton ab oder legt sie fest, falls sich das Steuerelement 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 ScreenTip Ruft Tipptext ab, der angezeigt wird, wenn der Benutzer den Zeiger auf die Umschaltfläche richtet, oder legt diesen fest.
Öffentliche Eigenschaft ShowImage Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob das RibbonToggleButton zugeordnete Bild sichtbar ist.
Öffentliche Eigenschaft ShowLabel Ruft einen Wert ab, der angibt, ob die Bezeichnung für RibbonToggleButton sichtbar ist, oder legt diesen Wert 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 das RibbonToggleButton-Steuerelement 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 Click Tritt ein, wenn der Benutzer auf das RibbonToggleButton-Steuerelement klickt.
Öffentliches Ereignis Disposed Stellt die Methode dar, die das Disposed-Ereignis einer Komponente behandelt. (Von IComponent geerbt.)

Zum Seitenanfang

Hinweise

Mit RibbonToggleButton kann angezeigt werden, ob ein Element ausgewählt ist.

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

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