Property Get (Instrucción)

       

Declara el nombre, los argumentos y el código que componen el cuerpo de un procedimiento Property, el cual obtiene el valor de una propiedad.

Sintaxis

[Public | Private | Friend] [Static] Property Get nombre [(lista_argumentos)] [As tipo]
[instrucciones]
[nombre = expresión]
[Exit Property]
[instrucciones]
[nombre = expresión]

End Property

La sintaxis de la instrucción Property Get consta de las siguientes partes:

Parte	Descripción
Public	Opcional. Indica que el procedimiento Property Get es accesible para todos los demás procedimientos de todos los módulos. Si se usa en un módulo que contiene una instrucción Option Private, el procedimiento no estará disponible fuera del proyecto.
Private	Opcional. Indica que el procedimiento Property Get sólo es accesible para otros procedimientos contenidos en el módulo donde se declara.
Friend	Opcional. Se usa solamente en un módulo de clase. Indica que el procedimiento Property Get es visible a través del proyecto, pero no es visible para un controlador de una instancia de un objeto.
Static	Opcional. Indica que las variables locales del procedimiento Property Get se conservan entre distintas llamadas. El atributo Static no afecta a las variables declaradas fuera del procedimiento Property Get, incluso aunque se utilicen en el mismo.
nombre	Requerido. Nombre del procedimiento Property Get; sigue las convenciones estándar de nombres de variables, excepto en que el nombre puede ser el mismo que el de un procedimiento Property Let o Property Set del mismo módulo.
lista_ argumentos	Opcional. Lista de variables que representan argumentos que se pasan al procedimiento Property Get cuando se llama a éste. Los distintos argumentos se separan mediante comas. El nombre y el tipo de datos de cada argumento de un procedimiento Property Get deben ser iguales que en los argumentos correspondientes de un procedimiento Property Let (si lo hay).
tipo	Opcional. Tipo de datos del valor devuelto por el procedimiento Property Get; puede ser Byte, Boolean, Integer, Long, Currency, Single, Double, Decimal (no admitida actualmente), Date, String (excepto longitud fija), Object, Variant, tipo definido por el usuario, y matrices. El tipo de retorno de un procedimiento Property Get debe ser del mismo tipo de datos que el último (a veces el único) argumento de un procedimiento Property Let correspondiente (si lo hay) que define el valor asignado a la propiedad en la parte derecha de una expresión.
instrucciones	Opcional. Cualquier grupo de instrucciones que se ejecutan dentro del cuerpo del procedimiento Property Get.
expresión	Opcional. Valor de la propiedad devuelto por el procedimiento definido por la instrucción Property Get.

El argumento lista_argumentos consta de las siguientes partes y sintaxis:

[Optional] [ByVal | ByRef] [ParamArray] nombre_variable[( )] [As tipo] [= valor_predeterminado]

Parte	Descripción
Optional	Opcional. Indica que no se necesita un argumento. Si se utiliza, todos los argumentos subsiguientes de lista_argumentos también deben ser opcionales y se deben declarar mediante la palabra clave Optional.
ByVal	Opcional. Indica que el argumento se pasa por valor.
ByRef	Opcional. Indica que el argumento se pasa por referencia. ByRef es el argumento predeterminado en Visual Basic.
ParamArray	Opcional. Sólo se utiliza como último argumento de lista_argumentos para indicar que el argumento final es una matriz Optional de elementos tipo Variant. La palabra clave ParamArray le permite proporcionar un número arbitrario de argumentos. No se puede utilizar con ByVal, ByRef u Optional.
nombre_ variable	Requerido. Nombre de la variable que representa al argumento; sigue las convenciones estándar de nombres de variables.
tipo	Opcional. El tipo de datos del argumento pasado al procedimiento; puede ser Byte, Boolean, Integer, Long, Currency, Single, Double, Decimal (no compatible actualmente), Date, String (sólo de longitud variable), Object, Variant, o un tipo de objeto específico. Si el parámetro no es Optional, se puede especificar también un tipo definido por el usuario.
valor_ predeterminado	Opcional. Cualquier constante o expresión de constante. Sólo es válido para parámetros Optional. Si el tipo es Object, un valor predeterminado explícito sólo puede ser Nothing.

Comentarios

Si no se especifica explícitamente mediante Public, Private o Friend, los procedimientos Property son públicos de manera predeterminada. Si no se usa Static, el valor de las variables locales no se conserva entre distintas llamadas. La palabra clave Friend solamente puede utilizarse en módulos de clase. Sin embargo, se puede acceder a los procedimientos Friend por procedimientos en cualquier módulo de un proyecto. Un procedimiento Friend no aparece en la biblioteca de tipo de su clase primaria.

Todo el código ejecutable debe estar en procedimientos. No puede definir un procedimiento Property Get dentro de otro procedimiento Property, Sub o Function.

La instrucción Exit Property causa la inmediata salida de un procedimiento Property Get. La ejecución del programa continúa con la instrucción que sigue a la instrucción que llamó al procedimiento Property Get. Cualquier número de instrucciones Exit Property puede aparecer en cualquier lugar de un procedimiento Property Get.

Al igual que un procedimiento Sub y Property Let, un procedimiento Property Get es un procedimiento distinto que puede tomar argumentos, llevar a cabo una serie de instrucciones y cambiar el valor de sus argumentos. Sin embargo, a diferencia de un procedimiento Sub o Property Let, puede utilizar un procedimiento Property Get en el lado derecho de una expresión de la misma forma en que utiliza Function o el nombre de una propiedad cuando desea devolver el valor de una propiedad.