Get (Instrucción)

Declara un procedimiento Get de propiedad utilizado para recuperar el valor de una propiedad.

Sintaxis

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

Partes

Comentarios

Cada propiedad debe tener un procedimiento de propiedad a Get menos que la propiedad esté marcada como WriteOnly . El Get procedimiento se usa para devolver el valor actual de la propiedad .

Visual Basic llama automáticamente al procedimiento de una Get propiedad cuando una expresión solicita el valor de la propiedad.

El cuerpo de la declaración de propiedad solo puede contener los procedimientos y de la Get propiedad entre la instrucción Property Set y la End Property instrucción . No puede almacenar nada que no sea esos procedimientos. En concreto, no puede almacenar el valor actual de la propiedad. Debe almacenar este valor fuera de la propiedad , porque si lo almacena dentro de cualquiera de los procedimientos de propiedad, el otro procedimiento de propiedad no puede acceder a él. El enfoque habitual es almacenar el valor en una variable Private declarada en el mismo nivel que la propiedad . Debe definir un Get procedimiento dentro de la propiedad a la que se aplica.

El procedimiento tiene como valor predeterminado el nivel de acceso de su propiedad que lo contiene, a menos Get que se use en la instrucción accessmodifier Get .

Reglas

• Niveles de acceso mixtos. Si va a definir una propiedad de lectura y escritura, opcionalmente puede especificar un nivel de acceso diferente para el procedimiento o Get Set , pero no ambos. Si lo hace, el nivel de acceso del procedimiento debe ser más restrictivo que el nivel de acceso de la propiedad. Por ejemplo, si la propiedad se declara Friend , puede declarar el procedimiento , pero no Get Private Public .

  Si va a definir una ReadOnly propiedad, el Get procedimiento representa toda la propiedad. No se puede declarar un nivel de acceso diferente para Get , porque se establecerían dos niveles de acceso para la propiedad .

• Tipo de valor devuelto. La instrucción Property puede declarar el tipo de datos del valor que devuelve. El Get procedimiento devuelve automáticamente ese tipo de datos. Puede especificar cualquier tipo de datos o el nombre de una enumeración, estructura, clase o interfaz.

  Si la Property instrucción no especifica , el procedimiento devuelve returntype Object .

Comportamiento

• Devolver de un procedimiento. Cuando el procedimiento vuelve al código de llamada, la ejecución continúa Get dentro de la instrucción que solicitó el valor de propiedad.

  Get Los procedimientos de propiedad pueden devolver un valor mediante la instrucción Return o asignando el valor devuelto al nombre de propiedad. Para obtener más información, vea "Valor devuelto" en Function Statement.

  Las Exit Property instrucciones y provocan una salida inmediata de un procedimiento de Return propiedad. Cualquier número de Exit Property instrucciones y puede aparecer en cualquier parte del Return procedimiento, y puede mezclar instrucciones Exit Property y Return .

• Valor devuelto. Para devolver un valor de un procedimiento, puede asignar el valor al nombre de propiedad Get o incluirlo en una instrucción Return. La Return instrucción asigna simultáneamente el valor devuelto del Get procedimiento y sale del procedimiento.

  Si usa sin asignar un valor al nombre de propiedad, el procedimiento devuelve el valor predeterminado para el tipo Exit Property de datos de la Get propiedad. Para obtener más información, vea "Valor devuelto" en Function Statement.

  En el ejemplo siguiente se muestran dos maneras en que la propiedad de solo lectura quoteForTheDay puede devolver el valor que se mantiene en la variable 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
  

Ejemplo

En el ejemplo siguiente se usa Get la instrucción para devolver el valor de una propiedad .

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

Consulta también

• Set (Instrucción)
• Property Statement
• Instrucción Exit
• Objetos y clases
• Tutorial: Definir clases