RibbonToggleButton (Interfaz)

Artículo
05/15/2013

Representa un control de botón de alternancia en una cinta de opciones.

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

Sintaxis

'Declaración
<GuidAttribute("fc50977f-187c-4082-ab53-087e81f4ded1")> _
Public Interface RibbonToggleButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("fc50977f-187c-4082-ab53-087e81f4ded1")]
public interface RibbonToggleButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

El tipo RibbonToggleButton expone los siguientes miembros.

Propiedades

	Nombre	Descripción
	Checked	Obtiene o establece un valor que indica si el botón de alternancia está presionado o no.
	ControlSize	Obtiene o establece el tamaño del control RibbonToggleButton.
	Description	Obtiene o establece el texto que aparece en este control RibbonToggleButton de un menú.
	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 control.
	ImageName	Obtiene o establece el nombre que se puede usar en el controlador de eventos LoadImage para identificar una imagen del control.
	KeyTip	Obtiene o establece el método abreviado de teclado del botón de alternancia.
	Label	Obtiene o establece el texto que se muestra en el botón de alternancia.
	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 control RibbonToggleButton 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 control RibbonToggleButton 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 la información en pantalla que aparece cuando el usuario mueve el puntero sobre el botón de alternancia.
	ShowImage	Obtiene o establece un valor que indica si está visible la imagen asociada al control RibbonToggleButton.
	ShowLabel	Obtiene o establece un valor que indica si está visible la etiqueta del control RibbonToggleButton.
	Site	Obtiene o establece el ISite asociado a IComponent. (Se hereda de IComponent).
	SuperTip	Obtiene o establece el texto de varias líneas de la información sobre herramientas que aparece cuando el usuario mueve el puntero sobre el control RibbonToggleButton.
	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 control RibbonToggleButton.
	Disposed	Representa el método que controla el evento Disposed de un componente. (Se hereda de IComponent).

Arriba

Comentarios

RibbonToggleButton se puede utilizar para mostrar si un elemento está seleccionado.

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

[!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.