Escrever um procedimento de propriedade

Um procedimento de propriedade é uma série de instruções do Visual Basic que permitem a um programador criar e manipular propriedades personalizadas.

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

  • Os procedimentos de propriedade devem ser utilizados em vez de Variáveis públicas no código que têm de ser executados quando o valor da propriedade é definido.

  • Ao contrário das variáveis Públicas , os procedimentos de propriedade podem ter cadeias de ajuda atribuídas às mesmas no Object Browser.

Quando cria um procedimento de propriedade, este torna-se uma propriedade do módulo que contém o procedimento. O Visual Basic fornece os seguintes três tipos de procedimentos de propriedade.

Procedimento Descrição
Deixar Propriedade Um procedimento que define o valor de uma propriedade.
Obter Propriedade Um procedimento que devolve o valor de uma propriedade.
Definir Propriedade Um procedimento que define uma referência a um objeto.

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

[ Público | Privado ] [ Estático ] Property { Get | Let | Set } propertyname [( arguments )] [ Astype ] statementsEnd Property

Os procedimentos de propriedade são normalmente utilizados em pares: Propriedade Permitir com Obtenção de Propriedade e Conjunto de Propriedades com Obtenção de Propriedade. Declarar apenas um procedimento Obter Propriedade é como declarar uma propriedade só de leitura. A utilização dos três tipos de procedimento de propriedade em conjunto só é útil para variáveis de Variante , uma vez que apenas uma Variante pode conter um objeto ou outras informações de tipo de dados. O Conjunto de Propriedades destina-se a ser utilizado com objetos; Propriedade Não é.

Os argumentos necessários nas declarações do procedimento de propriedade são apresentados na tabela seguinte.

Procedimento Sintaxe de declaração
Property Get Propriedade Obterpropname (1, ..., n) Comotipo
Property Let Propriedade Permitirpropname (1, ...,,,, n, n +1)
Property Set Propriedade Definirpropname (1, ..., n, n +1)

O primeiro argumento ao longo do último argumento (1, ..., n) tem de partilhar os mesmos nomes e tipos de dados em todos os procedimentos de propriedade com o mesmo nome.

Uma declaração do procedimento Obter Propriedade requer um argumento menor do que as declarações relacionadas Property Let e Property Set . O tipo de dados do procedimento Obter Propriedade tem de ser o mesmo que o tipo de dados do último argumento (n +1) nas declarações relacionadas Property Let e Property Set . Por exemplo, se declarar o seguinte procedimento Property Let , a declaração Property Get tem de utilizar 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 numa declaração do Conjunto de Propriedades tem de ser um tipo de objeto ou uma Variante.

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.