RibbonDialogLauncher (Interfaz)

Artículo
08/10/2011

Representa un pequeño icono estandarizado en un grupo que se puede utilizar para abrir un cuadro de diálogo.

Espacio de nombres: Microsoft.Office.Tools.Ribbon
Ensamblado: Microsoft.Office.Tools.Common (en Microsoft.Office.Tools.Common.dll)

Sintaxis

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

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

El tipo RibbonDialogLauncher expone los siguientes miembros.

Propiedades

	Nombre	Descripción
	Enabled	Obtiene o establece un valor que indica si este objeto RibbonDialogLauncher está habilitado.
	Image	Obtiene o establece una imagen que aparece en este objeto RibbonDialogLauncher cuando se agrega a la barra de herramientas de acceso rápido.
	ImageName	Obtiene o establece un identificador que se utiliza para asignar una imagen a este objeto RibbonDialogLauncher cuando se agrega a la barra de herramientas de acceso rápido.
	KeyTip	Obtiene o establece el método abreviado de teclado para este objeto RibbonDialogLauncher.
	OfficeImageId	Obtiene o establece la imagen que se va a mostrar en este objeto RibbonDialogLauncher si desea utilizar un icono integrado de Microsoft Office.
	Parent	Obtiene un objeto RibbonGroup del que es miembro este objeto RibbonDialogLauncher.
	Ribbon	Obtiene el objeto OfficeRibbon donde se encuentra este objeto RibbonDialogLauncher.
	ScreenTip	Obtiene o establece el texto de la información en pantalla que aparece cuando el usuario mueve el puntero sobre el objeto RibbonDialogLauncher.
	SuperTip	Obtiene o establece el texto de varias líneas de la información sobre herramientas que aparece cuando el usuario mueve el puntero sobre el objeto RibbonDialogLauncher.
	Visible	Obtiene o establece un valor que indica si este objeto RibbonDialogLauncher está visible.

Arriba

Métodos

	Nombre	Descripción
	Dispose	Realiza tareas definidas por la aplicación asociadas a la liberación o al restablecimiento de recursos no administrados. (Se hereda de IDisposable).
	ResumeLayout	Invierte el efecto del método SuspendLayout.
	SuspendLayout	Evita que la aplicación de Microsoft Office actualice el estado de los controles de OfficeRibbon.

Arriba

Comentarios

RibbonDialogLauncher se muestra de forma predeterminada en la esquina inferior derecha de un grupo.

Las propiedades Image, ImageName y OfficeImageId no tienen efectos visibles cuando se muestra RibbonDialogLauncher en un grupo de la cinta de opciones. Sin embargo, cuando el usuario agrega un objeto RibbonDialogLauncher a la barra de herramientas de acceso rápido, estas propiedades controlan el comportamiento de la imagen mostrada. Además, la propiedad Visible no oculta RibbonDialogLauncher cuando se muestra en la barra de herramientas de acceso rápido. El usuario puede agregar el RibbonDialogLauncher a la barra de herramientas de acceso rápido a través del elemento (XML) de la cinta de opciones. Para obtener más información, vea Información general sobre la cinta de opciones.

RibbonDialogLauncher se aplica únicamente a un objeto RibbonGroup. El objeto RibbonGroup tiene un miembro DialogLauncher del tipo RibbonDialogLauncher. Para obtener información sobre cómo agregar un objeto RibbonDialogLauncher a una colección RibbonGroup, vea Cómo: Agregar un selector de cuadro de diálogo a un grupo de la cinta de opciones.

Puede crear un RibbonDialogLauncher en tiempo de ejecución utilizando el método CreateRibbonDialogLauncher del objeto RibbonFactory.

Existen dos maneras de obtener acceso al objeto RibbonFactory:

Mediante la propiedad Factory de la clase Ribbon. Utilice este enfoque para código en la clase Ribbon.
Mediante el método Globals.Factory.GetRibbonFactory. Utilice este enfoque para código fuera de la clase Ribbon.

Algunas propiedades de este control sólo se pueden establecer antes de que se cargue la cinta de opciones en la aplicación de Office. Para obtener información sobre cómo establecer estas propiedades, vea Información general sobre el modelo de objetos para la cinta de opciones.

Nota

Esta interfaz está implementada por el motor en tiempo de ejecución de Visual Studio Tools para Office. No está prevista su implementación en el código. Para obtener más información, vea Información general sobre el Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office.

Uso

Esta documentación describe la versión de este tipo que se utiliza en los proyectos de Office destinados a .NET Framework 4. En los proyectos destinados a .NET Framework 3.5, este tipo puede tener miembros diferentes y es posible que los ejemplos de código proporcionados para dicho tipo no funcionen. Para informarse sobre este tipo en los proyectos destinados a .NET Framework 3.5, vea la siguiente sección de referencia en la documentación de Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Ejemplos

En el ejemplo siguiente se muestra cómo agregar un RibbonDialogLauncher a un grupo de cinta de opciones y cómo iniciar un cuadro de diálogo personalizado que permita a los usuarios elegir la configuración avanzada cuando hacen clic en el icono RibbonDialogLauncher de la esquina inferior derecha de RibbonGroup.

Para poder ejecutar este ejemplo de código, primero debe seguir este procedimiento:

Agregue un elemento Cinta (diseñador visual) a un proyecto de Office.
Agregue un RibbonDialogLauncher al Group1 del grupo predeterminado tal y como se describe en Cómo: Agregar un selector de cuadro de diálogo a un grupo de la cinta de opciones.
Si está utilizando Visual Basic, agregue un nuevo elemento Cuadro de diálogo al proyecto. Si está utilizando C#, agregue un nuevo elemento de formularios Windows Forms y conviértalo en un cuadro de diálogo agregando un botón Aceptar y un botón Cancelar al formulario y creando los controladores de eventos para los eventos de clic de los botones.
Establezca la propiedad (Name) del cuadro de diálogo en advancedSettingsDialog. Puede personalizar el cuadro de diálogo agregando los controles y estableciendo más propiedades.
Agregue el controlador de eventos DialogLauncherClick al código.
Coloque el contenido del método siguiente en el controlador de eventos DialogLauncherClick.

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();
}