RibbonDialogLauncher-Schnittstelle

Artikel
05/07/2013

Stellt ein kleines standardisiertes Symbol für eine Gruppe dar, mit dem ein Dialogfeld geöffnet werden kann.

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

Syntax

'Declaration
<GuidAttribute("e143d5e9-e844-4052-9793-2070185d351d")> _
Public Interface RibbonDialogLauncher _
    Inherits IDisposable

[GuidAttribute("e143d5e9-e844-4052-9793-2070185d351d")]
public interface RibbonDialogLauncher : IDisposable

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

Eigenschaften

	Name	Beschreibung
	Enabled	Ruft einen Wert ab, der angibt, ob dieses RibbonDialogLauncher aktiviert ist, oder legt diesen fest.
	Image	Ruft ein Bild ab bzw. legt ein Bild fest, das in diesem RibbonDialogLauncher angezeigt wird, wenn es der Symbolleiste für den Schnellzugriff hinzugefügt wird.
	ImageName	Ruft einen Bezeichner ab bzw. legt einen Bezeichner fest, mit dem ein Bild diesem RibbonDialogLauncher zugeordnet wird, wenn es der Symbolleiste für den Schnellzugriff hinzugefügt wird.
	KeyTip	Ruft die Tastenkombination für dieses RibbonDialogLauncher ab oder legt diese fest.
	OfficeImageId	Ruft das Bild ab bzw. legt das Bild fest, das für dieses RibbonDialogLauncher angezeigt werden soll, wenn Sie ein integriertes Microsoft Office-Symbol verwenden möchten.
	Parent	Ruft ein RibbonGroup-Objekt ab, zu dessen Membern RibbonDialogLauncher gehört.
	Ribbon	Ruft die OfficeRibbon ab, auf der RibbonDialogLauncher platziert ist.
	ScreenTip	Ruft Tipptext ab, der angezeigt wird, wenn der Benutzer den Zeiger auf RibbonDialogLauncher richtet, oder legt diesen fest.
	SuperTip	Ruft mehrzeiligen Tipptext ab, der angezeigt wird, wenn der Benutzer den Zeiger auf RibbonDialogLauncher richtet, oder legt diesen fest.
	Visible	Ruft einen Wert ab, der angibt, ob dieses RibbonDialogLauncher sichtbar ist, oder legt diesen fest.

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.)
	ResumeLayout	Kehrt den Effekt der SuspendLayout-Methode um.
	SuspendLayout	Hindert die Microsoft Office-Anwendung am Aktualisieren des Zustands der Steuerelemente in OfficeRibbon.

Zum Seitenanfang

Hinweise

Ein RibbonDialogLauncher wird standardmäßig in einer Gruppe unten rechts angezeigt.

Die Image-Eigenschaft, die ImageName-Eigenschaft und die OfficeImageId-Eigenschaft haben keinen sichtbaren Effekt, wenn RibbonDialogLauncher in einer Gruppe auf dem Menüband angezeigt wird.Wenn ein Benutzer der Symbolleiste für den Schnellzugriff jedoch einen RibbonDialogLauncher hinzufügt, steuern diese Eigenschaften das Verhalten des angezeigten Bilds.Zudem blendet die Visible-Eigenschaft nicht das RibbonDialogLauncher aus, wenn es auf der Symbolleiste für den Schnellzugriff angezeigt wird.Der Benutzer kann mithilfe des Menüband (XML)-Elements den RibbonDialogLauncher der Symbolleiste für den Schnellzugriff hinzufügen.Weitere Informationen finden Sie unter Übersicht über die Multifunktionsleiste.

RibbonDialogLauncher gilt nur für RibbonGroup.Das RibbonGroup-Objekt besitzt einen DialogLauncher-Member des RibbonDialogLauncher-Typs.Weitere Informationen zum Hinzufügen von RibbonDialogLauncher zu RibbonGroup finden Sie unter Gewusst wie: Hinzufügen eines Dialogfeld-Startprogramms zu einer Multifunktionsleistengruppe.

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

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.

Beispiele

Im folgenden Beispiel wird gezeigt, wie ein RibbonDialogLauncher eine Menübandgruppe hinzugefügt wird und wie ein benutzerdefiniertes Dialogfeld geöffnet wird, mit dem Benutzer erweiterte Einstellungen auswählen können, indem Sie in der unteren rechten Ecke von RibbonGroup auf das Symbol RibbonDialogLauncher klicken.

Zum Ausführen dieses Codebeispiels müssen zuerst die folgenden Schritte ausgeführt werden:

Fügen Sie einem Office-Projekt ein Menüband (Visual Designer)-Element hinzu.
Fügen Sie der Standardgruppe Group1 einen RibbonDialogLauncher hinzu, wie in Gewusst wie: Hinzufügen eines Dialogfeld-Startprogramms zu einer Multifunktionsleistengruppe erläutert.
Wenn Sie Visual Basic verwenden, fügen Sie dem Projekt ein neues Dialogfeld-Element hinzu.Wenn Sie C# verwenden, fügen Sie ein neues Windows Form-Element hinzu, und wandeln Sie es in ein Dialogfeld um, indem Sie dem Formular die Schaltflächen OK und Abbrechen hinzufügen und Ereignishandler für die Klickereignisse der Schaltflächen erstellen.
Legen Sie die Eigenschaft (Name) des Dialogfelds auf advancedSettingsDialog fest.Sie können das Dialogfeld anpassen, indem Sie Steuerelemente hinzufügen und weitere Eigenschaften festlegen.
Fügen Sie dem Code den Ereignishandler DialogLauncherClick hinzu.
Fügen Sie den Inhalt folgender Methode dem Ereignishandler DialogLauncherClick hinzu.

Private Sub Group1_DialogLauncherClick(ByVal sender As Object, ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) Handles Group1.DialogLauncherClick
    Dim dlg As advancedSettingsDialog = New advancedSettingsDialog()
    dlg.ShowDialog()
End Sub

void group1_DialogLauncherClick(object sender, Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs e)
{
    advancedSettingsDialog dlg = new advancedSettingsDialog();
    dlg.ShowDialog();
}