RibbonButton (Interfaz)

Representa un botón en una cinta de opciones personalizada.

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

Sintaxis

'Declaración
<GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")> _
Public Interface RibbonButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

El tipo RibbonButton expone los siguientes miembros.

Propiedades

	Nombre	Descripción
	ControlSize	Obtiene o establece el tamaño del botón.
	Description	Obtiene o establece el texto que aparece en este botón en un menú cuando la propiedad ItemSize del menú está establecida en Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
	Enabled	Obtiene o establece un valor que indica si este objeto RibbonControl está habilitado. (Se hereda de RibbonControl).
	Id	Obtiene una cadena que Microsoft Office usa para identificar este objeto RibbonControl. (Se hereda de RibbonControl).
	Image	Obtiene o establece la imagen que se muestra en el botón.
	ImageName	Obtiene o establece el nombre que se puede usar para identificar el botón en el controlador de eventos LoadImage.
	KeyTip	Obtiene o establece el método abreviado de teclado del botón.
	Label	Obtiene o establece el texto que se muestra en el botón.
	Name	Obtiene o establece el nombre de este objeto RibbonComponent. (Se hereda de RibbonComponent).
	OfficeImageId	Obtiene o establece la imagen que se va a mostrar en el botón si desea utilizar un icono integrado de Microsoft Office.
	Parent	Obtiene un objeto RibbonComponent que representa el elemento primario de este objeto RibbonComponent. (Se hereda de RibbonComponent).
	Position	Obtiene o establece la posición del botón si está en el menú de Microsoft Office.
	Ribbon	Obtiene el objeto Ribbon de nivel superior que contiene la jerarquía de controles. (Se hereda de RibbonComponent).
	RibbonUI	Infraestructura. Obtiene la instancia de IRibbonUI que la aplicación de Microsoft Office proporciona al código de extensibilidad de la cinta. (Se hereda de RibbonComponent).
	ScreenTip	Obtiene o establece el texto de información sobre herramientas que aparece cuando el usuario mueve el puntero sobre el botón.
	ShowImage	Obtiene o establece un valor que indica si está visible la imagen asociada al botón.
	ShowLabel	Obtiene o establece un valor que indica si está visible la etiqueta del botón.
	Site	Obtiene o establece el ISite asociado a IComponent. (Se hereda de IComponent).
	SuperTip	Obtiene o establece el texto informativo de varias líneas que aparece cuando el usuario mueve el puntero sobre el botón.
	Tag	Obtiene o establece los datos específicos de la aplicación que están asociados a este objeto RibbonComponent. (Se hereda de RibbonComponent).
	Visible	Obtiene o establece un valor que indica si este objeto RibbonControl está visible. (Se hereda de RibbonControl).

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).
	PerformDynamicLayout	Llama al método Microsoft.Office.Core.IRibbonUI.InvalidateControl del control principal si RibbonComponent tiene un elemento primario dinámico, como un menú dinámico, y no se suspende el diseño. (Se hereda de RibbonComponent).
	PerformLayout	Llama a Microsoft.Office.Core.IRibbonUI.InvalidateControl si el objeto RibbonComponent tiene un elemento primario y no se ha suspendido el diseño. (Se hereda de RibbonComponent).
	ResumeLayout()	Invierte el efecto del método SuspendLayout. (Se hereda de RibbonComponent).
	ResumeLayout(Boolean)	Invierte el efecto del método SuspendLayout. (Se hereda de RibbonComponent).
	SuspendLayout	Evita que la aplicación de Microsoft Office actualice el estado de los controles de la cinta de opciones. (Se hereda de RibbonComponent).

Arriba

Eventos

	Nombre	Descripción
	Click	Se produce cuando el usuario hace clic en el botón.
	Disposed	Representa el método que controla el evento Disposed de un componente. (Se hereda de IComponent).

Arriba

Comentarios

Visual Studio crea una instancia de una clase que implementa la interfaz RibbonButton cuando se arrastra un control de botón de la pestaña Controles de la cinta de opciones de Office del Cuadro de herramientas al diseñador de la cinta de opciones.

