RibbonCheckBox Schnittstelle

Definition

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

public interface class RibbonCheckBox : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent
[System.Runtime.InteropServices.Guid("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")]
public interface RibbonCheckBox : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent
[<System.Runtime.InteropServices.Guid("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")>]
type RibbonCheckBox = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable
Public Interface RibbonCheckBox
Implements IComponent, IDisposable, RibbonControl
Attribute
Implementiert

Hinweise

Sie können zur Laufzeit eine instance dieses Steuerelements erstellen und einem dynamischen Menü hinzufügen. Ein Menü ist dynamisch, wenn Sie seine Dynamic -Eigenschaft auf truefestlegen.

Einige Eigenschaften dieses Steuerelements können nur vor dem Laden des Menübands in die Office-Anwendung oder vor dem Hinzufügen des Steuerelements zu einem dynamischen Menü zur Laufzeit festgelegt werden. Informationen zum Festlegen dieser Eigenschaften finden Sie unter Übersicht über das Menübandobjektmodell.

Sie können eine RibbonCheckBox zur Laufzeit 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 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 das RibbonCheckBox aktiviert ist, oder legt ihn fest.

Description

Ruft eine Beschreibung für dieses RibbonCheckBox ab, das angezeigt wird, wenn die ItemSize-Eigenschaft des übergeordneten Steuerelements auf RibbonControlSizeLarge gesetzt ist, oder legt eine Beschreibung fest.

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)
KeyTip

Ruft die Tastenkombination für dieses RibbonCheckBox ab oder legt sie fest.

Label

Ruft den Text ab, der in einem Menü auf RibbonCheckBox angezeigt wird, oder legt diesen fest.

Name

Ruft den Namen dieser RibbonComponent ab oder legt diesen fest.

(Geerbt von RibbonComponent)
Parent

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

(Geerbt von RibbonComponent)
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 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 das RibbonCheckBox richtet, oder legt diesen fest.

SuperTip

Ruft mehrzeiligen Tipptext ab, der angezeigt wird, wenn der Benutzer den Zeiger auf das RibbonCheckBox 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 auf, wenn ein Benutzer das Kontrollkästchen anklickt.

Gilt für: