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

Artículo
08/10/2011

Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office expone un modelo de objetos fuertemente tipado que se puede utilizar para obtener y establecer las propiedades de los controles de la cinta de opciones en tiempo de ejecución. Por ejemplo, puede rellenar controles de menú de forma dinámica o bien mostrar y ocultar controles contextualmente. También puede agregar fichas, grupos y controles a una cinta de opciones, pero solo antes de que la aplicación de Office cargue dicha cinta. Para obtener información, vea Establecer propiedades que pasan a ser de solo lectura.

Se aplica a: la información de este tema se aplica a los proyectos de nivel de documento y los proyectos de nivel de aplicación para las siguientes aplicaciones: Excel 2007 y Excel 2010; InfoPath 2010; Outlook 2007 y Outlook 2010; PowerPoint 2007 y PowerPoint 2010; Project 2010; Visio 2010; Word 2007 y Word 2010. Para obtener más información, vea Características disponibles por aplicación y tipo de proyecto de Office.

Este modelo de objetos para la cinta de opciones se compone principalmente de la clase Ribbon, eventos Ribbon y clases de controles de la cinta de opciones.

Clase Ribbon

Al agregar un nuevo elemento Cinta (diseñador visual) a un proyecto, Visual Studio agrega una clase Ribbon al proyecto. Si el proyecto está destinado a .NET Framework 4, la clase Ribbon hereda de la clase RibbonBase. Si el proyecto está destinado a .NET Framework 3.5, la clase Ribbon hereda de la clase OfficeRibbon.

Esta clase aparece como clase parcial que se divide entre el archivo de código de la cinta de opciones y el archivo de código del diseñador de la cinta de opciones.

Eventos Ribbon

La clase Ribbon contiene los tres eventos siguientes:

Proyectos destinados a .NET Framework 4	Proyectos destinados a .NET Framework 3.5	Descripción
RibbonBase.Load	OfficeRibbon.Load	Se provoca cuando la aplicación de Office carga la personalización de la cinta de opciones. El controlador de eventos Load se agrega automáticamente al archivo de código de la cinta de opciones. Utilice este controlador de eventos para ejecutar código personalizado cuando se carga la cinta de opciones.
RibbonBase.LoadImage	OfficeRibbon.LoadImage	Permite almacenar en caché las imágenes de la personalización de la cinta de opciones al cargar dicha cinta. Puede obtener una ligera mejora del rendimiento si escribe código para almacenar en caché las imágenes de la cinta en este controlador de eventos. Para obtener más información, vea LoadImage.
RibbonBase.Close	OfficeRibbon.Close	Se provoca cuando la instancia de la cinta de opciones se cierra.

Controles de la cinta de opciones

El espacio de nombres Microsoft.Office.Tools.Ribbon contiene un tipo para cada control que aparece en el grupo Controles de la cinta de opciones de Office del Cuadro de herramientas.

En la tabla siguiente se muestra el tipo de cada control de la cinta de opciones. Para obtener una descripción de cada control, vea Información general sobre la cinta de opciones.

Nombre del control	Nombre de la clase
Box	RibbonBox
Button	RibbonButton
ButtonGroup	RibbonButtonGroup
CheckBox	RibbonCheckBox
ComboBox	RibbonComboBox
DropDown	RibbonDropDown
EditBox	RibbonEditBox
Gallery	RibbonGallery
Grupo	RibbonGroup
Label	RibbonLabel
Menu	RibbonMenu
Separator	RibbonSeparator
SplitButton	RibbonSplitButton
Tab	RibbonTab
ToggleButton	RibbonToggleButton

El espacio de nombres Microsoft.Office.Tools.Ribbon utiliza el prefijo "Ribbon" para estos tipos a fin de evitar conflictos con los nombres de clases de control del espacio de nombres System.Windows.Forms.

Al agregar un control al diseñador de la cinta de opciones, dicho diseñador declara la clase de ese control como un campo en el archivo de código del diseñador de la cinta de opciones.

Tareas comunes con las propiedades de los controles de la cinta de opciones

Cada control de la cinta de opciones contiene propiedades que se pueden usar para realizar varias tareas, como asignar una etiqueta a un control o mostrar y ocultar controles.

En algunos casos, las propiedades pasan a ser de solo lectura una vez cargada la cinta o tras agregar un control a un menú dinámico. Para obtener más información, vea Establecer propiedades que pasan a ser de solo lectura.

En la tabla siguiente se describen algunas de las tareas que se pueden realizar utilizando propiedades de los controles de la cinta de opciones.

