Get, instruction

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

Syntaxe

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

Pièces

Remarques

Chaque propriété doit avoir une Get procédure de propriété, sauf si la propriété est marquée WriteOnly. La Get procédure est utilisée pour retourner la valeur actuelle de la propriété.

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

Le corps de la déclaration de propriété ne peut contenir que les procédures et Set les procédures de Get la propriété entre l’instruction Property et l’instructionEnd Property. Il ne peut pas stocker quoi que ce soit d’autre que ces procédures. En particulier, elle ne peut pas stocker la valeur actuelle de la propriété. Vous devez stocker cette valeur en dehors de la propriété, car si vous la stockez à l’intérieur de l’une 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 privée déclarée au même niveau que la propriété. Vous devez définir une Get procédure à l’intérieur de la propriété à laquelle elle s’applique.

La Get procédure est par défaut au niveau d’accès de sa propriété contenante, sauf si vous utilisez accessmodifier 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 ou la GetSet procédure, mais pas les deux. Si vous effectuez cette opération, le niveau d’accès de la procédure doit être plus restrictif que le niveau d’accès de la propriété. Par exemple, si la propriété est déclarée Friend, vous pouvez déclarer la Get procédure Private, mais pas Public.

  Si vous définissez une ReadOnly propriété, la Get procédure représente l’intégralité de la propriété. Vous ne pouvez pas déclarer un niveau d’accès différent pour Get, car cela définirait deux niveaux d’accès pour la propriété.

• Type de retour. L’instruction Property peut déclarer le type de données de la valeur qu’elle retourne. La Get procédure retourne automatiquement ce type de données. Vous pouvez spécifier n’importe quel 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 returntypepas, la procédure retourne Object.

Comportement

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

  Get les procédures de propriété peuvent retourner une valeur à l’aide de l’instruction Return ou en affectant la valeur de retour au nom de la propriété. Pour plus d’informations, consultez « Valeur de retour » dans l’instruction function.

  Les Exit Property instructions provoquent Return une sortie immédiate d’une procédure de propriété. N’importe quel nombre d’instructions Exit PropertyReturn peuvent apparaître n’importe où dans la procédure, et vous pouvez combiner et Return utiliser Exit Property des instructions.

• Valeur de retour. Pour renvoyer une valeur à partir d’une Get procédure, vous pouvez affecter la valeur au nom de la propriété ou l’inclure dans une instruction Return. L’instruction Return affecte simultanément la valeur de retour de la Get procédure et quitte la procédure.

  Si vous utilisez Exit Property sans affecter de valeur au nom de la propriété, la Get procédure 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 l’instruction function.

  L’exemple suivant illustre deux façons dont la propriété quoteForTheDay en lecture seule peut retourner la valeur détenue dans la variable quoteValueprivée.

  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

• Set, instruction
• Property Statement
• Instruction de sortie
• Objets et classes
• Procédure pas à pas : définition de classes