RibbonMenu Interfaz

Definición

Espacio de nombres:

Microsoft.Office.Tools.Ribbon

Ensamblado:

Microsoft.Office.Tools.Common.dll

Representa un menú de una pestaña de cinta de opciones o del menú de Microsoft Office.

public interface class RibbonMenu : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent

[System.Runtime.InteropServices.Guid("59dc7f42-aca2-484a-9622-1ee34a6cfd7d")]
public interface RibbonMenu : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("59dc7f42-aca2-484a-9622-1ee34a6cfd7d")>]
type RibbonMenu = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonMenu
Implements IComponent, IDisposable, RibbonControl

Atributos

GuidAttribute

Implementaciones

RibbonComponent RibbonControl IComponent IDisposable

Ejemplos

En el ejemplo siguiente se muestra cómo agregar y rellenar un submenú a un menú existente en tiempo de ejecución.

Para obtener un ejemplo más completo que actualiza los controles en tiempo de ejecución e implica obtener datos de la base de datos de ejemplo AdventureWorks mediante consultas de Language-Integrated (LINQ), vea Tutorial: Actualización de los controles en una cinta de opciones en tiempo de ejecución.

Para ejecutar este ejemplo de código, primero debe realizar los pasos siguientes:

1. Agregue un elemento de cinta de opciones (Visual Designer) a un proyecto de Office.

2. Agregue un grupo a la pestaña personalizada.

3. Agregue un menú al grupo.

4. Establezca la propiedad (Name) del menú en CustomerMenu.

5. Establezca la propiedad Label del menú en Clientes.

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

   De este modo, puede agregar y quitar controles del menú en tiempo de ejecución después de que se haya cargado la cinta de opciones en la aplicación de Office.

private void PopulateCustomerMenu()
{
    // Add two sub-menus to EmployeeMenu and populate each sub-menu
    // First sub-menu
    RibbonMenu subMenu1 = this.Factory.CreateRibbonMenu();
    subMenu1.Dynamic = true;
    subMenu1.Label = "A - M";
    subMenu1.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu1.Items.Last()).Label = "Hall, Don";
    subMenu1.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu1.Items.Last()).Label = "Valdez, Rachel";
    CustomerMenu.Items.Add(subMenu1);

    // Second sub-menu
    RibbonMenu subMenu2 = this.Factory.CreateRibbonMenu();
    subMenu2.Dynamic = true;
    subMenu2.Label = "N - Z";
    subMenu2.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu2.Items.Last()).Label = "Robinson, Alex";
    CustomerMenu.Items.Add(subMenu2);
}

Private Sub PopulateCustomerMenu()
    ' Add two sub-menus to EmployeeMenu and populate each sub-menu
    ' First sub-menu
    Dim subMenu1 As RibbonMenu = Me.Factory.CreateRibbonMenu()
    subMenu1.Dynamic = True
    subMenu1.Label = "A - M"
    subMenu1.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu1.Items.Last(), RibbonToggleButton).Label = "Hall, Don"
    subMenu1.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu1.Items.Last(), RibbonToggleButton).Label = "Valdez, Rachel"
    CustomerMenu.Items.Add(subMenu1)

    ' Second sub-menu
    Dim subMenu2 As RibbonMenu = Me.Factory.CreateRibbonMenu()
    subMenu2.Dynamic = True
    subMenu2.Label = "N - Z"
    subMenu2.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu2.Items.Last(), RibbonToggleButton).Label = "Robinson, Alex"
    CustomerMenu.Items.Add(subMenu2)

End Sub

Comentarios

Visual Studio crea un RibbonMenu objeto al arrastrar un control Menu desde la pestaña Controles de cinta de Office del Cuadro de herramientas hasta el Designer de cinta de opciones.

Puede crear un RibbonMenu objeto en tiempo de ejecución mediante el CreateRibbonMenu método del RibbonFactory objeto .

Hay dos maneras de acceder al objeto RibbonFactory:

• Mediante el uso de la propiedad Factory de la clase Ribbon. Use este enfoque desde el código en la clase Ribbon.

• Usando el método Globals.Factory.GetRibbonFactory. Use este enfoque desde el código externo a la clase Ribbon.

Tareas comunes

En la tabla siguiente se enumeran los miembros que son útiles para tareas comunes. Todas estas tareas se pueden realizar en tiempo de diseño. Algunas de estas tareas solo se pueden realizar en tiempo de ejecución antes de que la cinta de opciones se cargue en la aplicación de Office o antes de que el control se agregue a un menú dinámico en tiempo de ejecución. Para obtener más información, vea Información general sobre el modelo de objetos de la cinta de opciones.

