RibbonButton (Clase) (2007 System)

Artículo
09/04/2008

Actualización: noviembre 2007

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

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

Sintaxis

<ToolboxBitmapAttribute(GetType(RibbonButton), "RibbonButton.bmp")> _
Public NotInheritable Class RibbonButton _
    Inherits RibbonControl

Dim instance As RibbonButton

[ToolboxBitmapAttribute(typeof(RibbonButton), "RibbonButton.bmp")]
public sealed class RibbonButton : RibbonControl

Comentarios

Visual Studio Tools para Office crea una instancia de la clase RibbonButton cuando se arrastra un control Button de la ficha 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.

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 la clase RibbonButton mediante el constructor RibbonButton. 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.

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:

Agregue un elemento Cinta (diseñador visual) a un proyecto de Visual Studio Tools para Office.
Agregue un grupo a la ficha personalizada.
Agregue un menú al grupo.
Establezca la propiedad Dynamic del menú en true.
Establezca la propiedad ItemSize del menú en RibbonControlSizeLarge.

Private Sub AddButtonsToMenu()
    Dim tempButton As New RibbonButton()
    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 = new RibbonButton();
    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);

}

Jerarquía de herencia

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.Office.Tools.Ribbon.RibbonComponent
        Microsoft.Office.Tools.Ribbon.RibbonControl
          Microsoft.Office.Tools.Ribbon.RibbonButton

Seguridad para subprocesos

Todos los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.