Eine Einführung für SharePoint-Entwickler. Praktische Übung

Transkript

1 Eine Einführung für SharePoint-Entwickler Praktische Übung Übungsanleitung SPCHOL303 Verwenden des Clientobjektmodells (OM) und von REST in einer.net-anwendung C#

2 Dieses Dokument wird "wie besehen" bereitgestellt. Die in diesem Dokument enthaltenen Informationen und Ansichten, einschließlich URLs und Verweise auf Internetwebsites, können ohne vorherige Ankündigung geändert werden. Das Risiko der Nutzung liegt bei Ihnen. Mit diesem Dokument werden keine Rechte an geistigem Eigentum an einem Microsoft-Produkt auf Sie übertragen. Sie sind berechtigt, dieses Dokument zu kopieren und für eigene interne Referenzzwecke zu nutzen Microsoft Corporation. Alle Rechte vorbehalten.

3 Inhalt SPCHOL303 VERWENDEN DES CLIENTOBJEKTMODELLS (OM) UND VON REST IN EINER.NET- ANWENDUNG... 2 Übungsziel... 2 Weitere Ressourcen... 2 Erste Schritte... 2 Anmelden beim virtuellen Computer... 2 Speicherorte... 2 Voraussetzungen für diese praktische Übung... 3 Kopieren von Codebeispielen aus einem Word-Dokument... 3 Codeausschnitte... 4 Übung 1: Erstellen einer WPF-Anwendung mithilfe des Clientobjektmodells... 5 Aufgabe 1: Erstellen einer neuen WPF.NET-Anwendung... 5 Aufgabe 2: Verwenden des Clientobjektmodells... 7 Übung 2: Erstellen einer Windows Forms-Anwendung mithilfe der SharePoint REST-Dienste Aufgabe 1: Erstellen einer neuen Windows Forms-Anwendung Aufgabe 2: Hinzufügen des WCF-Datendienstverweises für SharePoint-Listen Aufgabe 3: Zugreifen auf SharePoint-Listendaten Aufgabe 4: Aktualisieren der SharePoint-Listendaten Aufgabe 5: Überprüfen der aktualisierten Daten Übungszusammenfassung Seite 1

4 SPCHOL303 Verwenden des Clientobjektmodells (OM) und von REST in einer.net-anwendung Voraussichtliche Zeit zum Durcharbeiten dieser Übung: 30 Minuten Für diese Übungen sind Visual Studio 2010 und SharePoint Foundation 2010 erforderlich. Diese Anwendungen sind auf dem in dieser Übung verwendeten virtuellen Computer installiert. Übungsziel Das Clientobjektmodell bietet ein für SharePoint einheitliches und vollständiges Objektmodell für den Zugriff auf SharePoint-Websitedaten von Remoteclients aus. Durch Einbeziehen der Clientobjektmodell-Bibliothek können Entwickler SharePoint-Anwendungen schnellstmöglich entwickeln. Diese bietet einen vollständigen Zugriff auf SharePoint-Websitedaten. Ziel dieser praktischen Übung: Verwenden des neuen Clientobjektmodells Verwenden des neuen REST-API-Systems in SharePoint 2010 Weitere Ressourcen Zu dieser Übung gehören die folgenden weiteren Ressourcen: Diese Übungsanleitung SPCHOL303_Manual_CS.docx Dieses Dokument Quellcode Completed\CS\Ex1 Completed\CS\Ex2 Vervollständigter Übungsquellcode in C# Ressourcen Resources\CS Verschiedene andere im Verlauf dieser Übung verwendete Ressourcen Erste Schritte Anmelden beim virtuellen Computer Melden Sie sich beim virtuellen Computer als der folgende Benutzer an: Benutzername: Administrator Kennwort: Speicherorte Zu dieser praktischen Übung gehören verschiedene weitere Ressourcen an festen Speicherorten. Standardmäßig wird vorausgesetzt, dass C:\Content Packs\Packs\SharePoint 2010 Developer Labs 1.0\SUPPORTING FILES\SPCHOL303\Resources das Basisverzeichnis dieser praktischen Übung ist. Der standardmäßige Arbeitsordner für diese praktische Übung ist C:\SPHOLS\SPCHOL303. Seite 2