También puede crear una instancia de este control en tiempo de ejecución y agregarla a un menú dinámico.Un menú es dinámico si establece su propiedad Dynamic en true.

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 o antes de que se agregue el control a un menú dinámico en tiempo de ejecución.Para obtener información sobre cómo establecer estas propiedades, vea Información general sobre el modelo de objetos para la cinta de opciones.

Puede crear un RibbonButton en tiempo de ejecución utilizando el método CreateRibbonButton 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.

Tareas comunes

En la tabla siguiente se muestran los miembros que son útiles para las tareas comunes.

Tarea	Miembro
En tiempo de ejecución, agregue un botón a un menú cuya propiedad Dynamic esté establecida en true.	Cree una instancia de una clase que implementa la interfaz RibbonButton usando CreateRibbonButton método RibbonFactory de la clase.Para obtener más información, vea Acceso global a objetos en los proyectos de Office. Agregue la instancia a la colección Items del menú.
Cambie el tamaño del botón.	Establezca ControlSize en el valor que desee.Por ejemplo, para un botón grande, establézcalo en Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Muestre una imagen en el botón.	Existen tres maneras de mostrar una imagen: Utilice la propiedad Image.Ésta es la propiedad que proporciona el mayor control. Establezca OfficeImageId en el Id. de una imagen de Microsoft Office integrada que desea mostrar como icono para el botón. Use la propiedad ImageName junto con el evento LoadImage.Esta propiedad proporciona algunas ventajas de rendimiento.
Deshabilite u oculte los botones.	Para deshabilitar un botón, establezca Enabled en false. Para ocultar un botón, establezca Visible en false.
Ejecute el código cuando un usuario haga clic en el botón.	Agregue código al controlador de eventos Click.

[!NOTA]

Esta interfaz está implementada por el Runtime de Microsoft 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

En esta documentación se describe la versión de este tipo que se usa en los proyectos de Office destinados a .NET Framework 4 y .NET Framework 4.5. En los proyectos destinados a .NET Framework 3.5, este tipo podría tener unos miembros diferentes y los ejemplos de código de este tipo podrían no funcionar. 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 crea un nuevo botón, se establecen varias propiedades del botón y, a continuación, se agrega el botón a un menú.Para poder ejecutar este ejemplo de código, primero debe seguir este procedimiento:

1. Agregue un elemento Cinta (diseñador visual) a un proyecto creado mediante las herramientas de desarrollo de Office en Visual Studio.

2. Agregue un grupo a la ficha personalizada.

3. Agregue un menú al grupo.

4. Establezca la propiedad Dynamic del menú en true.

5. Establezca la propiedad ItemSize del menú en RibbonControlSizeLarge.

Private Sub AddButtonsToMenu()
    Dim tempButton = Me.Factory.CreateRibbonButton()
    tempButton.Label = "Button 1"
    tempButton.ControlSize = _
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge
    tempButton.Description = "My Ribbon Button"
    tempButton.ShowImage = True
    tempButton.ShowImage = True
    tempButton.Image = My.Resources.Image1
    tempButton.Image = My.Resources.Image2
    tempButton.KeyTip = "A1"
    menu1.Items.Add(tempButton)
End Sub

private void AddButtonsToMenu()
{
    RibbonButton tempButton = this.Factory.CreateRibbonButton();
    tempButton.Label = "Button 1";
    tempButton.ControlSize =
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge;
    tempButton.Description = "My Ribbon Button";
    tempButton.ShowImage = true;
    tempButton.ShowImage = true;
    tempButton.Image = Properties.Resources.Image1;
    tempButton.Image = Properties.Resources.Image2;
    tempButton.KeyTip = "A1";
    menu1.Items.Add(tempButton);

}

Vea también

Referencia

Microsoft.Office.Tools.Ribbon (Espacio de nombres)

RibbonMenu

RibbonButton

Otros recursos

Información general sobre la cinta de opciones

Diseñador de la cinta de opciones

Información general sobre el modelo de objetos para la cinta de opciones

Cómo: Iniciarse en la personalización de la cinta de opciones