Erste Schritte der Verwendung des Clientobjektmodells mit externen Daten in SharePoint

Artikel
03/21/2023

Erfahren Sie, wie Sie das SharePoint-Clientobjektmodell für die Arbeit mit Business Connectivity Services (BCS) in SharePoint verwenden.

Was ist das SharePoint-Clientobjektmodell?

Das Clientobjektmodell für SharePoint setzt sich aus clientbasierten Bibliotheken zusammen, die das Serverobjektmodell darstellen. Sie werden in drei verschiedene DLL-Dateien verpackt, damit sie eine Vielzahl von Entwicklungstypen berücksichtigen können. Das Clientobjektmodell enthält die meisten wesentlichen Funktionen der Server-API. Dies ermöglicht den Zugriff auf die gleichen Funktionstypen von browserbasierten Skripts und .NET-Webanwendungen und Silverlight-Anwendungen.
Zur Verbesserung und Erweiterung der Funktionen für die Arbeit mit externen Daten wurde das Clientobjektmodell in Business Connectivity Services (BCS) um zusätzliche Funktionalitäten erweitert.

Erste Schritte der Verwendung des SharePoint-Clientobjektmodells mit externen Daten

Zur Entwicklung von Lösungen mithilfe des SharePoint-Client-Objektmodells (CSOM) benötigen Sie Folgendes:

SharePoint
Visual Studio 2012
Office Developer Tools für Visual Studio 2012

Informationen zum Einrichten Ihrer Entwicklungsumgebung finden Sie unter Einrichten einer Entwicklungsumgebung für BCS in SharePoint.

Zum Zugreifen auf die vom Clientobjektmodell bereitgestellten Funktionen müssen Sie nur Verweise auf Microsoft.SharePoint.Client.Runtime.dll- und Microsoft.SharePoint.Client.dll-Dateien in den Projekten hinzufügen. Sie können auch das Clientobjektmodell verwenden, indem Sie auf die folgenden DLL-Dateien im globalen Assemblycache verweisen:

\\Program Files\\Common Files\\Microsoft Shared\\Web Server Extensions\\15\\isapi\\Microsoft.SharePoint.Client.Runtime.dll
\\Program Files\\Common Files\\Microsoft Shared\\Web Server Extensions\\15\\isapi\\Microsoft.SharePoint.Client.dll

SharePointGrundlegendes zum Clientobjektmodell

Die folgenden Artikel helfen Ihnen dabei, das Clientobjektmodell in SharePoint zu verstehen.

Tabelle 1. Grundlegende Konzepte zum Verständnis des Clientobjektmodell

Artikel	Beschreibung
Externe Inhaltstypen in SharePoint	Erfahren Sie, welche Möglichkeiten Ihnen externe Inhaltstypen bieten, und was Sie benötigen, um mit deren Erstellung in SharePoint zu beginnen.
Verwenden von OData-Quellen mit Business Connectivity Services in SharePoint	Informationen zu den ersten Schritten bei der Erstellung externer Inhaltstypen auf der Basis von OData-Quellen und der Verwendung dieser Daten in SharePoint- oder Office 2013-Komponenten.
Auswählen des richtigen API-Satzes in SharePoint	Erfahren Sie mehr über die verschiedenen API-Gruppen, die in SharePoint bereitgestellt werden, einschließlich des Serverobjektmodells, der verschiedenen Clientobjektmodellen und des REST/OData-Webdiensts.
.NET-Client-API-Referenz für SharePoint	Hier finden Sie Informationen zu den .NET Client-Klassenbibliotheken in SharePoint.
JavaScript-API-Referenz für SharePoint	Informationen zu den JavaScript-Objektbibliotheken in SharePoint.

Welche Verwendungsmöglichkeiten bietet das Clientobjektmodell?

Sie können das SharePoint-Clientobjektmodell zum Abrufen, Aktualisieren und Verwalten von Daten in SharePoint verwenden. SharePoint bietet die Clientbibliotheken in verschiedenen Formaten, um den Anforderungen der meisten Entwickler gerecht zu werden. Für Webentwickler, die Skriptsprachen verwenden, wird die Clientbibliothek inJavaScript angeboten. Für .NET-Entwickler wird sie als .NET-clientverwaltete DLL-Datei angeboten. Für Entwickler von Silverlight-Anwendungen wird die Clientbibliothek als Silverlight-DLL-Datei bereitgestellt.

Weitere Informationen über Verwendungsmöglichkeiten des Clientobjektmodells in SharePoint finden Sie in den in Tabelle 2 aufgeführten Artikeln.