5 Voraussetzungen für diese praktische Übung 1. Wechseln Sie zum Basisverzeichnis Supporting Files\SPCHOL303\Resources dieser praktischen Übung, und führen Sie das PowerShell-Skript optimize.ps1 aus: Klicken Sie mit der rechten Maustaste auf optimize.ps1, und wählen Sie Mit PowerShell ausführen aus: Abbildung 1: Ausführen des PowerShell-Skripts Hierdurch wird ein PowerShell-Fenster zum Ausführen des Skripts geöffnet. Warten Sie ab, bis die Ausführung des PowerShell-Skripts beendet und das PowerShell-Fenster geschlossen wurde (was eine gewisse Zeit dauern kann): Abbildung 2: PowerShell-Fenster, in dem das Skript ausgeführt wird Kopieren von Codebeispielen aus einem Word-Dokument Das Kopieren und Einfügen von Code aus diesem Word-Dokument in Visual Studio ist nur bei Abschnitten mit formatiertem Code sicher. Beispiel: Console.WriteLine("Dieser Code ist sicher!"); Seite 3

6 Nicht in diesen Abschnitten enthaltener Code kann Unicode- oder andere unsichtbare Zeichen erhalten, die keinen gültigen XML- oder C#-/VB-Code darstellen. Beispiel: Console.WriteLine ( Dieser Code ist NICHT sicher!! ); Codeausschnitte Sie können auch mit Codeausschnitten arbeiten, um den in dieser Übung benötigten Code einzufügen. So verwenden Sie den für diese Übung benötigten Codeausschnitt Klicken Sie mit der rechten Maustaste an der Stelle auf die Codedatei, an der Sie den Codeausschnitt einfügen möchten. Wählen Sie Codeausschnitt einfügen aus. Abbildung 3: Einfügen des Codeausschnitts Wählen Sie im Katalog Eigene Codeausschnitte die benötigten Codeausschnitte aus. Seite 4

7 Übung 1: Erstellen einer WPF-Anwendung mithilfe des Clientobjektmodells In dieser Übung erstellen Sie eine WPF.NET-Anwendung, die für den Zugriff auf SharePoint-Daten das SharePoint-Clientobjektmodell verwendet. Aufgabe 1: Erstellen einer neuen WPF.NET-Anwendung In dieser Aufgabe erstellen Sie eine neue WPF.NET-Anwendung. 2. Öffnen Sie Visual Studio 2010, indem Sie im Startmenü Alle Programme, dann Microsoft Visual Studio 2010 und danach Microsoft Visual Studio 2010 auswählen. 3. Wählen Sie im Menü Datei die Option Neu und dann Projekt aus. 4. Wählen Sie im Dialogfeld Neues Projekt unter Installierte Vorlagen zunächst Visual C# und dann Windows aus. 5. Wählen Sie in der Liste die Vorlage WPF-Anwendung aus. Abbildung 4: WPF-Anwendungsprojekt 6. Geben Sie SPCHOL303-Ex1 in das Textfeld Name ein. Seite 5

8 7. Geben Sie C:\SPHOLS\SPCHOL303\CS\Ex1 in das Textfeld Speicherort ein. Abbildung 5: Visual Studio-Dialogfeld Neues Projekt 8. Deaktivieren Sie die Option Projektmappenverzeichnis erstellen. 9. Klicken Sie auf OK. 10. Das neue Projekt SPCHOL303-Ex1 und die notwendigen Dateien werden von Visual Studio erstellt. Abbildung 6: Projektmappen-Explorer Seite 6

