Code Snippets (dt. = Codeausschnitt) sind einfache Vorlagen/Templates, die in Visual Studio via Shortcut eingefügt werden können. Solche Code snippets enthalten normalerweise häufig verwendete Codeblöcke , wie z.B. if-else- oder using-Blöcke, können aber auch zum Einfügen von kompletten Klassen oder Methoden verwendet werden. Der folgende Artikel zeigt ein Code Snippet um eine Prism-Eigenschaft via Shortcut zu erzeugen.
In WPF-Anwendungen ist die INotifyPropertyChanged-Schnittstelle von zentraler Bedeutung. Diese Schnittstelle hilft bei der Benachrichtigung anderer Instanzen bzgl. veränderter Properties. Besonders in WPF hilft diese Schnittstelle bei der Trennung zwischen Logik und UI, da erst durch die Implementierung dieser Schnittstelle die Anzeige bei Änderungen aktualisiert wird. Um diese Schnittstelle jetzt nicht immer wieder neu implementieren zu müssen wird die Implementierung oft in eine eigene Basisklasse ausgelagert. So auch in der Prism-Bibliothek. Dort gibt es eine abstrakte Klasse namens BindableBase, die in etwa den folgenden Aufbau hat:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
/// <summary> /// Implementation of <see cref="INotifyPropertyChanged"/> to simplify models. /// </summary> public abstract class BindableBase : INotifyPropertyChanged { /// <summary> /// Occurs when a property value changes. /// </summary> public event PropertyChangedEventHandler PropertyChanged; /// <summary> /// Checks if a property already matches a desired value. Sets the property and /// notifies listeners only when necessary. /// </summary> /// <typeparam name="T">Type of the property.</typeparam> /// <param name="storage">Reference to a property with both getter and setter.</param> /// <param name="value">Desired value for the property.</param> /// <param name="propertyName">Name of the property used to notify listeners. This /// value is optional and can be provided automatically when invoked from compilers that /// support CallerMemberName.</param> /// <returns>True if the value was changed, false if the existing value matched the /// desired value.</returns> protected virtual bool SetProperty<T>(ref T storage, T value, [CallerMemberName] string propertyName = null) { if (object.Equals(storage, value)) return false; storage = value; this.OnPropertyChanged(propertyName); return true; } /// <summary> /// Notifies listeners that a property value has changed. /// </summary> /// <param name="propertyName">Name of the property used to notify listeners. This /// value is optional and can be provided automatically when invoked from compilers /// that support <see cref="CallerMemberNameAttribute"/>.</param> protected virtual void OnPropertyChanged([CallerMemberName]string propertyName = null) { PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName)); } /// <summary> /// Raises this object's PropertyChanged event. /// </summary> /// <typeparam name="T">The type of the property that has a new value</typeparam> /// <param name="propertyExpression">A Lambda expression representing the property that has a new value.</param> protected virtual void OnPropertyChanged<T>(Expression<Func<T>> propertyExpression) { var propertyName = PropertySupport.ExtractPropertyName(propertyExpression); this.OnPropertyChanged(propertyName); } } |
Leitet man seine Klassen (Model- oder ViewModel-Klassen) von dieser Basisklasse ab, genügt es im Setter der jeweiligen Eigenschaft die SetProperty-Methode aufzurufen. Das sieht dann ungefähr so aus:
|
1 2 3 4 5 6 7 |
private string firstName = string.empty; public string FirstName { get { return firstName; } set { SetProperty(ref firstName, value); } } |
Die SetProperty-Methode prüft dann, ob sich die Eigenschaft geändert und löst dann gegenbenfalls das PropertyChanged-Event aus, so dass das UI angewiesen wird eine Aktualisierung durchzuführen. Eine weitere sehr nützliche Funktion der BindbaleBase-Klasse ist, dass man auch für andere Eigenschaften innerhalb der Klasse das PropertyChanged-Ereignis auslösen kann. Das ist vor allem dann nützlich, wenn man konkatenierte Werte (z.B. Vor- und Nachname einer Person) aktualisieren möchte. Dazu mal das folgende Beispiel:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
private string firstName; public string FirstName { get { return firstName; } set { if (SetProperty<string>(ref this.firstName, value)) { OnPropertyChanged(() => this.FullName); } } } private string lastName; public string LastName { get { return lastName; } set { if (SetProperty<string>(ref this.lastName, value)) { OnPropertyChanged(() => this.FullName); } } } public string FullName { get { return FirstName + " " + LastName; } } |
Die Erstellung einer solchen Eigenschaft mit der SetProperty-Methode kann ziemlich zeitaufwändig werden, je nachdem wie viele Eigenschaften erstellt werden sollen. Für die Erstellung einer solchen Eigenschaft kann das folgende Snippet verwendet werden:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
<?xml version="1.0" encoding="utf-8" ?> <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> <CodeSnippet Format="1.0.0"> <Header> <Title>Prism BindableBase property</Title> <Shortcut>propprism</Shortcut> <Description>Code snippet for property and backing field for classes deriving from Prism BindableBase</Description> <Author>Steffen Steinbrecher</Author> <SnippetTypes> <SnippetType>Expansion</SnippetType> </SnippetTypes> </Header> <Snippet> <Declarations> <Literal> <ID>type</ID> <ToolTip>Property type</ToolTip> <Default>int</Default> </Literal> <Literal> <ID>property</ID> <ToolTip>Property name</ToolTip> <Default>MyProperty</Default> </Literal> <Literal> <ID>field</ID> <ToolTip>The variable backing this property</ToolTip> <Default>myVar</Default> </Literal> </Declarations> <Code Language="csharp"><![CDATA[private $type$ $field$; public $type$ $property$ { get { return $field$;} set { SetProperty<$type$>(ref this.$field$, value); } } $end$]]> </Code> </Snippet> </CodeSnippet> </CodeSnippets> |
Das Snippet gibt es auch am Ende des Artikels zum Download.
Installation des Snippets
Innerhalb von Visual Studio gibt es den Code Snippet-Manager, der wie folgt erreicht werden kann:
Über den aufgehenden Dialog kann das Snippet dann über den Import-Button geladen werden:
Das Code snippet kann dann einfach über IntelliSense erreicht werden:
Danach einfach 2 x die TAB-Taste und die Eigenschaft wir angelegt. Änderungen am Datentyps werden dabei natürlich auch berücksichtigt und automatisch aktualisiert:
Hinweis:
Eine Übersicht über die standardmäßig ausgelieferten Visual Studio Code-Snippets ist hier zu finden: Visual C# Code Snippets
[wpdm_package id=’1037′]
Login