Escrevendo um procedimento de propriedade

Um procedimento de propriedade é uma série de Visual Basic que permitem que um programador crie e manipule propriedades personalizadas.

  • Os procedimentos de propriedade podem ser usados para criar propriedades somente leitura para formulários, módulos padrão e módulos de classe.

  • Os procedimentos de propriedade devem ser usados em vez de variáveis públicas no código que devem ser executadas quando o valor da propriedade for definido.

  • Ao contrário das variáveis públicas, os procedimentos de propriedade podem ter cadeias de caracteres de Ajuda atribuídas a elas no Pesquisador de Objetos.

Quando você cria um procedimento de propriedade, ele se torna uma propriedade do módulo que contém o procedimento. Visual Basic fornece os três tipos de procedimentos de propriedade a seguir.

Procedimento Descrição
Property Let Um procedimento que define o valor de uma propriedade.
Property Get Um procedimento que retorna o valor de uma propriedade.
Property Set Um procedimento que define uma referência a um objeto.

A sintaxe para declarar um procedimento de propriedade é a seguinte.

[ Público | Private ] [ Static ] Propriedade { GetLetSet | | } propertyname [( arguments )] [ As type ] statements End Property

Os procedimentos de propriedade geralmente são usados em pares: Property Let with Property Get e Property Set with Property Get. Declarar um procedimento Property Get sozinho é como declarar uma propriedade somente leitura. Usar todos os três tipos de procedimento de propriedade juntos só é útil para variáveis Variant , porque somente um Variant pode conter um objeto ou outras informações de tipo de dados. O Conjunto de Propriedades destina-se a ser usado com objetos; Propriedade Let não é.

Os argumentos necessários nas declarações de procedimento de propriedade são mostrados na tabela a seguir.

Procedimento Sintaxe de declaração
Property Get Propriedade Getpropname (1, ..., n) Como tipo
Property Let Propriedade Letpropname (1, ...,,,, n, n +1)
Property Set Propriedade Setpropname (1, ..., n, n +1)

O primeiro argumento até o último argumento (1, ..., n) deve compartilhar os mesmos nomes e tipos de dados em todos os procedimentos de propriedade com o mesmo nome.

Uma declaração do procedimento Property Get requer um argumento a menos do que as declarações de Propriedade Let e Property Set relacionadas. O tipo de dados do procedimento Property Get deve ser igual ao tipo de dados do último argumento (n +1) nas declarações de Propriedade Let e Property Set relacionadas. Por exemplo, se você declarar o procedimento Property Let a seguir, a declaração Property Get deve usar argumentos com o mesmo nome e tipo de dados que os argumentos no procedimento Property Let .

Property Let Names(intX As Integer, intY As Integer, varZ As Variant) 
 ' Statement here. 
End Property 
 
Property Get Names(intX As Integer, intY As Integer) As Variant 
 ' Statement here. 
End Property 

O tipo de dados do argumento final em uma declaração de Conjunto de Propriedades deve ser um tipo de objeto ou um Variant.

Confira também

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.