Objetos (modelo de complemento de Visual Basic)

Addin

El objeto AddIn proporciona información sobre un complemento para otros complementos.

Sintaxis

objeto . Addin

Comentarios

Se crea un objeto AddIn para cada complemento que aparece en el Administrador de complementos.

CodeModule

Representa el código que hay tras un componente como, por ejemplo, un formulario, clase odocumento.

Comentarios

Puede usar el objeto CodeModule para modificar (agregar, eliminar o cambiar) el código asociado a un componente. Cada componente está asociado a un objeto CodeModule. No obstante, un objeto CodeModule puede estar asociado a varios paneles de código.

Los métodos asociados al objeto CodeModule permiten manipular y devolver información sobre el texto del código línea a línea. Por ejemplo, puede usar el método AddFromString para agregar texto al módulo. AddFromString coloca el texto justo encima del primer procedimiento del módulo o lo coloca al final del módulo si no hay procedimientos.

Utilice la propiedad Parent para devolver el objeto VBComponent asociado a un módulo de código.

CodePane

Representa un panel de código.

Comentarios

Use el objeto CodePane para manipular la posición de texto visible o la selección de texto que se muestra en el panel de código.

Use el método Show para que el panel de código que especifique sea visible.

Use el método SetSelection para establecer la selección en un panel de código.

Use el método GetSelection para devolver la ubicación de la selección en un panel de código.

CommandBar

El objeto CommandBar contiene otros objetos CommandBar que pueden actuar como botones o como comandos de menú.

Sintaxis

CommandBar

CommandBarEvents

Devuelto por la propiedad CommandBarEvents . El objeto CommandBarEvents desencadena un evento cuando se hace clic en un control de la barra de comandos.

Comentarios

La propiedad CommandBarEvents del objeto Events devuelve el objeto CommandBarEvents.

El objeto que se devuelve tiene un evento en su interfaz, el evento Click . Puede controlar este evento mediante la declaración de objeto WithEvents .

Eventos

Proporciona propiedades que habilitan los complementos para conectarse a todos los eventos de Visual Basic para Aplicaciones.

Comentarios

El objeto Events proporciona propiedades que devuelven objetos de origen de eventos. Use las propiedades para devolver objetos de origen de eventos que le notifican cambios en el entorno de Visual Basic para Aplicaciones.

Las propiedades del objeto Events devuelven objetos del mismo tipo que el nombre de propiedad. Por ejemplo, la propiedad CommandBarEvents devuelve el objeto CommandBarEvents.

Propiedad

Representa las propiedades de un objeto que están visibles en la ventana Propiedades de un componente determinado.

Comentarios

Utilice la propiedad Value del objeto Property para devolver o establecer el valor de una propiedad de un componente.

Como mínimo, todos los componentes tienen una propiedad Name . La propiedad Value devuelve un variable de Variant del tipo apropiado. Si el valor devuelto es un objeto, la propiedad Value devuelve la colección Properties que contiene objetos Property que representan las propiedades individuales del objeto. Puede tener acceso a cada uno de los objetos Property mediante el método Item de la colección Properties devuelta.

Si el valor devuelto por el objeto Property es un objeto, puede usar la propiedad Object para establecer el objeto Property en un objeto nuevo.

Referencia

Representa una referencia a una biblioteca de tipos o a un proyecto.

Comentarios

Use el objeto Reference para comprobar si una referencia sigue siendo válida.

La propiedad IsBroken devuelve True si la referencia ya no apunta a una referencia válida.

La propiedad BuiltIn devuelve True si la referencia es una referencia predeterminada que no se puede mover ni quitar.

Utilice la propiedad Name para determinar si la referencia que desea agregar o quitar es la correcta.

Consulte también las propiedades Description y Type .

ReferencesEvents

Devuelto por la propiedad ReferencesEvents .

Comentarios

El objeto ReferencesEvents es el origen de los eventos que se producen cuando se agrega o se quita una referencia de un proyecto.

El evento ItemAdded se desencadena después de agregar una referencia a un proyecto.

El evento ItemRemoved se desencadena después de quitar una referencia de un proyecto.

VBComponent

Representa un componente como, por ejemplo, un módulo de clase o módulo estándar, contenido en un proyecto.

