Propiedades - FernandoCalmet/csharp-essential GitHub Wiki

Sintaxis de propiedad

La sintaxis de una declaración de propiedad se puede utilizar de la siguiente manera:

Access_Modifier Type PropertyName
{
    get
    {
        //read actions
    }
    set
    {
        //write action
    }
}

Como podemos ver, una propiedad puede contener dos bloques de código. El bloque get contiene declaraciones que se ejecutan cuando leemos de una propiedad. El bloque set contiene declaraciones que se ejecutan cuando escribimos en una propiedad:

public class Student
{
    private string _name;
    private string _lastName;

    public string Name
    {
        get { return _name; }
        set { _name = value; }
    }

    public string LastName
    {
        get { return _lastName; }
        set { _lastName = value; }
    }

    public Student(string name, string lastName)
    {
        _name = name;
        _lastName = lastName;
    }

    public string GetFullName()
    {
        return _name + ' ' + _lastName;
    }
}

En el ejemplo anterior, vemos que nuestros campos privados ahora están expuestos a través de las propiedades. Si queremos leer el valor del campo _name, todo lo que tenemos que hacer es llamar a la propiedad Name con el objeto student. Lo mismo se aplica al campo _lastName. Además, si queremos establecer un valor para nuestros campos, todo lo que tenemos que hacer es llamar a un bloque de conjunto de nuestras propiedades:

class Program
{
    static void Main(string[] args)
    {
        Student student = new Student("John", "Doe");

        string name = student.Name; //call to a get block of the Name property
        string lastName = student.LastName; // call to a get block of the LastName property

        student.Name = "David"; //call to a set block of the Name property
        student.LastName = "Dauni"; // call to a set block of the LastName property
    }
}

Nuestras propiedades pueden tener un código complejo dentro de bloques get o set. No se limitan solo a leer un valor o simplemente a escribir un valor. En los bloques get o set podemos usar condiciones o llamadas a métodos, etc:

public int X
{
    get 
    {
        return _x;
    }
    set
    {
        _x = CheckValue(value);
    }
}    

private int CheckValue(int val)
{
    //code execution in here
}

Propiedades de solo lectura y solo escritura

Podemos declarar una propiedad que solo tiene un bloque get y no el set. Ese tipo de propiedad se denomina propiedad de solo lectura. Si creamos una propiedad de solo lectura, solo podemos leer el valor de un campo privado. Es bastante común crear una propiedad de solo lectura dentro de nuestra clase. Lo que queremos con él es establecerlo con el método constructor y luego usar su valor en toda la clase, pero nunca establecer su valor fuera del constructor . Si intentamos configurarlo, el compilador arrojará un error:

public string Name
{
    get { return _name; }
}

img01

De la misma manera, como podemos crear una propiedad de solo lectura, podemos crear una propiedad de solo escritura. Ese tipo de propiedad solo tiene el bloque set y no el get. No es un caso común crear propiedades de solo escritura. Eso sí, si lo necesitamos, solo podemos establecer los valores con este tipo de propiedad y no leerlo:

public string Name
{
    set { _name = value; }
}

img02

Accesibilidad de la propiedad

Podemos especificar un modificador de acceso para nuestra propiedad (pública, privada) si queremos restringir su disponibilidad. Pero en C# incluso podemos anular la accesibilidad de los accesos get o set. Entonces, lo que podemos hacer es declarar una propiedad pública que tiene el acceso público get y el acceso privado set. Si nuestra propiedad es pública, no tenemos que agregar la palabra clave pública para el descriptor de acceso get, será pública de todos modos:

public string Name
{
     get { return _name; }
     private set { _name = value; }
}

img03

Esto significa que podemos leer en todas las clases de nuestra propiedad Name, pero podemos configurarla solo dentro de la clase Student.

Cuando usamos un descriptor de acceso que sobrescribe dentro de la propiedad, debemos prestar atención a las siguientes reglas:

  • Podemos cambiar el nivel de accesibilidad de un solo acceso. No tiene sentido modificar ambos accesos. Si queremos modificar ambos accesos, simplemente deberíamos modificar el nivel de acceso a la propiedad.
  • No podemos usar el modificador de acceso en los bloques get o set que son menos restrictivos del modificador de acceso aplicado en una propiedad en sí. Entonces, si nuestra propiedad es privada, no tiene sentido que el público obtenga o establezca un bloqueo.

Propiedades implementadas automáticamente

Si no se requiere lógica adicional en un descriptor de acceso de propiedad, podemos usar las propiedades implementadas automáticamente para una forma más legible y concisa de declarar propiedades. La propiedad implementada automáticamente consta solo de las palabras clave get y set, nada más:

public string Name { get; set; }
public string LastName { get; set; }

Cuando declaramos las propiedades de esta manera, el compilador crea un campo privado para nosotros, al que solo se puede acceder a través de los descriptores de acceso get o set de la propiedad.

Entonces en nuestro ejemplo en lugar de:

private string _name;

public string Name
{
    get { return _name; }
    set { _name = value; }
}

Podemos simplemente escribir:

public string Name { get; set; }

En Visual Studio, incluso vamos a recibir una sugerencia para usar una propiedad automática:

img04