Compartir a través de

ControlCollection (Interfaz)

  • Artículo

Representa una colección de controles administrados de un documento de Word que se ha personalizado usando las herramientas de desarrollo de Office incluidas en Visual Studio.

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

Sintaxis

'Declaración
<GuidAttribute("E1180F09-B903-4D03-8D30-2845219AEE2C")> _
Public Interface ControlCollection _
    Inherits IEnumerable

[GuidAttribute("E1180F09-B903-4D03-8D30-2845219AEE2C")]
public interface ControlCollection : IEnumerable

El tipo ControlCollection expone los siguientes miembros.

Propiedades

  Nombre Descripción
Propiedad pública Capacity Obtiene o establece el número de controles que ControlCollection puede contener.
Propiedad pública Count Obtiene el número de controles de ControlCollection.
Propiedad pública Item[Int32] Obtiene el control situado en el índice especificado.
Propiedad pública Item[Object] Obtiene el control especificado.
Propiedad pública Item[String] Obtiene el control con el nombre especificado.

Arriba

Métodos

  Nombre Descripción
Método público AddBookmark(Bookmark, String) Agrega un nuevo control Microsoft.Office.Tools.Word.Bookmark al documento en la ubicación del Microsoft.Office.Interop.Word.Bookmark existente especificado.
Método público AddBookmark(Range, String) Agrega un nuevo control Bookmark al documento en el intervalo especificado.
Método público AddBuildingBlockGalleryContentControl(String) Agrega un nuevo control BuildingBlockGalleryContentControl a la selección actual del documento.
Método público AddBuildingBlockGalleryContentControl(ContentControl, String) Agrega un nuevo objeto BuildingBlockGalleryContentControl a la colección.El nuevo control se basa en un control de contenido nativo que ya está en el documento.
Método público AddBuildingBlockGalleryContentControl(Range, String) Agrega un nuevo control BuildingBlockGalleryContentControl en el intervalo especificado del documento.
Método público AddComboBoxContentControl(String) Agrega un nuevo control ComboBoxContentControl a la selección actual del documento.
Método público AddComboBoxContentControl(ContentControl, String) Agrega un nuevo objeto ComboBoxContentControl a la colección.El nuevo control se basa en un control de contenido nativo que ya está en el documento.
Método público AddComboBoxContentControl(Range, String) Agrega un nuevo control ComboBoxContentControl en el intervalo especificado del documento.
Método público AddContentControl(ContentControl, String) Agrega un nuevo control ContentControl basado en un control de contenido nativo del documento.
Método público AddContentControl(String, WdContentControlType) Agrega un nuevo control ContentControl del tipo especificado en la selección actual del documento.
Método público AddContentControl(Range, String, WdContentControlType) Agrega un nuevo control ContentControl del tipo especificado en el intervalo establecido del documento.
Método público AddControl(Control, Range, Single, Single, String) Agrega el control especificado a la colección ControlCollection en el intervalo especificado y con el tamaño especificado.
Método público AddControl(Control, Single, Single, Single, Single, String) Agrega el control especificado a la colección ControlCollection en la ubicación especificada y con el tamaño especificado.
Método público AddDatePickerContentControl(String) Agrega un nuevo control DatePickerContentControl a la selección actual del documento.
Método público AddDatePickerContentControl(ContentControl, String) Agrega un nuevo objeto DatePickerContentControl a la colección.El nuevo control se basa en un control de contenido nativo que ya está en el documento.
Método público AddDatePickerContentControl(Range, String) Agrega un nuevo control DatePickerContentControl en el intervalo especificado del documento.
Método público AddDropDownListContentControl(String) Agrega un nuevo control DropDownListContentControl a la selección actual del documento.
Método público AddDropDownListContentControl(ContentControl, String) Agrega un nuevo objeto DropDownListContentControl a la colección.El nuevo control se basa en un control de contenido nativo que ya está en el documento.
Método público AddDropDownListContentControl(Range, String) Agrega un nuevo control DropDownListContentControl en el intervalo especificado del documento.
Método público AddGroupContentControl(String) Agrega un nuevo control GroupContentControl a la selección actual del documento.
Método público AddGroupContentControl(ContentControl, String) Agrega un nuevo control GroupContentControl basado en un control de contenido nativo del documento.
Método público AddGroupContentControl(Range, String) Agrega un nuevo control GroupContentControl en el intervalo especificado del documento.
Método público AddPictureContentControl(String) Agrega un nuevo control PictureContentControl a la selección actual del documento.
Método público AddPictureContentControl(ContentControl, String) Agrega un nuevo control PictureContentControl basado en un control de contenido nativo del documento.
Método público AddPictureContentControl(Range, String) Agrega un nuevo control PictureContentControl en el intervalo especificado del documento.
Método público AddPlainTextContentControl(String) Agrega un nuevo control PlainTextContentControl a la selección actual del documento.
Método público AddPlainTextContentControl(ContentControl, String) Agrega un nuevo control PlainTextContentControl basado en un control de contenido nativo del documento.
Método público AddPlainTextContentControl(Range, String) Agrega un nuevo control PlainTextContentControl en el intervalo especificado del documento.
Método público AddRichTextContentControl(String) Agrega un nuevo control RichTextContentControl a la selección actual del documento.
Método público AddRichTextContentControl(ContentControl, String) Agrega un nuevo control RichTextContentControl basado en un control de contenido nativo del documento.
Método público AddRichTextContentControl(Range, String) Agrega un nuevo control RichTextContentControl en el intervalo especificado del documento.
Método público Contains(Object) Determina si el control especificado es 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 GetInlineShapeForControl Obtiene el valor InlineShape subyacente para el control especificado.
Método público GetShapeForControl Obtiene el valor Shape subyacente para el control especificado.
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 especificado de la instancia de ControlCollection.
Método público RemoveAt Quita el control situado en el índice especificado de la instancia de ControlCollection.

Arriba

Comentarios

Use los métodos ControlCollection y propiedades para administrar controles en un documento de Word. Para obtener más información, vea Agregar controles a documentos de Office en tiempo de ejecución.

Para obtener un objeto ControlCollection en un proyecto de nivel de documento, use la propiedad Controls de la clase ThisDocument del proyecto. Para obtener un objeto ControlCollection en un proyecto de nivel de aplicación, use la propiedad Controls de un elemento host Document 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 al documento.

Use uno de los métodos AddControlName. Por ejemplo, para agregar un control de contenido, use el método AddContentControl.

Quitar un control del documento.

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

Vea también

Referencia

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

Otros recursos

Agregar controles a documentos de Office en tiempo de ejecución

Métodos auxiliares para controles host