Instrução Property Set

Declara o nome, os argumentos e o código que formam o corpo de um procedimentoProperty, que define uma referência a um objeto.

Sintaxe

[ Público | Privado | Amigo ] [ Estático ] Nome do Conjunto de Propriedades ( [ arglist ], reference )
[instruções]
[ Propriedade de saída ]
[instruções]
End Property

A sintaxe da instrução Property Set tem estas partes:

Sair Descrição
Opcional Opcional. Indica que o argumento pode ou não ser fornecido pelo chamador.
Public Opcional. Indica que o procedimento Conjunto de Propriedades 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 Conjunto de Propriedades é acessível somente para outros procedimentos no módulo em que é declarado.
Amigo Opcional. Usado somente em um módulo de classe. Indica que o procedimento Conjunto de Propriedades é 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 Property Set são preservadas entre as chamadas. O atributo Static não afeta variáveis declaradas fora do procedimento de Conjunto de Propriedades , mesmo que sejam usadas no procedimento.
name Obrigatório. Nome do procedimento Conjunto de Propriedades ; segue as convenções de nomenclatura de variáveis padrão, exceto que o nome pode ser o mesmo que um procedimento Property Get ou Property Let no mesmo módulo.
listadeargumentos Obrigatório. Lista de variáveis que representam argumentos que são passados para o procedimento Property Set quando ele é chamado. Vários argumentos são separados por vírgulas.
reference Obrigatório. Variável que contém a referência de objeto usada no lado direito da atribuição de referência de objeto.
instruções Opcional. Qualquer grupo de instruções a serem executadas no corpo do procedimento de propriedade .

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. Observe que não é possível que o lado direito de uma expressão do Conjunto de Propriedades seja Opcional.
ByVal Opcional. Indica se o argumento será passado por valor.
ByRef Opcional. Indica se o argumento será passado por referência. ByRef é o padrão no VBA, ao contrário do Visual Basic .NET.
ParamArray Opcional. Usado apenas como o último argumento em arglist para indicar que o argumento final é uma matriz opcional de elementos Variant . A palavra-chave ParamArray permite que você forneça um número aleatório de argumentos. Não pode ser usado 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 passado para o procedimento; pode ser Byte, Booleano, Inteiro, Longo, Conversor de Moedas, Simples, Duplo, Decimal (não há suporte no momento), Data, Cadeia de caracteres (somente comprimento 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 constante ou expressão constante. Válido somente para parâmetros Optional. Se o tipo for um Object, um valor padrão explícito só poderá ser Nothing.

Observação

Cada instrução Property Set deve definir pelo menos um argumento para o procedimento que ela define. Esse argumento (ou o último argumento, se houver mais de um) contém a referência de objeto real para a propriedade quando o procedimento definido pela instrução Property Set é invocado. É conhecido como referência na sintaxe anterior. Não pode ser opcional.

Comentários

Se não for especificado explicitamente usando Público, Privado ou Amigo, os procedimentos de Propriedade serão públicos por padrão. Se Static não for usado, o valor de variáveis locais não será 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. Você não pode definir um procedimento Property Set dentro de outro procedimento Property, Sub ou Function .

A instrução Exit Property causa uma saída imediata de um procedimento Property Set . A execução do programa continua com a instrução após a instrução que chamou o procedimento Property Set . Qualquer número de instruções de Propriedade de Saída pode aparecer em qualquer lugar em um procedimento de Conjunto de Propriedades .

Como um procedimento Function e Property Get , um procedimento Property Set é um procedimento separado que pode receber argumentos, executar uma série de instruções e alterar o valor de seus argumentos. No entanto, ao contrário de um procedimento Function e Property Get , que retornam um valor, você só pode usar um procedimento Property Set no lado esquerdo de uma atribuição de referência de objeto ou instrução Set .

Exemplo

Este exemplo usa a instrução Property Set para definir um procedimento de propriedade que define uma referência a um objeto.

' The Pen property may be set to different Pen implementations. 
Property Set Pen(P As Object) 
 Set CurrentPen = P ' Assign Pen to object. 
End Property

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.

  • Last updated on