Tarea	Miembro
Muestra una imagen en el menú.	Use la Image propiedad o ImageName . También puede reutilizar imágenes que aparecen en controles de cinta integrados. Para ello, establezca OfficeImageId en el identificador de una imagen integrada de Microsoft Office que desea mostrar como el icono del menú.
Cambie el tamaño del menú.	Establezca la ControlSize propiedad en el valor que desee. Por ejemplo, para un menú grande, establézcalo en Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Cambie el tamaño de los elementos en el menú.	Establezca la ItemSize propiedad en el valor que desee. Por ejemplo, para mostrar elementos más grandes, establézcalo en Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Habilite los cambios en el menú en tiempo de ejecución (por ejemplo, para habilitar los controles que se van a agregar al menú en tiempo de ejecución).	Establezca la propiedad Dynamic en true.
Acceda a los controles del menú, agregue controles al menú o quite controles del menú.	Utilice la propiedad Items.
Agregue un menú al menú de Microsoft Office, un grupo o a otro control que pueda contener menús.	Agregue un RibbonMenu elemento a la Items propiedad del menú, grupo o control de Microsoft Office.

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, consulta Visual Studio Tools for Office Runtime Overview.

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 o una versión posterior. 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, consulte la siguiente sección de referencia en la documentación de Visual Studio 2008: http://go.microsoft.com/fwlink/?LinkId=160658.

Propiedades

ControlSize	Obtiene o establece el tamaño del menú.
Description	Obtiene o establece el texto que aparece en el menú actual.
Dynamic	Obtiene o establece un valor que indica si el menú puede modificarse en tiempo de ejecución.
Enabled	Obtiene o establece un valor que indica si este objeto RibbonControl está habilitado. (Heredado de RibbonControl)
Id	Obtiene una cadena que Microsoft Office usa para identificar este objeto RibbonControl. (Heredado de RibbonControl)
Image	Obtiene o establece la imagen que se muestra en el menú.
ImageName	Obtiene o establece el nombre que puede usar en el controlador de eventos LoadImage para identificar una imagen del menú.
Items	Obtiene la colección de controles que se encuentran en el menú.
ItemSize	Obtiene o establece el tamaño de los controles del menú.
KeyTip	Obtiene o establece la tecla de acceso del teclado del menú.
Label	Obtiene o establece el texto que se muestra en el menú.
Name	Obtiene o establece el nombre de este objeto RibbonComponent. (Heredado de RibbonComponent)
OfficeImageId	Obtiene o establece la imagen que se va a mostrar en el menú si quiere usar un icono integrado de Microsoft Office.
Parent	Obtiene un objeto RibbonComponent que representa el elemento primario de este objeto RibbonComponent. (Heredado de RibbonComponent)
Position	Obtiene o establece la posición del menú si está en el menú de Microsoft Office.
Ribbon	Obtiene el objeto Ribbon de nivel superior que contiene la jerarquía de controles. (Heredado de RibbonComponent)
RibbonUI	Obtiene la instancia de IRibbonUI que la aplicación de Microsoft Office proporciona al código de extensibilidad de la cinta. (Heredado de RibbonComponent)
ScreenTip	Obtiene o establece el texto de la información en pantalla que aparece cuando el usuario mueve el puntero sobre el menú.
ShowImage	Obtiene o establece un valor que indica si está visible la imagen asociada al menú.
ShowLabel	Obtiene o establece un valor que indica si está visible la etiqueta del menú.
SuperTip	Obtiene o establece el texto informativo de varias líneas que aparece cuando el usuario mueve el puntero sobre el menú.
Tag	Obtiene o establece los datos específicos de la aplicación que están asociados a este objeto RibbonComponent. (Heredado de RibbonComponent)
Title	Obtiene o establece el título que se muestra cuando el usuario expande un menú que se agrega al menú de Microsoft Office.
Visible	Obtiene o establece un valor que indica si este objeto RibbonControl está visible. (Heredado de RibbonControl)

Métodos

PerformDynamicLayout()	Llama al método Microsoft.Office.Core.IRibbonUI.InvalidateControl del control primario si el objeto RibbonComponent tiene un elemento primario dinámico, como un menú dinámico, y no se suspende el diseño. (Heredado de RibbonComponent)
PerformLayout()	Llama al método Microsoft.Office.Core.IRibbonUI.InvalidateControl si RibbonComponent tiene un elemento primario y no se suspende el diseño. (Heredado de RibbonComponent)
ResumeLayout()	Invierte el efecto del método SuspendLayout(). (Heredado de RibbonComponent)
ResumeLayout(Boolean)	Invierte el efecto del método SuspendLayout(). (Heredado de RibbonComponent)
SuspendLayout()	Evita que la aplicación de Microsoft Office actualice el estado de los controles de la cinta de opciones. (Heredado de RibbonComponent)

Eventos

ItemsLoading

Se produce cuando los controles o los menús anidados se cargan en el menú actual en tiempo de ejecución.