Declaração Get

Artigo
08/25/2010

Declara um procedimento de propriedade Get usado para recuperar o valor de uma propriedade.

[ <attributelist> ] [ accessmodifier ] Get()
    [ statements ]
End Get

Partes

attributelist
Opcional.Veja Lista de Atributos.
accessmodifier
Opcional, em no máximo uma, das declarações Get e Set nessa propriedade.Pode ser um dos seguintes:
- Protegido
- Friend
- Private
- Protected Friend
SeeNíveis de acesso em Visual Basic.
statements
Opcional.Uma ou mais declarações que executam quando o procedimento de propriedade Get for chamado.
End Get
Obrigatório.Finaliza a definição do procedimento de propriedade Get.

Comentários

Cada propriedade deve ter uma procedimento de propriedade Get a não ser que a propriedade seja marcada como WriteOnly.O procedimento Get é usado para retornar o valor atual da propriedade.

Visual Basic automaticamente chama um procedimento da propriedade Get quando uma expressão solicita o valor da propriedade.

O corpo da declaração de propriedade pode conter somente os procedimentos Get e Set de propriedade entre Propriedade declaração e a declaração End Property.Não é possível armazenar nada além desses procedimentos.Em particular, não é possível armazenar o valor atual da propriedade.Você deve armazenar esse valor fora da propriedade, pois se armazenar no interior de um dos procedimentos de propriedade, o outro procedimento de propriedade não poderá acessá-lo.A abordagem usual é armazenar o valor em uma variável Private (Visual Basic) declarada no mesmo nível da propriedade.Você deve definir um procedimento Get no interior da propriedade para o qual se aplica.

O procedimento Get tem como padrão o nível de acesso da propriedade que o contém, a não ser que você usa accessmodifier na declaração Get.

Regras

**Níveis de Acesso Mistos.**Se você estiver definindo uma propriedade de leitura e escrita, você pode, opcionalmente, especificar um nível de acesso diferente para o procedimento Get ou Set, mas não para ambos.Se isso for feito, o nível de acesso do procedimento deve ser mais restritivo que o nível de acesso da propriedade.Por exemplo, se a propriedade for declarada como Friend, você pode declarar o procedimento Get como Private, mas não como Public.

Se você estiver definindo uma propriedade ReadOnly, o procedimento Get representa a propriedade completa.Você não pode declarar um nível de acesso diferente para Get, pois isso configuraria dois níveis de acesso para a propriedade.
Tipo de retorno. A Propriedade declaração pode declarar o tipo de dados do valor que retorna.O procedimento Get retorna automaticamente esse tipo de dados.Você pode especificar qualquer tipo de dados ou o nome de uma enumeração, estrutura, classe ou interface.

Se a declaração Property não especificar returntype, o procedimento retorna Object.

Comportamento

Retornando a partir de um Procedimento. Quando o procedimento Get retorna para o código de chamada, a execução continua dentro da declaração que solicitou a valor da propriedade.

Os procedimentos de propriedade Getpodem retornar um valor usando a Instrução Return (Visual Basic) ou atribuindo o valor de retorno ao nome da propriedade.Para obter mais informações, consulte " Valor de Retorno" em Instrução Function (Visual Basic).

As declarações Exit Property e Return causam uma saída imediata do procedimento de propriedade.Qualquer número de declarações Exit Property e Return pode aparecer em qualquer lugar no procedimento, e você pode misturar declarações Exit Property e Return.
Valor de Retorno Para retornar um valor a partir de um procedimentoGet, você pode atribuir o valor ao nome da propriedade ou incluí-lo em uma Instrução Return (Visual Basic).A declaração Return simultaneamente atribui o valor de retorno do procedimento Gete sai do procedimento.

Se você usar Exit Property sem atribuir um valor ao nome da propriedade, o procedimento Get retornará o valor padrão para tipo de dados da propriedade.Para obter mais informações, consulte " Valor de Retorno" em Instrução Function (Visual Basic).

O exemplo a seguir ilustra duas maneiras como a propriedade somente leitura quoteForTheDay pode retornar o valor retido na variável privada quoteValue.
```
Private quoteValue As String = "No quote assigned yet."
```
```
ReadOnly Property quoteForTheDay() As String
    Get
        quoteForTheDay = quoteValue
        Exit Property
    End Get
End Property
```
```
ReadOnly Property quoteForTheDay() As String
    Get
        Return quoteValue
    End Get
End Property
```

Exemplo

O exemplo a seguir usa a declaração Get para retornar o valor de uma propriedade.

Class propClass
    ' Define a private local variable to store the property value.
    Private currentTime As String
    ' Define the read-only property.
    Public ReadOnly Property dateAndTime() As String
        Get
            ' The Get procedure is called automatically when the
            ' value of the property is retrieved.
            currentTime = CStr(Now)
            ' Return the date and time As a string.
            Return currentTime
        End Get
    End Property
End Class