RibbonToggleButton Schnittstelle

  • Referenz

Definition

Namespace:
Microsoft.Office.Tools.Ribbon
Assembly:
Microsoft.Office.Tools.Common.dll

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

public interface class RibbonToggleButton : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent
[System.Runtime.InteropServices.Guid("fc50977f-187c-4082-ab53-087e81f4ded1")]
public interface RibbonToggleButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent
[<System.Runtime.InteropServices.Guid("fc50977f-187c-4082-ab53-087e81f4ded1")>]
type RibbonToggleButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable
Public Interface RibbonToggleButton
Implements IComponent, IDisposable, RibbonControl
Attribute
GuidAttribute
Implementiert
RibbonComponent RibbonControl IComponent IDisposable

Hinweise

Ein RibbonToggleButton kann verwendet werden, um anzuzeigen, ob ein Element ausgewählt ist.

Sie können eine RibbonToggleButton zur Laufzeit 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 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

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 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 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.

(Geerbt von RibbonComponent)
OfficeImageId

Ruft das Bild ab, das für RibbonToggleButton angezeigt werden soll, wenn Sie ein integriertes Microsoft Office-Symbol verwenden möchten, oder legt das Bild fest.
Parent

Ruft ein RibbonComponent ab, das das übergeordnete Element von RibbonComponent darstellt.

(Geerbt von RibbonComponent)
Position

Ruft die Position der RibbonToggleButton ab oder legt sie fest, falls sich das Steuerelement 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 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 die RibbonToggleButton sichtbar ist, oder legt diesen Wert fest.
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 diesem RibbonComponent zugeordnet sind, oder legt diese fest.

(Geerbt von RibbonComponent)
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

Click

Tritt ein, wenn der Benutzer auf das RibbonToggleButton-Steuerelement klickt.

Gilt für: