RibbonEditBox (Interfaz)

Artículo
08/10/2011

Representa un cuadro de edición de 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("14396b39-63c4-4fc2-92fe-cbccdbe5f306")> _
Public Interface RibbonEditBox _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("14396b39-63c4-4fc2-92fe-cbccdbe5f306")]
public interface RibbonEditBox : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

El tipo RibbonEditBox expone los siguientes miembros.

Propiedades

	Nombre	Descripción
	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 cuadro de edición.
	ImageName	Obtiene o establece el nombre que se puede utilizar para identificar la imagen en el controlador de eventos LoadImage.
	KeyTip	Obtiene o establece el método abreviado de teclado para este objeto RibbonEditBox.
	Label	Obtiene o establece el texto que aparece en este control RibbonEditBox.
	MaxLength	Obtiene o establece un valor que indica el número de caracteres máximo permitido por entrada en este control RibbonEditBox.
	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 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. (Se hereda de RibbonComponent).
	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 objeto RibbonEditBox.
	ShowImage	Obtiene o establece un valor que indica si está visible la imagen asociada al control RibbonEditBox.
	ShowLabel	Obtiene o establece un valor que indica si está visible la etiqueta de este control RibbonEditBox.
	Site	Obtiene o establece la interfaz ISite asociada a la interfaz IComponent. (Se hereda de IComponent).
	SizeString	Obtiene o establece una cadena que determina el tamaño de RibbonEditBox.
	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 objeto RibbonEditBox.
	Tag	Obtiene o establece los datos específicos de la aplicación que están asociados a este objeto RibbonComponent. (Se hereda de RibbonComponent).
	Text	Obtiene o establece el texto que aparece en este control RibbonEditBox cuando el cuadro de edición aparece por primera vez.
	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
	Disposed	Representa el método que controla el evento Disposed de un componente. (Se hereda de IComponent).
	TextChanged	Se produce cuando el usuario cambia el texto de RibbonEditBox.

Arriba

Comentarios

El control RibbonEditBox muestra un cuadro con etiqueta donde los usuarios pueden escribir y modificar el texto.

Visual Studio crea un objeto RibbonEditBox cuando se arrastra un control EditBox desde la pestaña Controles de la cinta de opciones de Office del Cuadro de herramientas hasta el diseñador de la cinta de opciones.

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

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. Para obtener información sobre cómo establecer estas propiedades, vea Información general sobre el modelo de objetos para la cinta de opciones.

Nota

Esta interfaz está implementada por el motor en tiempo de ejecución de 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

Esta documentación describe la versión de este tipo que se utiliza en los proyectos de Office destinados a .NET Framework 4. En los proyectos destinados a .NET Framework 3.5, este tipo puede tener miembros diferentes y es posible que los ejemplos de código proporcionados para dicho tipo no funcionen. 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.