Commencer à utiliser le modèle objet client avec des données externes dans SharePoint

Article
03/21/2023

Découvrez comment utiliser le modèle objet client SharePoint pour travailler avec Business Connectivity Services (BCS) dans SharePoint.

Qu’est-ce que le modèle objet client SharePoint ?

Le modèle objet client pour SharePoint est un ensemble de bibliothèques clientes qui représentent le modèle objet serveur. Qu'ils sont regroupés dans les trois DLL différentes pour prendre en charge une variété de types de développement. Le modèle objet client inclut la plupart des principales fonctions de l'API du serveur. Cela permet d'accéder aux mêmes types de fonctionnalités à partir d'écriture de scripts navigateur et également des applications web .NET et Silverlight.
Pour améliorer et développer les capacités pour travailler avec des données externes, Business Connectivity Services (BCS) a développé le modèle objet client afin d'inclure des fonctionnalités supplémentaires.

Prise en main du modèle objet client SharePoint avec des données externes

Pour développer des solutions à l'aide du modèle d'objet client SharePoint (CSOM), vous devez les éléments suivants :

SharePoint
Visual Studio 2012
Outils de développement Office pour Visual Studio 2012

Pour plus d’informations sur la configuration de votre environnement de développement, voir Configuration d’un environnement de développement pour BCS dans SharePoint.

Pour accéder aux fonctionnalités fournies par le modèle objet client, vous devez uniquement ajouter des références aux fichiers Microsoft.SharePoint.Client.Runtime.dll et Microsoft.SharePoint.Client.dll dans leurs projets. Vous pouvez également utiliser le modèle objet client en faisant référence aux DLL dans le global assembly cache suivantes :

\\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

Principes fondamentaux du modèle objet client SharePoint

Les articles suivants vous aideront à en savoir plus sur le modèle objet client dans SharePoint.

Tableau 1. Concepts de base pour comprendre le modèle objet client

Article	Description
Types de contenus externes dans SharePoint	Découvrez les fonctions des types de contenu externe et les éléments nécessaires à leur création dans SharePoint.
À l'aide de sources d'OData avec les Services Business Connectivity dans SharePoint	Fournit des informations pour vous aider à créer des types de contenu externes basés sur des sources OData et à utiliser ces données dans les composants SharePoint ou Office 2013.
Choisir l'ensemble d'API approprié dans SharePoint	Découvrez les différents ensembles d’API fournis dans SharePoint, notamment le modèle objet serveur, les différents modèles objet clients et le service web REST/OData.
Référence d’API client .NET pour SharePoint	Recherchez des informations sur les bibliothèques de classes clientes .NET dans SharePoint.
Informations de référence sur l’API JavaScript pour SharePoint	Recherchez des informations sur les bibliothèques d’objets JavaScript dans SharePoint.

Que pouvez-vous faire avec le modèle objet client ?

Vous pouvez utiliser le modèle objet client SharePoint pour récupérer, mettre à jour et gérer les données contenues dans SharePoint. SharePoint propose le client de bibliothèques dans différents formats pour prendre en charge la plupart des développeurs. Pour les développeurs web qui utilisent des langages de script, la bibliothèque cliente est proposée en JavaScript. Pour les développeurs .NET, il est fourni comme un client .NET managé DLL. Pour les développeurs d'applications de Silverlight, la bibliothèque cliente est fournie par une Silverlight DLL.

Pour plus d’informations sur ce que vous pouvez faire avec le modèle objet client dans SharePoint, consultez les articles du tableau 2.

Tableau 2. Tâches de base pour l’utilisation du modèle objet client avec des données externes

Tâche	Description
Effectuer des opérations de base avec du code de bibliothèque client dans SharePoint	Découvrez comment écrire du code pour effectuer des opérations de base avec le modèle objet client SharePoint.
Comment : utiliser la bibliothèque de code client pour accéder aux données externes dans SharePoint	Découvrez comment utiliser le modèle objet client SharePoint pour travailler avec des objets BCS SharePoint à l’aide de scripts basés sur un navigateur.

Voici quelques exemples de base de tâches que vous pouvez accomplir à l'aide de CSOM.

Obtenir une entité spécifique

Cet exemple montre comment obtenir le contexte à partir de SharePoint, puis récupérer une entité de source de données spécifiée.


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();

Créer un demandeur générique

Cet exemple montre comment écrire un demandeur générique afin que vous pouvez créer un objet entité de travailler au sein de votre code.

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();
}

Récupérer des jeux de résultats paginé

L'exemple suivant montre comment récupérer un jeu de données filtrée, paginée. Dans ce cas, la valeur de la page est 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();

Requête pour les informations filtrées

L'exemple suivant montre comment renvoyer un ensemble de résultats filtrés. Dans ce cas, la colonne de données filtrée est le champ X.Y.Z.Country. Le code se présente tous les éléments avec la valeur de « Inde » et qui met ensuite dans une collection.


// 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();

Aller : en savoir plus sur le modèle objet client

Pour plus d’informations sur l’utilisation du modèle objet client dans SharePoint, consultez les informations du tableau 3.

Tableau 3. Concepts avancés pour le modèle objet client

Article	Description
Référence du modèle BCS client objet SharePoint	Résume les objets disponibles pour la création de scripts côté client à l’aide du modèle objet client SharePoint pour accéder aux données externes exposées par BCS.

Share via