Comentarios

Use el objeto VBComponent para acceder al objeto CodeModule asociado a un componente o para cambiar la configuración de propiedad de un componente.

Utilice la propiedad Type para averiguar a qué tipo de componente hace referencia el objeto VBComponent .

Use la propiedad Collection para averiguar en qué colección se encuentra el componente.

VBE

El objeto raíz que contiene todos los demás objetos y colecciones que se representan en Visual Basic para Aplicaciones.

Comentarios

Use las siguientes colecciones para tener acceso a los objetos contenidos en el objeto VBE :

• Use la colección VBProjects para obtener acceso a la colección de proyectos.

• Use la colección AddIns para obtener acceso a la colección de complementos.

• Use la colección Windows para obtener acceso a la colección de ventanas.

• Use la colección CodePanes para obtener acceso a la colección de paneles de código.

• Use la colección CommandBars para obtener acceso a la colección de barras de comandos.

Use el objeto Events para obtener acceso a las propiedades que permiten que los complementos se conecten a todos los eventos de Visual Basic para Aplicaciones. Las propiedades del objeto Events devuelven objetos del mismo tipo que el nombre de propiedad. Por ejemplo, la propiedad CommandBarEvents devuelve el objeto CommandBarEvents.

Use la propiedad SelectedVBComponent para devolver el componente activo. El componente activo es el componente del que se realiza un seguimiento en la ventana Project. Si el elemento seleccionado en la ventana Proyecto no es un componente, SelectedVBComponent devuelve Nothing.

Nota:

Todos los objetos de este modelo de objetos tienen una propiedad VBE que apunta al objeto VBE .

VBProject

Representa un proyecto.

Comentarios

Use el objeto VBProject para establecer las propiedades del proyecto y para tener acceso a las colecciones VBComponents y References .

Window

Representa una ventana en el entorno de desarrollo.

Comentarios

Use el objeto Window para mostrar, ocultar o colocar ventanas.

Importante

[!IMPORTANTE] Los objetos, las propiedades y los métodos para controlar ventanas vinculadas, los marcos de ventanas vinculados y las ventanas acopladas se incluyen en Macintosh para compatibilidad con código escrito en Windows. Sin embargo, estos elementos de lenguaje generarán errores en tiempo de ejecución al ejecutarse en Macintosh.

Use el método Close para cerrar una ventana de la colección de Windows . El método Close afecta a diferentes tipos de ventanas de la siguiente manera:

Window	Resultado de usar el método Close
Ventana de código	Quita la ventana de la colección de Windows.
Designer	Quita la ventana de la colección de Windows.
Objetos de Window del tipo marco de ventana vinculado	Las ventanas se convierten en ventanas independientes no vinculadas.

Nota:

[!NOTA] El uso del método Close con diseñadores y ventanas de código cierra realmente la ventana. Al establecer la propiedad Visible en False , se oculta la ventana, pero no se cierra la ventana. El uso del método Close con ventanas de entorno de desarrollo, como la ventana de proyecto o la ventana de propiedades, es la misma que el ajuste de la propiedad Visible en False.

Use el método SetFocus para mover el foco a una ventana.

Use la propiedad Visible para devolver o establecer la visibilidad de una ventana.

Para averiguar con qué tipo de ventana está trabajando, puede usar la propiedad Type . Si tiene más de una ventana de un tipo, por ejemplo, varios diseñadores, puede usar la propiedad Caption para determinar la ventana con la que está trabajando.

También puede encontrar la ventana con la que desea trabajar mediante la propiedad DesignerWindow del objeto VBComponent o la propiedad Window del objeto CodePane .

Consulte también

• Objetos (Microsoft Forms)
• Objetos y colecciones (Visual Basic para Aplicaciones)
• Referencia del modelo de complemento de Visual Basic
• Referencia del lenguaje de Visual Basic
• Referencia de desarrollo del cliente de Office

Soporte técnico y comentarios

¿Tiene preguntas o comentarios sobre VBA para Office o esta documentación? Vea Soporte técnico y comentarios sobre VBA para Office para obtener ayuda sobre las formas en las que puede recibir soporte técnico y enviar comentarios.