Instrução Property Get

  • Artigo

Declara o nome, argumentos e código que formam o corpo de um procedimentopropriedade, que obtém o valor de uma propriedade.

Sintaxe

[ Público | Privado | Amigo ] [ Estático ] Propriedade Obternome [ (arglist) ] [ Comotipo ]
[instruções]
[ nome=expressão ]
[ Propriedade de Saída ]
[instruções]
[ nome=expressão ]
End Property

A sintaxe da instrução Property Get tem as seguintes partes:

Sair Descrição
Public Opcional. Indica que o procedimento Obter Propriedade está acessível a todos os outros procedimentos em todos os módulos. Se usado em um módulo que contém uma instrução Option Private, o procedimento não está disponível fora do projeto.
Private Opcional. Indica que o procedimento Obter Propriedade está acessível apenas a outros procedimentos no módulo onde é declarado.
Amigo Opcional. Usado somente em um módulo de classe. Indica que o procedimento Obter Propriedade está visível em todo o projeto, mas não é visível para um controlador de uma instância de um objeto.
Static Opcional. Indica que as variáveis locais do procedimento Obter Propriedade são preservadas entre chamadas. O atributo Estático não afeta as variáveis declaradas fora do procedimento Obter Propriedade , mesmo que sejam utilizadas no procedimento.
name Obrigatório. Nome do procedimento Obter Propriedade ; segue as convenções de nomenclatura de variáveis padrão, exceto que o nome pode ser o mesmo que um procedimento Property Let ou Property Set no mesmo módulo.
listadeargumentos Opcional. Lista de variáveis que representam argumentos que são transmitidos para o procedimento Obter Propriedade quando é chamado. Vários argumentos são separados por vírgulas. O nome e o tipo de dados de cada argumento num procedimento Obter Propriedade têm de ser os mesmos que o argumento correspondente num procedimento Property Let (se existir um).
type Opcional. Tipo de dados do valor devolvido pelo procedimento Obter Propriedade; podem ser Byte, Booleano, Número Inteiro, Longo, Conversor de Moedas, Único, Duplo, Decimal (não suportado atualmente), Data, Cadeia (exceto comprimento fixo), Objeto, Variante, tipo definido pelo utilizador e Matrizes.

O tipo de retorno de um procedimento Obter Propriedade tem de ser o mesmo tipo de dados que o último (ou, por vezes, o único) argumento num procedimento Property Let correspondente (se existir) que define o valor atribuído à propriedade no lado direito de uma expressão.
instruções Opcional. Qualquer grupo de instruções a executar no corpo do procedimento Obter Propriedade .
expression Opcional. Valor da propriedade devolvida pelo procedimento definido pela instrução Property Get .

O argumento listadeargumentos tem as seguintes sintaxe e partes:

[ Optional ] [ ByVal | ByRef ] [ ParamArray ] varname [()] [ Comotype ] [ =defaultValue ]

Sair Descrição
Opcional Opcional. Indica se um argumento não é obrigatório. Se for usado, todos os argumentos subsequentes em arglist também deverão ser opcionais e declarados usando a palavra-chave Optional.
ByVal Opcional. Indica se o argumento será passado por valor.
ByRef Opcional. Indica se o argumento será passado por referência. ByRef é a predefinição no VBA, ao contrário do Visual Basic .NET.
ParamArray Opcional. Utilizado apenas como o último argumento em arglist para indicar que o argumento final é uma matriz Opcional de elementos Variante . A palavra-chave ParamArray permite que você forneça um número aleatório de argumentos. Não pode ser utilizado com ByVal, ByRef ou Opcional.
nomedavariável Obrigatório. Nome da variável que representa o argumento passado; segue as convenções de nomenclatura de variável padrão.
tipo Opcional. Tipo de dados do argumento transmitido ao procedimento; podem ser Byte, Booleano, Número Inteiro, Longo, Conversor de Moedas, Único, Duplo, Decimal (não suportado atualmente), Data, Cadeia (apenas comprimento de variável), Objeto, Variante ou um tipo de objeto específico. Se o parâmetro não for Optional, um tipo definido pelo usuário também poderá ser especificado.
valorpadrão Opcional. Qualquer expressão constante ou constante. Válido somente para parâmetros Optional. Se o tipo for um Objeto, um valor predefinido explícito só pode ser Nada.

Comentários

Se não for explicitamente especificado através da utilização de Procedimentos de PropriedadePública, Privada ou Amigo, os procedimentos de Propriedade são públicos por predefinição. Se Estático não for utilizado, o valor das variáveis locais não é preservado entre chamadas.

A palavra-chave Friend só pode ser usada em módulos de classe. No entanto, procedimentos Friend podem ser acessados por procedimentos em qualquer módulo de um projeto. Um procedimento Friend não aparece na biblioteca de tipos de sua classe pai, e um procedimento Friend não ser pode associado tardiamente.

Todo código executável deve estar em procedimentos. Não pode definir um procedimento Obter Propriedade dentro de outro procedimento de Propriedade, Sub ou Função .

A instrução Exit Property provoca uma saída imediata de um procedimento Obter Propriedade . A execução do programa continua com a instrução a seguir à instrução que chamou o procedimento Obter Propriedade . Qualquer número de instruções Exit Property pode aparecer em qualquer lugar num procedimento Obter Propriedade .

Tal como um procedimento Sub e Property Let , um procedimento Obter Propriedade é um procedimento separado que pode utilizar argumentos, executar uma série de instruções e alterar os valores dos respetivos argumentos. No entanto, ao contrário de um procedimento Sub ou Property Let , pode utilizar um procedimento Obter Propriedade no lado direito de uma expressão da mesma forma que utiliza uma Função ou um nome de propriedade quando pretende devolver o valor de uma propriedade.

Exemplo

Este exemplo utiliza a instrução Property Get para definir um procedimento de propriedade que obtém o valor de uma propriedade. A propriedade identifica a cor atual de uma caneta como uma cadeia.

Dim CurrentColor As Integer 
Const BLACK = 0, RED = 1, GREEN = 2, BLUE = 3 
 
' Returns the current color of the pen as a string. 
Property Get PenColor() As String 
 Select Case CurrentColor 
 Case RED 
 PenColor = "Red" 
 Case GREEN 
 PenColor = "Green" 
 Case BLUE 
 PenColor = "Blue" 
 End Select 
End Property 
 
' The following code gets the color of the pen 
' calling the Property Get procedure. 
ColorName = PenColor

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.