Maak een nieuwe Visual Studio solution Properties.

Maak in de solution Properties een nieuwe WPF Application WpfProperties

Voeg de bestaande class library Ivo.Hbo.Geometry toe aan je solution: rechtsklik de solution en kies Add > Existing Project... en blader naar de .csproj-file van dit project.

Maak een referentie vanuit WpfProperties naar Ivo.Hbo.Geometry

Properties of eigenschappen stellen de ontwikkelaar in staat om data af te schermen van oneigenlijk of verkeerd gebruik: data encapsulation.

• Open de klasse Circle in het bestand Circle.cs in het Ivo.Hbo.Geometry-project

  public int radius;
  

  Het veld radius is public, dit betekent dat je de waarde van radius rechtstreeks kan instellen vanuit je toepassing.
• Voorzie in Window1.xaml.cs een using statement voor Ivo.Hbo.Geometry
• In Window_Loaded tik je:

  Circle circle = new Circle();
  circle.radius = -5;
  MessageBox.Show(String.Format(
        "Cirkel met straal {0} en omtrek {1}",
        circle.radius.ToString(),
        Math.Round(circle.Circumference(),2).ToString()));
  
  

  

  Je krijgt geen compiletime noch runtime fout. We hebben radius gedeclareerd als int, het is binnen de context van een geheel getal volstrekt legaal om te werken met negatieve getallen.
  We weten echter dat een cirkel geen negatieve straal kan hebben, we kunnen dit niet toestaan!

  Data afschermen met een methode

• Je kan in de klasse Circle het field radius afschermen door het private te maken en een public methode SetRadius voorzien die voor de controle zorgt:

  public partial class Circle
  {
  	private int radius;
  
      public void SetRadius(int r)
      {
          if (r > 0) radius = r;
          else radius = 0;
      }
  ...
  

  Wanneer de opgegeven radius kleiner is dan 0, stellen we die in op 0
  Je zou natuurlijk ook Exception kunnen opwerpen.

• Opnieuw builden van de solution leert je nu dat radius niet meer toegankelijk is vanuit Window1: je krijgt compileerfouten
• Om de radius in te stellen kan je nu de methode SetRadius gebruiken:

  public partial class Window1 : Window
  {
      public Window1()
      {
          InitializeComponent();
      }
  
      private void Window_Loaded(object sender, RoutedEventArgs e)
      {
          Circle circle = new Circle();
          circle.SetRadius(-5);
          MessageBox.Show(String.Format(
                "Cirkel met straal {0} en omtrek {1}",
                circle.radius.ToString(),
                Math.Round(circle.Circumference(),2).ToString()));
      }
  }
  

  De tweede aangeduide lijn resulteert echter nog steeds in een compileerfout.
  Daar radius private is kunnen we die nu ook niet meer opvragen!

• Voorzie in de klasse Circle een methode GetRadius:

  public int GetRadius() { return radius; }
  

• In Window1.xaml.cs pas je de code aan:

  Circle circle = new Circle();
  circle.SetRadius(-5);
  MessageBox.Show(String.Format(
        "Cirkel met straal {0} en omtrek {1}",
        circle.GetRadius().ToString(),
        Math.Round(circle.Circumference(),2).ToString()));
  
  

  

  Zo merk je dat bij een negatieve radius deze door ons programma op 0 wordt ingesteld.

  Conclusie:

• Werken met publieke velden kan leiden tot verkeerd gebruikte data
• Werken met private velden en publieke getter- en settermethoden kan dit probleem oplossen
• De oplossing met deze methoden is omslachtig:
  • je moet voor elk field twee methoden bijmaken
  • Voor opvragen moet je steeds een methodeaanroep uitvoeren:

    circle.radius
    

    was eigenlijk toch gemakkelijker dan

    circle.GetRadius()
    

  • Voor aanpassen van de waarde moet je ook een methodeaanroep doen:

    circle.radius = -5;

    werd

    circle.SetRadius(-5);

Data afschermen met een Property

Een ideale oplossing voor dit probleem vormen properties of eigenschappen: je hebt de afscherming zoals met methoden, maar naar de buitenwereld toe kan je de data manipuleren zoals een field.

• Vervang de methoden SetRadius en GetRadius door:

  public int Radius
  {
      get { return radius; }
      set
      {
          if (value > 0) radius = value;
          else radius = 0;
      }
  }
  

  Hier hebben we de eigenschap Radius gedeclareerd.

  Het onderdeel get geeft aan wat er gebeurt wanneer de property wordt gelezen.
  Laat je dit onderdeel weg, dan kan de eigenschap niet uitgelezen worden, de property is Write-only
  Het onderdeel set geeft aan hoe de eigenschap wordt weggeschreven.
  In dit onderdeel kan je gebruik maken van het sleutelwoord value om te verwijzen naar de waarde waarop de property ingesteld wordt.
  Laat je dit onderdeel weg, dan kan de eigenschap niet gebruikt worden om een waarde te veranderen, de property is Read-only
  De naam van een field begint meestal met een kleine letter, die van properties met een hoofdletter.

  Opgepast, het field radius is hier nog steed nodig, de property Radius gaat dit field enkel afschermen tegen oneigenlijk gebruik.

Sommige ontwikkelaars zweren bij het gebruik van public properties die private fields afschermen. Het is dan ook een goede attitude om zelfs wanneer je voorlopig geen extra controle of andere bijkomstige code bij een field nodig hebt, dit field toch private te maken en een public field te voorzien: Daar een dergelijk stukje code heel dikwijls geschreven wordt, is het sinds C#3.0 mogelijk dit te verkorten: Dit codefragement maakt de property waarde, intern wordt deze verkorte schrijfwijze vertaald tot het voorbeeld erboven: het field en de get en set-implementatie van de property worden dus automatisch voorzien.
De property kan even eenvoudig worden aangemaakt als een field, maar je beschikt over een property die je later kan uitbreiden.
Starten met een field, en later overschakelen naar een property kan omslachtiger zijn.