Tabelle 2. Allgemeine Aufgaben beim Verwenden des Clientobjektmodells mit externen Daten

Aufgabe	Beschreibung
Ausführen grundlegender Vorgänge unter Verwendung von SharePoint-Clientbibliothekscode	Hier erfahren Sie, wie Sie Code zum Ausführen grundlegender Vorgänge mit dem SharePoint-Clientobjektmodell schreiben.
Vorgehensweise: Verwenden Sie die Code-Clientbibliothek Zugriff auf externe Daten in SharePoint	In diesem Artikel erfahren Sie, wie Sie das SharePoint-Clientobjektmodell verwenden, um mit SharePoint BCS-Objekten mithilfe von browserbasierten Skripts zu arbeiten.

Im folgenden werden einige Beispiele für allgemeine Aufgaben aufgeführt, die Sie mit dem Clientobjektmodell (CSOM) durchführen können.

Abrufen einer bestimmten Entität

In diesem Beispiel wird gezeigt, wie Sie Kontext aus SharePoint abrufen und dann eine bestimmte Datenquellenentität abrufen.


ClientContext ctx = new ClientContext("http://sharepointservername"); 
Web web = ctx.Web; 
ctx.Load(web); 
Entity entity = ctx.Web.GetEntity("http://sharepointservername", "EntityName"); 
ctx.Load(entity); 
ctx.ExecuteQuery();

Erstellen einer generischen aufrufenden Instanz

In diesem Beispiel wird gezeigt, wie Sie eine generische aufrufende Instanz schreiben, damit Sie ein Entitätsobjekt für die Verwendung innerhalb des Codes erstellen können.

LobSystem lobSystem = entity.GetLobSystem();
ctx.Load(lobSystem);

LobSystemInstanceCollection lobInstances = lobSystem.GetLobSystemInstances();
ctx.Load(lobInstances);
ctx.ExecuteQuery();

LobSystemInstance lsi;
foreach(LobSystemInstance lobInstance in lobInstances)
{
  if (lobInstance.Name.CompareTo("MyLOBSystemInstance") == 0)
  {
    lsi = lobInstance;
  }
}

if (null != lsi)
{
  entity.Execute("MethodInstanceName", lsi, Array.Empty<object>()); 
  ctx.Load(myObj); 
  ctx.ExecuteQuery();
}

Abrufen von seitennummerierten Resultsets

Das folgende Beispiel zeigt, wie sie ein gefiltertes, seitennummeriertes Dataset abrufen. In diesem Fall beträgt der Seitenwert 50.


// Find filters for given Method Name. 
FilterCollection fCollection = entity.GetFilters("methodName"); 
ctx.Load(fCollection); 
ctx.ExecuteQuery(); 

fCollection.SetFilterValue("X.Y.Z.Country", 0, "India")
// Assuming that the "RowLimit" filter has the Limit filter type
fCollection.SetFilterValue("RowLimit", 0, 50)

EntityInstanceCollection eCollection = entity.FindFiltered(fCollection, 
"nameOfFinder", lsi); 
ctx.ExecuteQuery();

Abfragen gefilterter Informationen

Im folgenden Beispiel wird veranschaulicht, wie Sie ein gefiltertes Resultset zurückgeben können. In diesem Fall werden die Daten nach dem Feld X.Y.Z.Country gefiltert. Der Code such nach allen Elementen mit dem Wert „Indien" und fasst diese dann in einer Sammlung zusammen.


// Find filters for given Method Name. 
FilterCollection fCollection = entity.GetFilters("methodName"); 
ctx.Load(fCollection); 
ctx.ExecuteQuery(); 

fCollection.SetFilterValue("X.Y.Z.Country", 0, "India")

EntityInstanceCollection eCollection = entity.FindFiltered(fCollection, 
"nameOfFinder", lsi); 
ctx.ExecuteQuery();

Weiterführendes: Weitere Informationen zum Clientobjektmodell

Weitere Informationen zur Verwendung des Clientobjektmodells in SharePoint, finden Sie in Tabelle 3.

Tabelle 3. Erweiterte Konzepte für das Clientobjektmodell

Artikel	Beschreibung
BCS-Client-Objektmodellreferenz für SharePoint	Zusammenfassung der für das Erstellen clientseitiger Skripts verfügbaren Objekte unter Verwendung des SharePoint-Clientobjektmodells für den Zugriff auf externe von BCS zur Verfügung gestellte Daten.

Freigeben über