Property Get-Anweisung

Deklariert den Namen, die Argumente und den Code, die den Textkörper einer Property-Prozedur bilden, die den Wert einer Eigenschaft abruft.

Syntax

[ Öffentlich | Privat | Friend ] [ Statisch ] Property Get name [ (arglist) ] [ As type ]
[ statements ]
[ name = expression ]
[ Beenden-Eigenschaft ]
[ statements ]
[ name = expression ]
End Property

Die Syntax der Property Get -Anweisung besteht aus folgenden Teilen:

Teil Beschreibung
Public Optional. Gibt an, dass auf die Property Get-Prozedur von allen anderen Prozeduren in allen Modulen zugegriffen werden kann. Wenn die Prozedur in einem Modul verwendet wird, das eine Option Private-Anweisung enthält, ist sie außerhalb des Projekts nicht zugänglich.
Private Optional. Gibt an, dass auf die Property Get-Prozedur nur von anderen Prozeduren in dem Modul zugegriffen werden kann, in dem sie deklariert wurde.
Friend Optional. Wird nur in einem Klassenmodul verwendet. Gibt an, dass die Property Get-Prozedur im gesamten Projekt sichtbar ist, jedoch nicht für den Controller einer Objektinstanz.
Static Optional. Gibt an, dass die lokalen Variablen der Property Get-Prozedur zwischen Aufrufen beibehalten werden. Auf Variablen, die außerhalb der Property Get-Prozedur deklariert wurden, hat das Static-Attribut keinen Einfluss, selbst wenn sie in der Prozedur verwendet werden.
name Erforderlich. Name der Property Get-Prozedur ; folgt den Standardbenennungskonventionen für Variablen, mit der Ausnahme, dass der Name mit einer Property Let- oder Property Set-Prozedur im selben Modul identisch sein kann.
arglist Optional. Variablenliste mit den Argumenten, die an die Property Get-Prozedur bei ihrem Aufruf übergeben werden. Mehrere Argumente werden durch Kommas getrennt. Der Name und der Datentyp aller Argumente in einer Property Get-Prozedur müssen mit dem Namen und Datentyp des entsprechenden Arguments in einer Property Let-Prozedur übereinstimmen (sofern vorhanden).
type Optional. Datentyp des von der Property Get-Prozedur zurückgegebenen Werts; kann Byte, Boolean, Integer, Long, Currency, Single, Double, Decimal (derzeit nicht unterstützt), Date, String (außer feste Länge), Objekt, Variant, benutzerdefinierter Typ und Arrays sein.

Der Rückgabetyp einer Property Get-Prozedur muss dem datentyp des letzten (oder manchmal einzigen) Arguments in einer entsprechenden Property Let-Prozedur (sofern vorhanden) entsprechen, die den Wert definiert, der der Eigenschaft auf der rechten Seite eines Ausdrucks zugewiesen ist.
statements Optional. Eine Gruppe von Anweisungen, die in der Property Get-Prozedur ausgeführt werden sollen.
expression Optional. Wert der Eigenschaft, die von der Prozedur zurückgegeben wird, die durch die Property Get-Anweisung definierten wurde.

Das arglist-Argument weist die folgende Syntax und folgende Teile auf:

[ Optional ] [ ByVal | ByRef ] [ ParamArray ] varname [ ( ) ] [ As type ] [ = defaultvalue ]

Teil Beschreibung
Optional Optional. Gibt an, dass ein Argument nicht erforderlich ist. Wenn verwendet, müssen alle nachfolgenden Argumente in arglist optional sein und mithilfe des Schlüsselworts Optional deklariert werden.
ByVal Optional. Gibt an, dass das Argument nach Wert übergeben wird.
ByRef Optional. Gibt an, dass das Argument nach Verweis übergeben wird. ByRef ist die Standardeinstellung in Visual Basic.
ParamArray Optional. Wird lediglich als letztes Argument in arglist verwendet, um anzuzeigen, dass das letzte Argument ein Optional-Array von Variant-Elementen ist. Mit dem Schlüsselwort ParamArray können Sie eine beliebige Anzahl von Argumenten bereitstellen. Es darf jedoch nicht zusammen mit ByVal, ByRef oder Optional verwendet werden.
varname Erforderlich. Name der Variable, die das Argument darstellt; folgt den Standardbenennungskonventionen für Variablen.
type Optional. Datentyp des Arguments, das an die Prozedur übergeben wird; kann Byte, Boolean, Integer, Long, Currency, Single, Double, Decimal (derzeit nicht unterstützt), Date, String (nur mit variabler Länge), Object, Variante oder ein spezifischer Objekttyp sein. Wenn der Parameter nicht Optional lautet, kann auch ein benutzerdefinierter Typ angegeben werden.
defaultvalue Optional. Eine beliebige Konstante oder ein Konstantenausdruck. Nur gültig, wenn der Parameter Optional ist. Wenn der Typ Object ist, kann ein expliziter Standardwert nur Nothing lauten.

Hinweise

Wenn nicht mithilfe von Public, Private oder Friend explizit angegeben, sind Property-Prozduren standardmäßig öffentlich. Wenn Static nicht verwendet wird, wird der Wert lokaler Variablen zwischen Aufrufen nicht beibehalten.

Das Schlüsselwort Friend kann nur in Klassenmodulen verwendet werden. Auf Friend-Prozeduren kann jedoch in allen Modulen des Projekts zugegriffen werden. Eine Friend-Prozedur wird weder in der Typbibliothek ihrer übergeordneten Klasse angezeigt noch kann eine Friend-Prozedur spät gebunden werden.

Der gesamte ausführbare Code muss in Prozeduren enthalten sein. Sie können keine Property Get-Prozedur innerhalb einer anderen Property-, Sub- oder Function-Prozedur definieren.

Die Exit Property - Anweisung bewirkt, dass eine Property Get-Prozedur sofort beendet wird. Die Ausführung des Programms wird mit der Anweisung fortgesetzt, die auf die Anweisung folgt, von der die Property Get-Prozedur aufgerufen wurde. Exit Property-Anweisungen können beliebig oft an beliebigen Stellen in einer Property Get-Prozedur auftreten.

Wie die Sub - oder Property Let -Prozedur ist auch die Property Get -Prozedur eine eigenständige Prozedur, die Argumente erhalten, eine Reihe von Anweisungen ausführen und die Werte ihrer Argumente ändern kann. Im Gegensatz zu einer Sub - oder Property Let-Prozedur können Sie eine Property Get-Prozedur auf der rechten Seite eines Ausdrucks auf die gleiche Weise verwenden wie eine Funktion oder einen Eigenschaftennamen, wenn Sie den Wert einer Eigenschaft zurückgeben möchten.

Beispiel

In diesem Beispiel wird mit der Property Get -Anweisung eine Eigenschaftenprozedur definiert, die den Wert einer Eigenschaft abruft. Die Eigenschaft identifiziert die aktuelle Farbe eines Stifts als Zeichenfolge.

Dim CurrentColor As Integer 
Const BLACK = 0, RED = 1, GREEN = 2, BLUE = 3 
 
' Returns the current color of the pen as a string. 
Property Get PenColor() As String 
 Select Case CurrentColor 
 Case RED 
 PenColor = "Red" 
 Case GREEN 
 PenColor = "Green" 
 Case BLUE 
 PenColor = "Blue" 
 End Select 
End Property 
 
' The following code gets the color of the pen 
' calling the Property Get procedure. 
ColorName = PenColor 

Siehe auch

Support und Feedback

Haben Sie Fragen oder Feedback zu Office VBA oder zu dieser Dokumentation? Unter Office VBA-Support und Feedback finden Sie Hilfestellung zu den Möglichkeiten, wie Sie Support erhalten und Feedback abgeben können.