En esta tarea:	Haga lo siguiente:
Ocultar o mostrar un control.	Utilice la propiedad Visible.
Habilitar o deshabilitar un control.	Utilice la propiedad Enabled.
Establecer el tamaño de un control.	Utilice la propiedad ControlSize.
Obtener la imagen que aparece en un control.	Utilice la propiedad Image.
Cambiar la etiqueta de un control.	Utilice la propiedad Label.
Agregar datos definidos por el usuario a un control.	Utilice la propiedad Tag.
Obtener los elementos de un control RibbonBox, RibbonDropDown, RibbonGallery o RibbonSplitButton.	Utilice la propiedad Items.
Agregar elementos a un control RibbonComboBox, RibbonDropDown o RibbonGallery.	Utilice la propiedad Items.
Agregar controles a RibbonMenu.	Utilice la propiedad Items. Para agregar controles a RibbonMenu una vez cargada la cinta de opciones en la aplicación de Office, debe establecer la propiedad Dynamic en true antes de que se cargue la cinta en dicha aplicación. Para obtener información, vea Establecer propiedades que pasan a ser de solo lectura.
Obtener el elemento seleccionado en RibbonComboBox, RibbonDropDown o RibbonGallery.	Utilice la propiedad SelectedItem. Para RibbonComboBox, utilice la propiedad Text.
Obtener los grupos de una RibbonTab.	Utilice la propiedad Groups.
Especificar el número de filas y columnas que aparecen en RibbonGallery.	Utilice las propiedades RowCount y ColumnCount.

Establecer propiedades que pasan a ser de solo lectura

Algunas propiedades solo se pueden establecer antes de que se cargue la cinta de opciones. Estas propiedades se establecen en tres lugares:

En la ventana Propiedades de Visual Studio.
En el constructor de la clase Ribbon.
En el método CreateRibbonExtensibilityObject de la clase ThisAddin, ThisWorkbook o ThisDocument del proyecto.

Los menús dinámicos presentan algunas excepciones. Puede crear nuevos controles, establecer sus propiedades y después agregarlas a un menú dinámico en tiempo de ejecución, incluso una vez cargada la cinta que contiene el menú.

Las propiedades de los controles que se agregan a un menú dinámico se pueden establecer en cualquier momento.

Para obtener más información, vea Propiedades que pasan a ser de solo lectura.

Establecer propiedades en el constructor de la cinta de opciones

Puede establecer las propiedades de un control de cinta de opciones en el constructor de la clase Ribbon. Este código debe aparecer después de la llamada al método InitializeComponent. En el ejemplo siguiente se agrega un nuevo botón a un grupo si la hora actual son las 17:00 Hora del Pacífico (UTC-8) o más tarde.

Para los proyectos destinados a .NET Framework 4, agregue el código siguiente:

<System.Diagnostics.DebuggerNonUserCode()> _
Public Sub New()
    MyBase.New(Globals.Factory.GetRibbonFactory())

    'This call is required by the Component Designer.
    InitializeComponent()
    Dim MyButton As Microsoft.Office.Tools.Ribbon.RibbonButton = _
        Me.Factory.CreateRibbonButton()
    MyButton.Label = "New Button"
    If System.DateTime.Now.Hour > 16 Then
        Group1.Items.Add(MyButton)
    End If

End Sub

public Ribbon1()
    : base(Globals.Factory.GetRibbonFactory())
{
    InitializeComponent();
    if (System.DateTime.Now.Hour > 16)
    {
        Microsoft.Office.Tools.Ribbon.RibbonButton button =
            this.Factory.CreateRibbonButton();
        button.Label = "New Button";
        group1.Items.Add(button);
    }
}

Para los proyectos destinados a .NET Framework 3.5, agregue el código siguiente:

<System.Diagnostics.DebuggerNonUserCode()> _
Public Sub New()
    MyBase.New()

    'This call is required by the Component Designer.
    InitializeComponent()
    If DateTime.Now.Hour > 16 Then
        Group1.Items.Add(New RibbonButton())
        CType(Group1.Items.Last(), RibbonButton).Label = "New Button"
    End If
End Sub

public Ribbon1()
{
    InitializeComponent();
    if (DateTime.Now.Hour > 16)
    {
        group1.Items.Add(new RibbonButton());
        ((RibbonButton)group1.Items.Last()).Label = "New Button";
    }

}

En proyectos de Visual C# actualizados de Visual Studio 2008, el constructor aparece en el archivo de código de la cinta de opciones.

