ControlCollection (Interfaz)

Representa una colección de controles administrados en una hoja de cálculo de Excel en una solución de Office.

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

Sintaxis

'Declaración
<GuidAttribute("0B027FC3-018C-4917-AE33-A09E0A30A661")> _
Public Interface ControlCollection _
    Inherits IEnumerable
[GuidAttribute("0B027FC3-018C-4917-AE33-A09E0A30A661")]
public interface ControlCollection : IEnumerable

El tipo ControlCollection expone los siguientes miembros.

Propiedades

  Nombre Descripción
Propiedad pública Count Obtiene el número de controles de ControlCollection.
Propiedad pública Item[Int32] Obtiene el control que se encuentra en el índice especificado.
Propiedad pública Item[String] Obtiene el control con el nombre especificado.

Arriba

Métodos

  Nombre Descripción
Método público AddChart(Range, String) Agrega a la hoja de cálculo un nuevo control Chart en el rango especificado.
Método público AddChart(Double, Double, Double, Double, String) Agrega a la hoja de cálculo un nuevo control Chart con el tamaño y en la ubicación especificados.
Método público AddControl(Control, Range, String) Agrega el objeto Control especificado a ControlCollection en el rango especificado.
Método público AddControl(Control, Double, Double, Double, Double, String) Agrega el objeto Control especificado al objeto ControlCollection con la ubicación y el tamaño especificados.
Método público AddListObject(ListObject) Agrega una clase Microsoft.Office.Tools.Excel.ListObject de Visual Studio a la colección de controles basada en la clase nativa Microsoft.Office.Interop.Excel.ListObject especificada.
Método público AddListObject(Range, String) Agrega a la hoja de cálculo un nuevo control ListObject en el rango especificado.
Método público AddNamedRange Agrega a la hoja de cálculo un nuevo control NamedRange en el rango especificado.
Método público Contains(Object) Determina si el control especificado es un miembro de la instancia de ControlCollection.
Método público Contains(String) Determina si un control con el nombre especificado es miembro de la instancia de ControlCollection.
Método público GetEnumerator Devuelve un enumerador que recorre en iteración una colección. (Se hereda de IEnumerable).
Método público IndexOf(Object) Busca el control especificado y devuelve el índice de base cero de la primera aparición en la instancia de ControlCollection.
Método público IndexOf(String) Busca la primera aparición de un control con el nombre especificado en la instancia de ControlCollection.
Método público Remove(Object) Quita el control especificado de la instancia de ControlCollection.
Método público Remove(String) Quita el control con el nombre especificado de la instancia de ControlCollection.
Método público RemoveAt Quita el control en el índice especificado en la instancia de ControlCollection.

Arriba

Comentarios

Use los métodos y propiedades de la interfaz ControlCollection para administrar los controles en una hoja de cálculo de Excel. Para obtener más información, vea Agregar controles a documentos de Office en tiempo de ejecución.

No puede crear una instancia de esta interfaz en su código, porque no tiene ningún constructor público. Para obtener una instancia de esta interfaz en un proyecto de nivel de documento, use la propiedad Controls de una de las clases Sheetn en su proyecto. Para obtener una instancia de esta interfaz en un proyecto de nivel de documento, use la propiedad Controls de un elemento host Worksheet que puede crear mediante programación en tiempo de ejecución. Para obtener más información, vea Ampliar documentos de Word y libros de Excel en complementos en el nivel de la aplicación en tiempo de ejecución.

En la tabla siguiente se muestra cómo se utilizan los miembros de ControlCollection para realizar algunas tareas comunes relacionadas con los controles de los documentos.

Tarea

Acción

Agregar un control a la hoja de cálculo.

Use uno de los métodos Add<control>. Por ejemplo, para agregar un Microsoft.Office.Tools.Excel.ListObject, use el método AddListObject.

Quitar un control de la hoja de cálculo.

Utilice el método Remove.

Determina si un control se encuentra en la colección.

Pase el control o su nombre al método Contains.

Obtener el índice del control en la colección.

Pase el control o su nombre al método IndexOf.

Obtiene un control de la colección.

Pase el índice o el nombre del control a la propiedad Item.

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: http://go.microsoft.com/fwlink/?LinkId=160658.

Vea también

Referencia

Microsoft.Office.Tools.Excel (Espacio de nombres)