Instrução Property Let

  • Artigo

Declara o nome, os argumentos e o código que formam o corpo de um procedimentode Propriedade, que atribui um valor a uma propriedade.

Sintaxe

[ Público | Privada | Amigo ] [ Estático ] Nome da permissãode propriedade ( [ arglist ], valor )
[instruções]
[ Propriedade Exit ]
[instruções]
Propriedade End

A sintaxe de instrução Property Let tem estas partes:

Sair Descrição
Public Opcional. Indica que o procedimento Property Let 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 Property Let está acessível apenas a outros procedimentos no módulo em que ele é declarado.
Amigo Opcional. Usado somente em um módulo de classe. Indica que o procedimento Property Let 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 Property Let são preservadas entre chamadas. O atributo estático não afeta variáveis declaradas fora do procedimento Property Let , mesmo que sejam usadas no procedimento.
name Obrigatório. Nome do procedimento Property Let ; segue convenções de nomenclatura de variável padrão, exceto que o nome pode ser o mesmo que um procedimento Property Get ou Property Set no mesmo módulo.
listadeargumentos Obrigatório. Lista de variáveis que representam argumentos que são passados para o procedimento Property Let quando ele é chamado. Vários argumentos são separados por vírgulas. O nome e o tipo de dados de cada argumento em um procedimento Property Let devem ser os mesmos que o argumento correspondente em um procedimento de Obtenção de Propriedade .
value Obrigatório. Variável para conter o valor a ser atribuído à propriedade. Quando o procedimento é chamado, esse argumento aparece no lado direito da expressão de chamada. O tipo de dados de valor deve ser o mesmo que o tipo de retorno do procedimento de Obtenção de Propriedade correspondente.
instruções Opcional. Qualquer grupo de instruções a serem executadas no procedimento Property Let .

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 Property Let seja Opcional.
ByVal Opcional. Indica se o argumento será passado por valor.
ByRef Opcional. Indica se o argumento será passado por referência. ByRef é padrão no Visual Basic.
ParamArray Opcional. Indica que o argumento é uma matriz opcional de elementos Variant . A palavra-chave ParamArray permite que você forneça um número aleatório de argumentos. Ele pode não ser usado com ByVal, ByRef ou Opcional. Esse palavra-chave não pode ser o último elemento nem o único elemento da arglist.
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, Boolean, Integer, Long, Conversor de Moedas, Single, Double, Decimal (não suportado atualmente), Date, String (somente comprimento de variável), Objeto, Variant 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 padrão explícito só poderá ser Nothing.

Observação

Cada instrução Property Let deve definir pelo menos um argumento válido para o procedimento que define. O 'válido' significa que ele não deve ser modificado com 'Opcional' nem 'ParamArray'. Esse argumento (ou o último argumento, se houver mais de um) contém o valor real a ser atribuído à propriedade quando o procedimento definido pela instrução Property Let for invocado. Esse argumento é chamado de valor na sintaxe anterior.

Comentários

Se não for especificado explicitamente usando procedimentos públicos, privados ou amigos, 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 Desembaratório de Propriedades dentro de outra propriedade, sub ou procedimento de função .

A instrução Exit Property causa uma saída imediata de um procedimento property let . A execução do programa continua com a instrução seguindo a instrução que chamou o procedimento Property Let . Qualquer número de instruções da Propriedade Exit pode aparecer em qualquer lugar em um procedimento Desembaraçar propriedades .

Como um procedimento de Obtenção de Função e Propriedade , um procedimento Property Let é um procedimento separado que pode levar argumentos, executar uma série de instruções e alterar o valor de seus argumentos. No entanto, ao contrário de um procedimento function and property get , ambos retornam um valor, você só pode usar um procedimento Property Let no lado esquerdo de uma expressão de atribuição de propriedade ou instrução Let .

Exemplo

Este exemplo usa a instrução Property Let para definir um procedimento que atribui um valor a uma propriedade. A propriedade identifica a cor da caneta para um pacote de desenho.

Dim CurrentColor As Integer 
Const BLACK = 0, RED = 1, GREEN = 2, BLUE = 3 
 
' Set the pen color property for a Drawing package. 
' The module-level variable CurrentColor is set to 
' a numeric value that identifies the color used for drawing. 
Property Let PenColor(ColorName As String) 
 Select Case ColorName ' Check color name string. 
 Case "Red" 
 CurrentColor = RED ' Assign value for Red. 
 Case "Green" 
 CurrentColor = GREEN ' Assign value for Green. 
 Case "Blue" 
 CurrentColor = BLUE ' Assign value for Blue. 
 Case Else 
 CurrentColor = BLACK ' Assign default value. 
 End Select 
End Property 
 
' The following code sets the PenColor property for a drawing package 
' by calling the Property let procedure. 
 
PenColor = "Red"

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.