9 Aufgabe 2: Verwenden des Clientobjektmodells 1. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf das Projekt SPCHOL303- Ex1, und wählen Sie Eigenschaften aus. 2. Ändern Sie auf der Registerkarte Anwendung die Eigenschaft Zielframework in.net Framework Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf Verweise, und wählen Sie Verweis hinzufügen... aus. Abbildung 7: Verweis hinzufügen 4. Wechseln Sie zur Registerkarte Durchsuchen. 5. Geben Sie den folgenden Pfad in das Textfeld Dateiname ein, und drücken Sie die EINGABETASTE: C:\Programme\Gemeinsame Dateien\Microsoft Shared\Web Server Extensions\14\ISAPI Seite 7

10 6. Wählen Sie Microsoft.SharePoint.Client.dll und Microsoft.SharePoint.Client.Runtime.dll aus, und klicken Sie auf OK. Abbildung 8: Dialogfeld Verweis hinzufügen 7. Doppelklicken Sie im Projektmappen-Explorer auf die Datei MainWindow.xaml, um die XAML- Ansicht zu öffnen. 8. Fügen Sie in der XAML-Ansicht den folgenden XAML-Code in das Element Grid ein. <ListBox Height="238" Margin="12,11,12,13" Name="ListBox1" Width="254" /> Mit diesem XAML-Code wird ein neues Steuerelement vom Typ ListBox erstellt. Seite 8

