Freigeben über


RibbonEditBox-Schnittstelle

Stellt ein Eingabefeld auf einem Menüband dar.

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

Syntax

'Declaration
<GuidAttribute("14396b39-63c4-4fc2-92fe-cbccdbe5f306")> _
Public Interface RibbonEditBox _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable
[GuidAttribute("14396b39-63c4-4fc2-92fe-cbccdbe5f306")]
public interface RibbonEditBox : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

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

Eigenschaften

  Name Beschreibung
Ö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 im Eingabefeld angezeigte Bild ab oder legt dieses fest.
Öffentliche Eigenschaft ImageName Ruft den Namen ab oder legt den Namen fest, mit dem das Bild im LoadImage-Ereignishandler identifiziert wird.
Öffentliche Eigenschaft KeyTip Ruft die Tastenkombination für dieses RibbonEditBox ab oder legt diese fest.
Öffentliche Eigenschaft Label Ruft den Text ab oder legt den Text fest, der in RibbonEditBox angezeigt wird.
Öffentliche Eigenschaft MaxLength Ruft einen Wert ab oder legt einen Wert fest, der die maximale Anzahl der pro Eintrag in RibbonEditBox zulässigen Zeichen angibt.
Ö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 auf der Schaltfläche 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 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 RibbonEditBox richtet, oder legt diesen fest.
Öffentliche Eigenschaft ShowImage Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob das RibbonEditBox zugeordnete Bild sichtbar ist.
Öffentliche Eigenschaft ShowLabel Ruft einen Wert ab, der angibt, ob die Bezeichnung von RibbonEditBox sichtbar ist, oder legt diesen fest.
Öffentliche Eigenschaft Site Ruft die ISite ab, die IComponent zugeordnet ist, oder legt diese fest. (Von IComponent geerbt.)
Öffentliche Eigenschaft SizeString Ruft eine Zeichenfolge ab, durch die die Größe von RibbonEditBox bestimmt wird, oder legt diese fest.
Öffentliche Eigenschaft SuperTip Ruft mehrzeiligen Tipptext ab, der angezeigt wird, wenn der Benutzer den Zeiger auf RibbonEditBox 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 Text Ruft Text ab oder legt Text fest, der beim ersten Anzeigen des Eingabefelds in RibbonEditBox erscheint.
Ö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 Disposed Stellt die Methode dar, die das Disposed-Ereignis einer Komponente behandelt. (Von IComponent geerbt.)
Öffentliches Ereignis TextChanged Tritt ein, wenn ein Benutzer den Text in RibbonEditBox ändert.

Zum Seitenanfang

Hinweise

Im RibbonEditBox-Steuerelement wird ein beschriftetes Feld angezeigt, in dem Benutzer Text eingeben und bearbeiten können.

Visual Studio erstellt ein RibbonEditBox-Objekt, wenn Sie ein EditBox-Steuerelement von der Registerkarte Steuerelemente für Office-Menübänder der Toolbox auf den Menüband-Designer ziehen.

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

Einige Eigenschaften dieses Steuerelements können nur vor dem Laden des Menübands in die Office-Anwendung festgelegt werden. Informationen zum Festlegen dieser Eigenschaften finden Sie unter Multifunktionsleisten-Objektmodellübersicht.

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