Erste Schritte der Verwendung des Clientobjektmodells mit externen Daten in SharePointGet started using the client object model with external data in SharePoint

Erfahren Sie, wie Sie das SharePoint-Clientobjektmodell für die Arbeit mit Business Connectivity Services (BCS) in SharePoint verwenden.Learn how to use the SharePoint client object model to work with Business Connectivity Services (BCS) in SharePoint.

Was ist das SharePoint-Clientobjektmodell?What is the SharePoint client object model?

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.The client object model for SharePoint is a set of client-based libraries that represent the server object model. They are packaged in three different DLLs to accommodate a variety of development types. The client object model includes most of the major functions of the server API. This allows access to the same types of functionality from browser scripting and also .NET web applications and Silverlight applications.
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.To enhance and expand the capabilities for working with external data, Business Connectivity Services (BCS) has expanded the client object model to include additional functionality.

Get set up   Get to work   Learn more

Erste Schritte der Verwendung des SharePoint-Clientobjektmodells mit externen DatenGet started using the SharePoint client object model with external data

Zur Entwicklung von Lösungen mithilfe des SharePoint-Client-Objektmodells (CSOM) benötigen Sie Folgendes:To develop solutions using the SharePoint client object model (CSOM), you will need the following:

  • SharePointSharePoint

  • Visual Studio 2012Visual Studio 2012

  • Office Developer Tools für Visual Studio 2012Office Developer Tools for Visual Studio 2012

Informationen zum Einrichten Ihrer Entwicklungsumgebung finden Sie unter Einrichten einer Entwicklungsumgebung für BCS in SharePoint.For information about how to set up your development environment, see Setting up a development environment for 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:To access the capabilities provided by the client object model, you need only to add references to the Microsoft.SharePoint.Client.Runtime.dll and Microsoft.SharePoint.Client.dll files in their projects. You can also use the client object model by referencing the following DLLs in the global assembly cache:

  • \\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 ClientobjektmodellSharePoint client object model essentials

Die folgenden Artikel helfen Ihnen dabei, das Clientobjektmodell in SharePoint zu verstehen.The following articles will help you understand more about the client object model in SharePoint.

Tabelle 1. Grundlegende Konzepte zum Verständnis des ClientobjektmodellTable 1. Core concepts for understanding the client object model

ArtikelArticle BeschreibungDescription
Externe Inhaltstypen in SharePointExternal content types in SharePoint
Erfahren Sie, welche Möglichkeiten Ihnen externe Inhaltstypen bieten, und was Sie benötigen, um mit deren Erstellung in SharePoint zu beginnen.Learn what you can do with external content types and what you need to start creating them in SharePoint.
Verwenden von OData-Quellen mit Business Connectivity Services in SharePointUsing OData sources with 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.Provides information to help get started creating external content types based on OData sources and using that data in SharePoint or Office 2013 components.
Auswählen des richtigen API-Satzes in SharePointChoose the right API set 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.Learn about the several sets of APIs that are provided in SharePoint, including the server object model, the various client object models, and the REST/OData web service.
.NET-Client-API-Referenz für SharePoint.NET client API reference for SharePoint Online
Hier finden Sie Informationen zu den .NET Client-Klassenbibliotheken in SharePoint.Find information about the .NET client class libraries in SharePoint.
JavaScript-API-Referenz für SharePointJavaScript API reference for SharePoint
Informationen zu den JavaScript-Objektbibliotheken in SharePoint.Find information about the JavaScript object libraries in SharePoint.

Welche Verwendungsmöglichkeiten bietet das Clientobjektmodell?What can you do with the client object model?

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.You can use the SharePoint client object model to retrieve, update, and manage data that is contained in SharePoint. SharePoint offers the client libraries in different formats to accommodate most developers. For web developers who are using scripting languages, the client library is offered in JavaScript. For .NET developers, it is offered as a .NET client managed DLL. For developers of Silverlight applications, the client library is provided by a Silverlight DLL.

Weitere Informationen über Verwendungsmöglichkeiten des Clientobjektmodells in SharePoint finden Sie in den in Tabelle 2 aufgeführten Artikeln.See the articles in Table 2 for more information about what you can do with the client object model in SharePoint.

Tabelle 2. Allgemeine Aufgaben beim Verwenden des Clientobjektmodells mit externen DatenTable 2. Basic tasks for using the client object model with external data