En proyectos de Visual Basic o de Visual C# creados en Visual Studio 2010, el constructor aparece en el archivo de código del diseñador de la cinta de opciones. Este archivo se denomina suElementoDeCinta.Designer.cs o suElementoDeCinta.Designer.vb. Para ver este archivo en los proyectos de Visual Basic, primero debe hacer clic en el botón Mostrar todos los archivos en el Explorador de soluciones.

Establecer propiedades en el método CreateRibbonExtensibilityObject

Puede establecerlas propiedades de un control de la cinta de opciones al invalidar el método CreateRibbonExtensibilityObject en la clase ThisAddin, ThisWorkbook o ThisDocument del proyecto. Para obtener más información sobre el método CreateRibbonExtensibilityObject, vea Información general sobre la cinta de opciones.

En el ejemplo siguiente se establecen las propiedades de Ribbon en el método CreateRibbonExtensibilityObject de la clase ThisWorkbook de un proyecto de libro de Excel.

Para los proyectos destinados a .NET Framework 4, agregue el código siguiente:

Protected Overrides Function CreateRibbonExtensibilityObject() _
    As Microsoft.Office.Core.IRibbonExtensibility
    Dim myCondition As Boolean = True
    If myCondition = True Then
        Dim tempRibbon As New Ribbon1()
        tempRibbon.Tab1.ControlId.ControlIdType = _
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office
        tempRibbon.Tab1.ControlId.OfficeId = "TabHome"
        Return Globals.Factory.GetRibbonFactory.CreateRibbonManager _
            (New Microsoft.Office.Tools.Ribbon.IRibbonExtension() {tempRibbon})
    Else
        Dim tempRibbon As New Ribbon2()
        tempRibbon.Tab1.ControlId.ControlIdType = _
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office
        tempRibbon.Tab1.ControlId.OfficeId = "TabInsert"
        Return Globals.Factory.GetRibbonFactory.CreateRibbonManager _
            (New Microsoft.Office.Tools.Ribbon.IRibbonExtension() {tempRibbon})
    End If
End Function

protected override Microsoft.Office.Core.IRibbonExtensibility
    CreateRibbonExtensibilityObject()
{
    bool myCondition = false;
    if (myCondition == true)
    {
        Ribbon1 tempRibbon = new Ribbon1();
        tempRibbon.tab1.ControlId.ControlIdType =
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office;
        tempRibbon.tab1.ControlId.OfficeId = "TabHome";
        return Globals.Factory.GetRibbonFactory().CreateRibbonManager( 
            new Microsoft.Office.Tools.Ribbon.IRibbonExtension[]
             { tempRibbon });
    }
    else
    {
        Ribbon2 tempRibbon = new Ribbon2();
        tempRibbon.tab1.ControlId.ControlIdType =
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office;
        tempRibbon.tab1.ControlId.OfficeId = "TabInsert";
        return Globals.Factory.GetRibbonFactory().CreateRibbonManager(
                            new Microsoft.Office.Tools.Ribbon.IRibbonExtension[] { tempRibbon });
    }
}

Para los proyectos destinados a .NET Framework 3.5, agregue el código siguiente:

Protected Overrides Function CreateRibbonExtensibilityObject() _
    As Microsoft.Office.Core.IRibbonExtensibility
    Dim myCondition As Boolean = True
    If myCondition = True Then
        Dim tempRibbon As New Ribbon1()
        tempRibbon.Tab1.ControlId.ControlIdType = _
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office
        tempRibbon.Tab1.ControlId.OfficeId = "TabHome"
        Return New Microsoft.Office.Tools.Ribbon.RibbonManager _
            (New Microsoft.Office.Tools.Ribbon.OfficeRibbon() {tempRibbon})
    Else
        Dim tempRibbon As New Ribbon2()
        tempRibbon.Tab1.ControlId.ControlIdType = _
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office
        tempRibbon.Tab1.ControlId.OfficeId = "TabInsert"
        Return New Microsoft.Office.Tools.Ribbon.RibbonManager _
            (New Microsoft.Office.Tools.Ribbon.OfficeRibbon() {tempRibbon})
    End If
End Function

