RibbonCheckBox (Interfaz)

Artículo
05/15/2013

Representa un control de casilla 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("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")> _
Public Interface RibbonCheckBox _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")]
public interface RibbonCheckBox : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

El tipo RibbonCheckBox expone los siguientes miembros.

Propiedades

	Nombre	Descripción
	Checked	Obtiene o establece un valor que indica si este control RibbonCheckBox está activado.
	Description	Obtiene o establece una descripción para RibbonCheckBox que aparece cuando la propiedad ItemSize de su control primario está establecida en RibbonControlSizeLarge.
	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).
	KeyTip	Obtiene o establece el método abreviado de teclado para este objeto RibbonCheckBox.
	Label	Obtiene o establece el texto que aparece en este objeto RibbonCheckBox.
	Name	Obtiene o establece el nombre de este objeto RibbonComponent. (Se hereda de RibbonComponent).
	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 de la casilla 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 sugerencia que aparece cuando el usuario mueve el puntero sobre el objeto RibbonCheckBox.
	Site	Obtiene o establece el ISite asociado a IComponent. (Se hereda de IComponent).
	SuperTip	Obtiene o establece el texto informativo de varias líneas que aparece cuando el usuario mueve el puntero sobre el objeto RibbonCheckBox.
	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 un usuario hace clic en la casilla.
	Disposed	Representa el método que controla el evento Disposed de un componente. (Se hereda de IComponent).

Arriba

Comentarios

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.

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