11 9. Das Listenfeld sollte der Entwurfsansicht hinzugefügt worden sein. Abbildung 9: Window1.xaml in der Entwurfsansicht 10. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf MainWindow.xaml, und wählen Sie Code anzeigen aus. Abbildung 10: Code anzeigen 11. Fügen Sie die folgenden using-anweisungen hinzu: using Microsoft.SharePoint.Client; using SP = Microsoft.SharePoint.Client; Codeausschnitte: Eigene Codeausschnitte spchol303_ex1_namespaces 12. Fügen Sie den folgenden Codeblock in den Window1-Konstruktor nach dem Aufruf der InitializeComponent()-Methode ein: ClientContext context = new ClientContext(" Web site = context.web; context.load(site, osite => osite.title); context.executequery(); Title = site.title; ListCollection lists = site.lists; IEnumerable<SP.List> listscollection = context.loadquery(lists.include(l => l.title, l => l.id)); context.executequery(); ListBox1.ItemsSource = listscollection; ListBox1.DisplayMemberPath = "Title"; Codeausschnitt: Eigene Codeausschnitte spchol303_ex1_constructor Seite 9

12 Dieser Codeblock hat folgende Aufgaben: Erstellen eines neuen Clientkontexts für die SharePoint-Website Abfragen der in der Website verfügbaren SharePoint-Listen und Abrufen der Listen zusammen mit ihren Eigenschaften Title und Id Binden der Listenauflistung an das WPF-Steuerelement ListBox 13. Drücken Sie F5, um das Debuggen der Anwendung zu starten. 14. Im Anwendungsfenster sollte das mit den verfügbaren SharePoint-Listen aufgefüllte Listenfeld zu sehen sein. Abbildung 11: Anwendungsfenster 15. Schließen Sie das Anwendungsfenster. In den letzten Minuten haben Sie mit dem neuen Clientobjektmodell von SharePoint eine WPF.NET- Anwendung zum Abrufen von SharePoint-Daten aus einer Website erstellt. Übung 2: Erstellen einer Windows Forms-Anwendung mithilfe der SharePoint REST-Dienste In dieser Übung greifen Sie in einer Windows Forms-Anwendung mithilfe des WCF-Datendiensts für SharePoint-Listen auf die Daten in einer SharePoint-Liste zu, um diese zu aktualisieren. Aufgabe 1: Erstellen einer neuen Windows Forms-Anwendung In dieser Aufgabe erstellen Sie eine neue Windows Forms-Anwendung. 1. Öffnen Sie Visual Studio 2010, indem Sie im Startmenü Alle Programme, dann Microsoft Visual Studio 2010 und danach Microsoft Visual Studio 2010 auswählen. 2. Wählen Sie im Menü Datei die Option Neu und dann Projekt aus. Seite 10

13 3. Wählen Sie im Dialogfeld Neues Projekt unter Installierte Vorlagen zunächst Visual C# und dann Windows aus. 4. Wählen Sie in den Projektvorlagen Windows Forms-Anwendung aus. Abbildung 12: Neues Windows Forms-Anwendungsprojekt 5. Geben Sie SPCHOL303-Ex2 in das Textfeld Name ein. 6. Geben Sie C:\SPHOLS\SPCHOL303\CS\Ex-2 in das Textfeld Speicherort ein. Abbildung 13: Visual Studio-Dialogfeld Neues Projekt Seite 11

14 7. Deaktivieren Sie die Option Projektmappenverzeichnis erstellen. 8. Klicken Sie auf OK. 9. Das neue Projekt SPCHOL303-Ex2 und die notwendigen Dateien werden von Visual Studio erstellt. Abbildung 14: SPCHOL303-Ex2 im Projektmappen-Explorer Aufgabe 2: Hinzufügen des WCF-Datendienstverweises für SharePoint-Listen In dieser Übung fügen Sie einen Verweis auf die neuen Datendienste für ADO.NET-Listen in SharePoint hinzu, um auf der lokalen SharePoint-Website auf Daten in der Liste Employees zuzugreifen. 1. Wählen Sie auf der oberen Menüleiste in Visual Studio Datei und dann Neue Datenquelle hinzufügen... aus. Abbildung 15: Neue Datenquelle hinzufügen Seite 12

15 2. Wählen Sie im Assistenten zum Konfigurieren von Datenquellen SharePoint aus, und klicken Sie auf die Schaltfläche Weiter >. Abbildung 16: Assistent zum Konfigurieren von Datenquellen 3. Geben Sie im Dialogfeld Dienstverweis hinzufügen die folgende URL in das Textfeld Adresse ein, und klicken Sie auf Gehe zu: Seite 13

16 4. Im linken Bereich Dienste des Dialogfelds sollte nun ein Dienst hinzugefügt worden sein (der Name kann variieren), und das Textfeld Namespace sollte ServiceReference1 enthalten. Die folgende Abbildung zeigt dies: Abbildung 17: Listendatendienst SharePoint-Webdienste sind im virtuellen Verzeichnis _vti_bin enthalten. Die Datei ListData.svc ist der SharePoint-Listendatendienst, der die REST-API verwendet. Mithilfe dieses Webdiensts können Sie über die REST-Schnittstelle mit SharePoint-Listendaten arbeiten. Seite 14

17 5. Klicken Sie auf TeamSiteDataContext, um den Eintrag zu erweitern und die verschiedenen Dienstelemente zu untersuchen: Abbildung 18: Dienstelemente 6. Klicken Sie auf OK. Seite 15

18 7. Klicken Sie im Assistenten zum Konfigurieren von Datenquellen auf Fertig stellen. Abbildung 19: Hinzugefügter Dienstverweis 8. Hierdurch wird der Dienstverweis der Projektmappe hinzugefügt: Abbildung 20: Dienstverweis Seite 16

19 Aufgabe 3: Zugreifen auf SharePoint-Listendaten 1. In dieser Aufgabe greifen Sie mithilfe des WCF-Datendiensts für SharePoint-Listen auf die Daten in der Liste Employees zu, um diese abzurufen. 2. Klicken Sie mit der rechten Maustaste auf Verweise, und wählen Sie Verweis hinzufügen... aus. 3. Wechseln Sie im Dialogfeld Dienstverweis hinzufügen zur Registerkarte.NET, und klicken Sie auf WindowsBase. 4. Klicken Sie auf OK. 5. Doppelklicken Sie im Projektmappen-Explorer auf Form1.cs. Dadurch wird der Formulardesigner geöffnet. 6. Klicken Sie im Visual Studio 2010-Menü auf Daten und dann auf Datenquellen anzeigen. Abbildung 21: Datenquellen anzeigen Seite 17

20 7. Hierdurch wird das Fenster Datenquellen mit dem in Aufgabe 2 hinzugefügten Dienstverweis und den in der Website verfügbaren SharePoint-Listen geöffnet. Die Datenquelle besteht aus den SharePoint-Listen und -Dokumentbibliotheken im Format des Entitätsdatenmodells. Klicken Sie auf das Nadelsymbol, um die Liste an einer freien Position zu fixieren. Abbildung 22: Datenquellenfenster 8. Verschieben Sie per Ziehen und Ablegen Employees aus dem Fenster Datenquellen in das Fenster Formular. Dadurch wird das Datenraster Employees in das Formular eingefügt. Passen Sie Höhe und Breite des Formulars und Datenrasters entsprechend an: Seite 18

21 Abbildung 23: Windows-Formularfenster und Datenraster Employees 9. Klicken Sie mit der rechten Maustaste auf das leere Datenraster Employees, und wählen Sie Spalten bearbeiten aus. Abbildung 24: Spalten bearbeiten Seite 19

22 10. Entfernen Sie im Fenster Spalten bearbeiten alle außer den folgenden drei Spalten. Wählen Sie zum Entfernen einer Spalte eine Spalte in der Liste Ausgewählte Spalten aus, und klicken Sie auf die Schaltfläche Entfernen: Fullname Job Title Team Abbildung 25: Fenster Spalten bearbeiten 11. Klicken Sie auf OK. Seite 20

23 12. Das Datenraster sollte nun mit den Änderungen angezeigt werden: Abbildung 26: Aktualisiertes Datenraster 13. Doppelklicken Sie im Designer auf die Titelleiste mit der Beschriftung Form1, um die Form1_Load- Methode hinzuzufügen (hierdurch wird die Codeansicht geöffnet): Abbildung 27: Form1_Load-Methode 14. Fügen Sie der CodeBehind-Datei die folgende using-anweisung hinzu: using SPCHOL303_Ex2.ServiceReference1; using System.Net; Codeausschnitt: Eigene Codeausschnitte spchol303_ex2_namespaces 15. Fügen Sie den folgenden Code unter der Deklaration der Form1-Klasse ein: TeamSiteDataContext context = new TeamSiteDataContext(new Uri(" Codeausschnitt: Eigene Codeausschnitte spchol303_ex2_context Seite 21

24 Abbildung 28: Datenkontext der Teamwebsite 16. Fügen Sie den folgenden Code in die Form1_Load-Methode ein: context.credentials = CredentialCache.DefaultCredentials; employeesbindingsource.datasource = context.employees; Codeausschnitt: Eigene Codeausschnitte spchol303_ex2_form_load 17. Drücken Sie F5, um das Debuggen der Anwendung zu starten. 18. Im Anwendungsfenster sollte das mit der Liste Employees aufgefüllte Datenraster zu sehen sein: Abbildung 29: Anwendungsfenster 19. Schließen Sie das Anwendungsfenster. In den vergangenen Minuten haben Sie erfahren, wie Sie mit dem neuen WCF-Datendienst für SharePoint-Listen auf die SharePoint-Listendaten zugreifen können. Aufgabe 4: Aktualisieren der SharePoint-Listendaten In dieser Aufgabe aktualisieren Sie den vollständigen Namen eines Mitarbeiters und speichern die Änderungen in der SharePoint-Website. 1. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf Form1.cs, und wählen Sie Ansicht-Designer aus. Seite 22

25 2. Klicken Sie im Datenraster Employees auf BindingNavigator. Abbildung 30: BindingNavigator 3. Klicken Sie im BindingNavigator mit der rechten Maustaste auf die Schaltfläche Speichern ( ), und wählen Sie Enabled aus. Abbildung 31: Aktivieren der Schaltfläche Speichern 4. Doppelklicken Sie im BindingNavigator auf die Schaltfläche Speichern, um die Save-Methode zu generieren: Abbildung 32: Save-Methode 5. Fügen Sie den folgenden Code in die employeesbindingnavigatorsaveitem_click-methode ein: context.savechanges(); Codeausschnitt: Eigene Codeausschnitte spchol303_ex2_save_method 6. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf Form1.cs, und wählen Sie Ansicht-Designer aus. 7. Klicken Sie unten im Entwurfsfenster mit der rechten Maustaste auf employeesbindingsource, und wählen Sie Eigenschaften aus: Abbildung 33: Eigenschaften von employeesbindingsource Seite 23

26 8. Klicken Sie im Fenster Eigenschaften auf das Symbol Ereignisse ( ). 9. Doppelklicken Sie auf das Ereignis CurrentItemChanged. Das Elementänderungsereignis wird in Visual Studio für employeesbindingsource generiert: Abbildung 34: employeesbindingsource_currentitemchanged-methode 10. Fügen Sie den folgenden Code in die employeesbindingsource_currentitemchanged-methode ein: context.updateobject(employeesbindingsource.current); Codeausschnitt: Eigene Codeausschnitte spchol303_ex2_item_changed 11. Drücken Sie F5, um das Debuggen der Anwendung zu starten. 12. Im Anwendungsfenster sollte die Liste Employees angezeigt werden. 13. Klicken Sie auf den ersten Mitarbeiter, und ändern Sie Fullname von Kim Abercrombie in Kim. Abbildung 35: Ändern des vollständigen Namens 14. Drücken Sie die EINGABETASTE, und klicken Sie auf die Schaltfläche Speichern ( ). 15. Die Änderungen an der Eigenschaft Fullname der ausgewählten Mitarbeiterin müssen nun in der SharePoint-Website gespeichert werden. 16. Schließen Sie das Anwendungsfenster. Aufgabe 5: Überprüfen der aktualisierten Daten In dieser Aufgabe werden in die Aufgabe 4 erfolgten Änderungen an den Mitarbeiterdaten überprüft. 1. Öffnen Sie Internet Explorer, und navigieren Sie zur folgenden SharePoint-Website: 2. Geben Sie die folgenden Informationen ein, wenn Sie aufgefordert werden, sich zu authentifizieren: Benutzername: Administrator Kennwort: pass@word1 Seite 24

27 3. Klicken Sie im linken Navigationsbereich auf Employees, um die Liste Employees zu öffnen: Abbildung 36: Linker Navigationsbereich 4. Die aktualisierte Mitarbeiterin Kim sollte nun angezeigt werden: Abbildung 37: Aktualisierter Eintrag in der Liste Employees In den letzten Minuten haben Sie gelernt, wie Sie einen Listeneintrag in einer Clientanwendung aktualisieren und die Änderungen von der SharePoint-Website übernehmen lassen. Übungszusammenfassung In dieser praktischen Übung haben Sie die folgenden Aufgaben ausgeführt: Erstellen einer WPF-Anwendung mithilfe des Clientobjektmodells Erstellen einer Windows Forms-Anwendung mithilfe der SharePoint REST-Dienste Aktualisieren eines Listeneintrags in der Windows Forms-Anwendung und Speichern der Änderungen in der SharePoint-Website In dieser praktischen Übung wurde veranschaulicht, wie Windows-Clientanwendungen geschrieben werden, die über das neue Clientobjektmodell und den WCF-Datendienst für SharePoint-Listen auf SharePoint-Listendaten zugreifen. Seite 25