protected override Microsoft.Office.Core.IRibbonExtensibility
    CreateRibbonExtensibilityObject()
{
    bool myCondition = true;
    if (myCondition == true)
    {
        Ribbon1 tempRibbon = new Ribbon1();
        tempRibbon.tab1.ControlId.ControlIdType = 
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office;
        tempRibbon.tab1.ControlId.OfficeId = "TabHome";
        return new Microsoft.Office.Tools.Ribbon.RibbonManager(
            new Microsoft.Office.Tools.Ribbon.OfficeRibbon[] 
                { tempRibbon });
    }
    else
    {
        Ribbon2 tempRibbon = new Ribbon2();
        tempRibbon.tab1.ControlId.ControlIdType = 
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office;
        tempRibbon.tab1.ControlId.OfficeId = "TabInsert";
        return new Microsoft.Office.Tools.Ribbon.RibbonManager(
            new Microsoft.Office.Tools.Ribbon.OfficeRibbon[] 
                { tempRibbon });
    }
}

Propiedades que pasan a ser de solo lectura

En la tabla siguiente se muestran propiedades que solo se pueden establecer antes de que se cargue la cinta de opciones.

Nota

Es posible establecer en cualquier momento las propiedades de los controles de menús dinámicos. Esta tabla no se aplica en ese caso.

Propiedad	Clase de control de la cinta de opciones
BoxStyle	RibbonBox
ButtonType	RibbonSplitButton
ColumnCount	RibbonGallery
ControlId	RibbonTab
DialogLauncher	RibbonGroup
Dinámico	RibbonMenu
Global	OfficeRibbon
Groups	RibbonTab
ImageName	RibbonButton RibbonComboBox RibbonDialogLauncher RibbonDropDown RibbonEditBox RibbonGallery RibbonMenu RibbonSplitButton RibbonToggleButton
ItemSize	RibbonMenu RibbonSplitButton
MaxLength	RibbonComboBox RibbonEditBox
Name	RibbonComponent
Posición	RibbonButton RibbonCheckBox RibbonGallery RibbonGroup RibbonMenu RibbonSeparator RibbonSplitButton RibbonTab RibbonToggleButton
RibbonType	OfficeRibbon
RowCount	RibbonGallery
ShowItemImage	RibbonComboBox RibbonDropDown RibbonGallery
ShowItemLabel	RibbonDropDown RibbonGallery
ShowItemSelection	RibbonGallery
SizeString	RibbonComboBox RibbonDropDown RibbonEditBox
StartFromScratch	OfficeRibbon
Tabulaciones	OfficeRibbon
Título	RibbonSeparator

Establecer propiedades para las cintas de opciones que aparecen en inspectores de Outlook

Cada vez que un usuario abre un inspector en el que aparece la cinta de opciones, se crea una nueva instancia de la cinta. Sin embargo, puede establecer las propiedades que se enumeran en la tabla anterior antes de que se cree la primera instancia de la cinta de opciones. Una vez creada la primera instancia, estas propiedades pasan a ser de solo lectura porque la primera instancia define el archivo XML que utiliza Outlook para cargar la cinta.

Si tiene una lógica condicional que establece cualquiera de estas propiedades en un valor distinto cuando se crean otras instancias de la cinta, este código no tendrá ningún efecto.

Nota

Asegúrese de que la propiedad Name se establece para cada control que se agrega a una cinta de opciones de Outlook. Si agrega un control a una cinta de opciones de Outlook en tiempo de ejecución, debe establecer esta propiedad en el código. Si agrega un control a una cinta de opciones de Outlook en tiempo de diseño, la propiedad Name se establece automáticamente.

Eventos de controles de la cinta de opciones

Cada clase de control contiene uno o varios eventos. En la tabla siguiente se describen estos eventos.

Evento	Descripción
Click	Se produce al hacer clic en un control.
TextChanged	Se produce cuando se cambia el texto de un cuadro de edición o cuadro combinado.
ItemsLoading	Se produce cuando Office solicita la colección Items del control. Office almacena la colección Items en memoria caché hasta que el código cambia las propiedades del control o se llama al método IRibbonUI.InvalidateControl(String).
ButtonClick	Se produce al hacer clic en un botón de RibbonGallery o RibbonDropDown.
SelectionChanged	Se produce cuando cambia la selección de RibbonDropDown o RibbonGallery.
DialogLauncherClick	Se produce al hacer clic en el icono que inicia un cuadro de diálogo situado en la esquina inferior derecha de un grupo.

Los controladores de estos eventos tienen los dos parámetros siguientes.

Parámetro	Descripción
sender	Objeto Object que representa el control que provocó el evento.
e	Un objeto RibbonControlEventArgs que contiene un control Microsoft.Office.Core.IRibbonControl. Use este control para tener acceso a cualquier propiedad que no esté disponible en el modelo de objetos para la cinta de opciones que proporciona Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office.

Vea también