TaskTask BeschreibungDescription
Ausführen grundlegender Vorgänge unter Verwendung von SharePoint-ClientbibliothekscodeComplete basic operations using SharePoint client library code
Hier erfahren Sie, wie Sie Code zum Ausführen grundlegender Vorgänge mit dem SharePoint-Clientobjektmodell schreiben.Learn how to write code to perform basic operations with the SharePoint client object model.
Vorgehensweise: Verwenden Sie die Code-Clientbibliothek Zugriff auf externe Daten in SharePointHow to: Use the client code library to access external data in SharePoint
In diesem Artikel erfahren Sie, wie Sie das SharePoint-Clientobjektmodell verwenden, um mit SharePoint BCS-Objekten mithilfe von browserbasierten Skripts zu arbeiten.Learn how to use the SharePoint client object model to work with SharePoint BCS objects using browser-based scripting.

Im folgenden werden einige Beispiele für allgemeine Aufgaben aufgeführt, die Sie mit dem Clientobjektmodell (CSOM) durchführen können.The following are some basic examples of tasks you can accomplish using CSOM.

Abrufen einer bestimmten EntitätGet a specific entity

In diesem Beispiel wird gezeigt, wie Sie Kontext aus SharePoint abrufen und dann eine bestimmte Datenquellenentität abrufen.This example shows how to get context from SharePoint, and then retrieve a specified data source entity.


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 InstanzCreate a generic invoker

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.This example shows how to write a generic invoker so that you can create an entity object to work within your code.


ObjectCollection myObj; 
entity.Execute("MethodInstanceName", lsi, myObj); 
ctx.Load(myObj); 
ctx.ExecuteQuery(); 

Abrufen von seitennummerierten ResultsetsRetrieve paged result sets

Das folgende Beispiel zeigt, wie sie ein gefiltertes, seitennummeriertes Dataset abrufen. In diesem Fall beträgt der Seitenwert 50.The following example shows how to retrieve a filtered, paged dataset. In this case, the page value is 50.


// Find filters for given Method Name. 
FilterCollection fCollection = entity.GetFilters("methodName"); 
ctx.Load(fCollection); 
ctx.ExecuteQuery(); 
FilterCollection modifiedFCollection = new FilterCollection(); 
foreach( Filter filter in fCollection) 
{ 
    if( filter.FilterField.equals("X.Y.Z.Country")) 
    { 
        filter.FilterValue = "India"; 
        modifiedFCollection.Add(Filter); 
    } 
    if(filter.FilterType == FilterType.Limit) 
    { 
        filter.FilterValue = 50; 
        modifiedFCollection.Add(Filter); 
    } 
} 
EntityInstanceCollection eCollection = entity.FindFiltered(modifiedFCollection, 
"nameOfFinder", lsi); 
ctx.ExecuteQuery(); 

Abfragen gefilterter InformationenQuery for filtered information

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.The following example demonstrates how to return a filtered result set. In this case, the data column filtered is the X.Y.Z.Country field. The code looks for anything with the value of "India", and then puts that into a collection.


// Find filters for given Method Name. 
FilterCollection fCollection = entity.GetFilters("methodName"); 
ctx.Load(fCollection); 
ctx.ExecuteQuery(); 
FilterCollection modifiedFCollection = new FilterCollection(); 
foreach( Filter filter in fCollection) 
{ 
    if( filter.FilterField.equals("X.Y.Z.Country")) 
    { 
        filter.FilterValue = "India"; 
        modifiedFCollection.Add(Filter); 
    } 
} 
EntityInstanceCollection eCollection = entity.FindFiltered(modifiedFCollection, 
"nameOfFinder", lsi); 
ctx.ExecuteQuery(); 

Weiterführendes: Weitere Informationen zum ClientobjektmodellBeyond the basics: Learn more about the client object model

Weitere Informationen zur Verwendung des Clientobjektmodells in SharePoint, finden Sie in Tabelle 3.For more information about using the client object model in SharePoint, see the information in Table 3.

Tabelle 3. Erweiterte Konzepte für das ClientobjektmodellTable 3. Advanced concepts for the client object model

ArtikelArticle BeschreibungDescription
BCS-Client-Objektmodellreferenz für SharePointBCS client object model reference for 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.Summarizes the objects available for creating client-side scripts using the SharePoint client object model to access external data exposed by BCS.

Siehe auchSee also