Objetos (Visual Basic Add-In Model)

Addin

O objeto AddIn fornece informações sobre um suplemento para outros suplementos.

Sintaxe

objeto. Addin

Comentários

Um objeto AddIn é criado para cada suplemento que aparece no Gerenciador de Suplementos.

CodeModule

Representa o código por trás de um componente, como um formulário, classe ou documento.

Comentários

Você usa o objeto CodeModule para modificar (adicionar, excluir ou editar) o código associado a um componente. Cada componente está associado a um objeto CodeModule . No entanto, um objeto CodeModule pode ser associado a vários painéis de código.

Os métodos associados ao objeto CodeModule permitem manipular e retornar informações sobre o texto de código em linha por linha. Por exemplo, você pode usar o método AddFromString para adicionar texto ao módulo. AddFromString coloca o texto logo acima do primeiro procedimento no módulo ou coloca o texto no final do módulo se não houver procedimentos.

Use a propriedade Parent para retornar o objeto VBComponent associado a um módulo de código.

CodePane

Representa um painel de código.

Comentários

Use o objeto CodePane para manipular a posição do texto visível ou a seleção de texto exibida no painel de código.

Use o método Show para tornar o painel de código que você especificar visível.

Use o método SetSelection para definir a seleção em um painel de código.

Use o método GetSelection para retornar o local da seleção em um painel de código.

CommandBar

O objeto CommandBar contém outros objetos CommandBar , que podem atuar como botões ou comandos de menu.

Sintaxe

CommandBar

Commandbarevents

Retornado pela propriedade CommandBarEvents . O objeto CommandBarEvents dispara um evento quando um controle na barra de comandos é clicado.

Comentários

O objeto CommandBarEvents é retornado pela propriedade CommandBarEvents do objeto Events .

O objeto retornado tem um evento em sua interface, o evento Clique . Você pode lidar com esse evento usando a declaração de objeto WithEvents .

Eventos

Fornece propriedades que permitem que os suplementos se conectem a todos os eventos no Visual Basic for Applications.

Comentários

O objeto Events fornece propriedades que retornam objetos de origem do evento. Use as propriedades para retornar objetos de origem do evento que notificam você de alterações no ambiente Visual Basic for Applications.

As propriedades do objeto Events retornam objetos do mesmo tipo que o nome da propriedade. Por exemplo, a propriedade CommandBarEvents retorna o objeto CommandBarEvents.

Propriedade

Representa as propriedades de um objeto que estão visíveis no janela Propriedades para qualquer componente determinado.

Comentários

Use a propriedade Value do objeto Property para retornar ou definir o valor de uma propriedade de um componente.

No mínimo, todos os componentes têm uma propriedade Name . A propriedade Value retorna uma Variant do tipo apropriado. Se o valor retornado for um objeto, a propriedade Value retornará a coleção Propriedades que contém objetos Property que representam as propriedades individuais do objeto. Você pode acessar cada um dos objetos Property usando o método Item na coleção Propriedades retornadas.

Se o valor retornado pelo objeto Property for um objeto, você poderá usar a propriedade Object para definir o objeto Property como um novo objeto.

Referência

Representa uma referência a uma biblioteca de tipos ou a um projeto.

Comentários

Use o objeto Reference para verificar se uma referência ainda é válida.

A propriedade IsBroken retornará True se a referência não apontar mais para uma referência válida.

A propriedade BuiltIn retornará True se a referência for uma referência padrão que não pode ser movida ou removida.

Use a propriedade Name para determinar se a referência que você deseja adicionar ou remover é a correta.

Consulte também as propriedades Descrição e Tipo .

Referencesevents

Retornado pela propriedade ReferencesEvents .

Comentários

O objeto ReferencesEvents é a fonte de eventos que ocorrem quando uma referência é adicionada ou removida de um projeto.

O evento ItemAdded é disparado depois que uma referência é adicionada a um projeto.

O evento ItemRemoved é disparado depois que uma referência é removida de um projeto.

VBComponent

Representa um componente, como um módulo de classe ou um módulo padrão, contido em um projeto.

Comentários

Use o objeto VBComponent para acessar o objeto CodeModule associado a um componente ou para alterar as configurações de propriedade de um componente.

Use a propriedade Type para descobrir a que tipo de componente o objeto VBComponent se refere.

Use a propriedade Collection para descobrir em qual coleção o componente está.

VBE

O objeto raiz que contém todos os outros objetos e coleções representados em Visual Basic for Applications.

Comentários

Use as seguintes coleções para acessar os objetos contidos no objeto VBE :

• Use a coleção VBProjects para acessar a coleção de projetos.

• Use a coleção AddIns para acessar a coleção de suplementos.

• Use a coleção do Windows para acessar a coleção de janelas.

• Use a coleção CodePanes para acessar a coleção de painéis de código.

• Use a coleção CommandBars para acessar a coleção de barras de comando.

Use o objeto Eventos para acessar propriedades que permitem que os suplementos se conectem a todos os eventos no Visual Basic for Applications. As propriedades do objeto Events retornam objetos do mesmo tipo que o nome da propriedade. Por exemplo, a propriedade CommandBarEvents retorna o objeto CommandBarEvents.

Use a propriedade SelectedVBComponent para retornar o componente ativo. O componente ativo é o componente que está sendo rastreado na janela Projeto. Se o item selecionado na janela Projeto não for um componente, SelectedVBComponentretornará Nothing.

Observação

Todos os objetos neste modelo de objeto têm uma propriedade VBE que aponta para o objeto VBE .

VBProject

Representa um projeto.

Comentários

Use o objeto VBProject para definir propriedades para o projeto e para acessar as coleções VBComponents e References .

Janela

Representa uma janela no ambiente de desenvolvimento.

Comentários

Use o objeto Window para mostrar, ocultar ou posicionar janelas.

Importante

Objetos, propriedades e métodos para controlar janelas vinculadas, quadros de janela vinculados e janelas encaixadas estão incluídos no Macintosh para compatibilidade com o código escrito no Windows. No entanto, esses elementos de linguagem gerarão erros de tempo de execução quando executados no Macintosh.

Use o método Close para fechar uma janela na coleção do Windows . O método Close afeta diferentes tipos de janelas da seguinte maneira:

Janela	Resultado do uso do método Close
Janela de Código	Remove a janela da coleção do Windows .
Designer	Remove a janela da coleção do Windows .
Objetos de janela do tipo de quadro de janela vinculado	O Windows se torna janelas separadas desvinculadas.

Observação

Usar o método Fechar com janelas de código e designers realmente fecha a janela. Definir a propriedade Visible como False oculta a janela, mas não fecha a janela. Usar o método Fechar com janelas de ambiente de desenvolvimento, como a janela do Projeto ou janela Propriedades, é o mesmo que definir a propriedade Visible como False.

Use o método SetFocus para mover o foco para uma janela.

Use a propriedade Visible para retornar ou definir a visibilidade de uma janela.

Para descobrir com qual tipo de janela você está trabalhando, você pode usar a propriedade Type . Se você tiver mais de uma janela de um tipo, por exemplo, vários designers, poderá usar a propriedade Caption para determinar a janela com a qual está trabalhando.

Você também pode encontrar a janela com a qual deseja trabalhar usando a propriedade DesignerWindow do objeto VBComponent ou a propriedade Window do objeto CodePane .

Confira também

• Objetos (Microsoft Forms)
• Objetos e coleções (Visual Basic for Applications)
• Referência de modelo de suplemento do Visual Basic
• Referência de linguagem do Visual Basic
• Referência de desenvolvimento do cliente do Office

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.