RibbonCheckBox-Schnittstelle

Artikel
05/07/2013

Stellt ein Kontrollkästchen-Steuerelement auf einem Menüband dar.

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

Syntax

'Declaration
<GuidAttribute("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")> _
Public Interface RibbonCheckBox _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")]
public interface RibbonCheckBox : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

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

Eigenschaften

	Name	Beschreibung
	Checked	Ruft einen Wert ab bzw. legt einen Wert fest, der angibt, ob RibbonCheckBox aktiviert ist.
	Description	Ruft eine Beschreibung für dieses RibbonCheckBox ab, das bei Festlegung der ItemSize-Eigenschaft des übergeordneten Steuerelements auf RibbonControlSizeLarge angezeigt wird, oder legt eine Beschreibung fest.
	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.)
	KeyTip	Ruft die Tastenkombination für RibbonCheckBox ab oder legt diese fest.
	Label	Ruft den Text ab oder legt den Text fest, der in RibbonCheckBox angezeigt wird.
	Name	Ruft den Namen dieser RibbonComponent ab oder legt diesen fest. (Von RibbonComponent geerbt.)
	Parent	Ruft eine RibbonComponent ab, die die übergeordnete Komponente von RibbonComponent darstellt. (Von RibbonComponent geerbt.)
	Position	Ruft die Position des Kontrollkästchens ab oder legt sie fest, falls sich das Kontrollkästchen 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 RibbonCheckBox richtet, oder legt diesen 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 RibbonCheckBox 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 ein Benutzer das Kontrollkästchen aktiviert.
	Disposed	Stellt die Methode dar, die das Disposed-Ereignis einer Komponente behandelt. (Von IComponent geerbt.)

Zum Seitenanfang

Hinweise

Während der Laufzeit kann eine Instanz dieses Steuerelements erstellt und einem dynamischen Menü hinzugefügt werden.Ein Menü wird als dynamisch bezeichnet, wenn dessen Dynamic-Eigenschaft auf true festgelegt wird.

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.

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