RibbonToggleButton-Schnittstelle

Artikel
05/07/2013

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
	Checked	Ruft einen Wert ab, der angibt, ob die Umschaltfläche gedrückt wird oder nicht, oder legt diesen Wert fest.
	ControlSize	Ruft die Größe des RibbonToggleButton-Steuerelements ab oder legt diese fest.
	Description	Ruft den Text ab bzw. legt den Text fest, der in einem Menü auf diesem RibbonToggleButton-Steuerelement angezeigt wird.
	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 auf dem Steuerelement 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 Steuerelement verwenden können.
	KeyTip	Ruft die Tastenkombination der Umschaltfläche ab oder legt sie fest.
	Label	Ruft den Text auf der Umschaltfläche ab oder legt ihn 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 für RibbonToggleButton 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 von RibbonToggleButton ab oder legt sie fest, falls sich das Steuerelement 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 die Umschaltfläche richtet, oder legt diesen fest.
	ShowImage	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob das RibbonToggleButton zugeordnete Bild sichtbar ist.
	ShowLabel	Ruft einen Wert ab, der angibt, ob die Bezeichnung für RibbonToggleButton sichtbar ist, oder legt diesen Wert fest.
	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 RibbonToggleButton-Steuerelement richtet, oder legt diesen fest.
	Tag	Ruft anwendungsspezifische Daten ab, die RibbonComponent zugeordnet sind, oder legt diese fest. (Von RibbonComponent geerbt.)
	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
	Click	Tritt ein, wenn der Benutzer auf das RibbonToggleButton-Steuerelement klickt.
	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.

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.