Kolumne: SharePoint ganz praktisch
Im letzten Teil der Kolumne wurden die Grundlagen des clientseitigen Objektmodells von SharePoint erläutert. Wie demonstriert wurde, ermöglicht diese JavaScript-basierte Zugriffsbibliothek einen einfachen Zugriff auf SharePoint-Daten und -Funktionen. Die heutige Kolumne zeigt, wie diese Bibliothek in Kombination mit Knockout verwendet werden kann.
Der Zugriff auf SharePoint-Daten und-Funktionen gestaltet sich mit dem clientseitigen Objektmodell (kurz: CSOM) sehr einfach. Im vorigen Teil der Kolumne wurden dazu die grundlegenden Operationen demonstriert. Das clientseitige Objektmodell bietet allerdings nur einen Weg, um auf SharePoint-Daten zuzugreifen und diese abzurufen oder auch zu verändern. Für die Darstellung und Präsentation der Daten bietet es zunächst keine weiteren Funktionen an. Dies ist auch nicht weiter tragisch, da für die Datendarstellung im JavaScript-Umfeld einige sehr gute Bibliotheken existieren. Eine dieser Bibliotheken ist das MVVM-basierte Webframework Knockout. Es basiert auf dem Model-View-ViewModel-Muster und ermöglicht eine lose Datenkopplung zwischen der Darstellung, die typischerweise durch HTML erfolgt, und den eigentlichen Daten. Daher ist dieses Webframework ideal für die gemeinsame Verwendung mit dem clientseitigen JavaScript-Objektmodell für SharePoint geeignet. Bei dieser Kombination ist die CSOM-Bibliothek für den Datenabruf zuständig und die Datenvisualisierung übernimmt die Knockout-Bibliothek. Im Folgenden wird gezeigt, wie eine Kontaktliste abgefragt, Einträge hinzugefügt und auch wieder gelöscht werden können.
Visual-Studio-Projekt vorbereiten
Im ersten Schritt wird wieder ein neues Visual-Studio-SharePoint-Projekt für die Erstellung der Beispielanwendung benötigt. Knockout in Kombination mit dem clientseitigen Objektmodell kann im Grunde in verschiedenen SharePoint-Lösungstypen – wie zum Beispiel in Sandkastenlösungen, SharePoint-Apps und voll vertrauenswürdigen Lösungen – verwendet werden, da es nur clientseitig zum Einsatz kommt. Die Beispielanwendung, die nun umgesetzt wird, wird innerhalb einer SharePoint-Anwendungsseite (Application Page) umgesetzt. Dazu wird zunächst ein neues Visual-Studio-Projekt angelegt (Abb. 1). Die Anlage der Anwendungsseite erfolgt unterhalb eines SharePoint-Ordners innerhalb von 15/_layouts. Dazu wird dem Projekt der SharePoint-Ordner _layouts hinzugefügt (Abb. 2). Unterhalb der _layouts-Struktur wird dann noch ein entsprechender Unterordner für das Projekt angelegt. Anschließend wird dem neuen Unterordner eine neue Anwendungsseite hinzugefügt (Abb. 3). Weiterhin wird die JavaScript-Bibliothek Knockout benötigt. Die benötigte JavaScript-Datei kann direkt von der Knockout-Projektseite [1] heruntergeladen werden. Anschließend wird diese JavaScript-Datei ebenfalls dem Projektunterordner unterhalb von _layouts hinzugefügt. Somit ist die Grundstruktur für das Projekt angelegt und für den weiteren Ausbau vorbereitet.

Abb. 1: Anlage eines neuen SharePoint-Projekts

Abb. 2: Hinzufügen des „_layouts“-Ordners zur Projektstruktur

Abb. 3: Hinzufügen einer Anwendungsseite
Datendarstellung mit Knockout
Als Beispielliste wird eine SharePoint-Kontaktliste verwendet. Diese muss im Vorfeld im entsprechenden (Entwicklungs-)Web angelegt werden. Um direkt Ergebnisse beim ersten Datenabruf zu sehen, sollte mindestens ein Kontakt der Liste manuell hinzugefügt werden. Die nun im oberen Abschnitt angelegte Anwendungsseite kann anschließend weiter ausgebaut werden. Damit die clientseitigen Funktionen verwendet werden können, sind zunächst einige JavaScript-Referenzen notwendig. Diese werden dem Inhaltsbereich PlaceHolderAdditionalPageHead hinzugefügt, wie Listing 1 entnommen werden kann. Danach kann mit der Umsetzung der JavaScript-Funktionen für den Datenabruf begonnen werden. Listing 2 zeigt dazu den gesamten notwendigen Code. Aus Gründen der Übersicht werden im Beispiel nur die Listenspalten „ID“, „Nachname“ (SharePoint-intern ist dies die Title-Spalte) und „Vorname“ (FirstName) bei der Liste berücksichtigt. Zu Beginn wird die Startmethode der HTML-Seite der Auflistung _spBodyOnLoadFunct...

