Get, instruction

  • Article

Déclare une procédure de propriété Get utilisée pour récupérer la valeur d'une propriété.

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

Composants

Terme

Définition

attributelist

Facultatif. Consultez Liste d'attributs.

accessmodifier

Facultatif pour, au plus, l'une des instructions Get et Set de cette propriété. Il peut s'agir de l'une des valeurs suivantes :

Consultez Niveaux d'accès dans Visual Basic.

statements

Facultatif. Une ou plusieurs instructions qui s'exécutent lors de l'appel de la procédure de propriété Get.

End Get

Obligatoire. Met fin à la définition de la procédure de propriété Get.

Notes

Chaque propriété doit contenir une procédure de propriété Get à moins que la propriété soit marquée WriteOnly. La procédure Get est utilisée pour retourner la valeur actuelle de la propriété.

Visual Basic appelle automatiquement la procédure Get d'une propriété lorsqu'une expression demande la valeur de la propriété.

Le corps de la déclaration de propriété peut contenir uniquement les procédures Get et Set de la propriété entre l'instruction Property, instruction et End Property. Il ne peut stocker rien d'autre que ces procédures. En particulier, il ne peut pas stocker la valeur actuelle de la propriété. Vous devez stocker cette valeur à l'extérieur de la propriété, car si vous la stockez à l'intérieur de l'une ou l'autre des procédures de propriété, l'autre procédure de propriété ne peut pas y accéder. L'approche habituelle consiste à stocker la valeur dans une variable Private (Visual Basic) déclarée au même niveau que la propriété. Vous devez définir une procédure Get dans la propriété à laquelle elle s'applique.

La procédure Get prend par défaut le niveau d'accès de sa propriété conteneur à moins que vous utilisiez accessmodifier dans l'instruction Get.

Règles

  • Niveaux d'accès mixtes. Si vous définissez une propriété en lecture-écriture, vous pouvez éventuellement spécifier un niveau d'accès différent pour la procédure Get ou la procédure Set, mais pas pour les deux. Dans ce cas, le niveau d'accès de la procédure doit être plus restrictif que celui de la propriété. Par exemple, si la propriété est déclarée Friend, vous pouvez déclarer la procédure Get Private, mais pas Public.

    Si vous définissez une propriété ReadOnly, la procédure Get représente l'ensemble de la propriété. Vous ne pouvez pas déclarer un niveau d'accès différent pour Get, parce que deux niveaux d'accès seront définis pour la propriété.

  • Type de retour. L'instruction du nom Property, instruction peut déclarer le type de données de la valeur qu'elle retourne. La procédure Get retourne automatiquement ce type de données. Vous pouvez spécifier un type de données ou le nom d'une énumération, d'une structure, d'une classe ou d'une interface.

    Si l'instruction Property ne spécifie pas returntype, la procédure retourne Object.

Comportement

  • Retour d'une procédure. Lorsque la procédure Get retourne au code appelant, l'exécution continue dans l'instruction qui a demandé la valeur de la propriété.

    Les procédures de propriété Get peuvent retourner une valeur en utilisant Return, instruction (Visual Basic) ou en assignant la valeur de retour au nom de la propriété. Pour plus d'informations, consultez « Valeur de retour » dans Function, instruction (Visual Basic).

    Les instructions Exit Property et Return provoquent la sortie immédiate d'une procédure de propriété. Plusieurs instructions Exit Property et Return peuvent apparaître n'importe où dans la procédure, et vous pouvez associer des instructions Exit Property et Return.

  • Valeur de retour. Pour retourner une valeur à partir d'une procédure Get, vous pouvez soit assigner la valeur au nom de la propriété, soit l'inclure dans une instruction Return, instruction (Visual Basic). L'instruction Return assigne simultanément la valeur de retour de la procédure Get et ferme la procédure.

    Si vous utilisez Exit Property sans assigner de valeur au nom de la propriété, la procédure Get retourne la valeur par défaut pour le type de données de la propriété. Pour plus d'informations, consultez « Valeur de retour » dans Function, instruction (Visual Basic).

    L'exemple suivant illustre deux méthodes utilisées par la propriété en lecture seule quoteForTheDay pour retourner la valeur contenue dans la variable privée 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

Exemple

L'exemple suivant utilise l'instruction Get pour retourner la valeur d'une propriété.

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

Voir aussi

Tâches

Procédure pas à pas : définition des classes (Visual Basic)

Référence

Set, instruction (Visual Basic)

Property, instruction

Exit, instruction (Visual Basic)

Autres ressources

Objets et classes en Visual Basic