RibbonButton Interfaz

Definición

Espacio de nombres:

Microsoft.Office.Tools.Ribbon

Ensamblado:

Microsoft.Office.Tools.Common.dll

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

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

[System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")>]
type RibbonButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonButton
Implements IComponent, IDisposable, RibbonControl

Atributos

GuidAttribute

Implementaciones

RibbonComponent RibbonControl IComponent IDisposable

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 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 creado mediante herramientas de desarrollo de Office en Visual Studio.

2. Agregue un grupo a la pestaña 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 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);

}

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

Comentarios

Visual Studio crea una instancia de una clase que implementa la RibbonButton interfaz al arrastrar un control Button desde la pestaña Controles de cinta de Office del Cuadro de herramientas a la Designer 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 Dynamic propiedad en true.

Algunas propiedades de este control solo se pueden establecer 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 información sobre cómo establecer estas propiedades, vea Información general sobre el modelo de objetos de la cinta de opciones.

Puede crear un RibbonButton objeto en tiempo de ejecución mediante el CreateRibbonButton 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.

Tarea	Miembro
En tiempo de ejecución, agregue un botón a un menú que tenga su Dynamic propiedad establecida en true.	Cree una instancia de una clase que implemente la RibbonButton interfaz mediante . CreateRibbonButton método de la RibbonFactory clase . Para obtener más información, vea Acceso global a objetos en proyectos de Office. Agregue la instancia a la colección del Items 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.
Muestra una imagen en el botón.	Hay tres maneras de mostrar una imagen: - Use la Image propiedad . Esta propiedad proporciona el máximo control. - Establézcalo OfficeImageId en el identificador de una imagen integrada de Microsoft Office que desea mostrar como el icono del botón. - Use la ImageName propiedad junto con el LoadImage evento . Esta propiedad ofrece algunas ventajas de rendimiento.
Deshabilite u oculte botones.	Para deshabilitar un botón, establezca en Enabledfalse. Para ocultar un botón, establezca en Visiblefalse.
Ejecute código cuando un usuario haga clic en el botón.	Agregue código al controlador de Click eventos.

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 botón.
Description	Obtiene o establece el texto que aparece en este botón en un menú cuando la ItemSize propiedad del menú se establece en Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
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 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. (Heredado 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. (Heredado 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. (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 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.
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. (Heredado de RibbonComponent)
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

Click

Se produce cuando el usuario hace clic en el botón.