FieldCollection.AddFieldAsXml - Méthode

Article
05/05/2016

Crée un champ basé sur le schéma spécifié, de type booléen et options pour les champs.

Espace de noms : Microsoft.SharePoint.Client
Assemblys : Microsoft.SharePoint.Client.Silverlight (dans Microsoft.SharePoint.Client.Silverlight.dll); Microsoft.SharePoint.Client.Phone (dans Microsoft.SharePoint.Client.Phone.dll) Microsoft.SharePoint.Client (dans Microsoft.SharePoint.Client.dll)

Syntaxe

'Déclaration
Public Function AddFieldAsXml ( _
    schemaXml As String, _
    addToDefaultView As Boolean, _
    options As AddFieldOptions _
) As Field
'Utilisation
Dim instance As FieldCollection
Dim schemaXml As String
Dim addToDefaultView As Boolean
Dim options As AddFieldOptions
Dim returnValue As Field

returnValue = instance.AddFieldAsXml(schemaXml, _
    addToDefaultView, options)

public Field AddFieldAsXml(
    string schemaXml,
    bool addToDefaultView,
    AddFieldOptions options
)

Paramètres

schemaXml
Type : System.String

Une chaîne de langage CAML (Collaborative Application Markup Language) qui contient le schéma.

une référence Null (Rien dans Visual Basic)ne doit pas être. Il ne doit pas être vide. Il doit être une chaîne de langage CAML (Collaborative Application Markup Language) valide par rapport au schéma spécifié dans [MS-WSSFO2], section 2.2.9.3.3.1.

addToDefaultView
Type : System.Boolean

Spécifie pour ajouter le champ à l'affichage de liste par défaut.

true si le champ est ajouté à l'affichage de liste par défaut ; dans le cas contraire, false.

options
Type : Microsoft.SharePoint.Client.AddFieldOptions

Valeur AddFieldOptions indiquant les options du champ.

Valeur renvoyée

Type : Microsoft.SharePoint.Client.Field
Un objet Field qui représente le nouveau champ.

Exceptions

Exception	Condition
SPException	Un ou plusieurs types de champs ne sont pas installés correctement, la formule est vide pour le type de champ calculé, ou une erreur est survenue pendant le traitement du contenu XML spécifié. Code d'erreur :-2146232832. Un ou plusieurs types de champs ne sont pas installés correctement. Code d'erreur :-2130575340. Formule est vide pour le type de champ calculé. Code d'erreur :-2130575199.
SPQueryThrottledException	La limite est atteint. Code d'erreur :-2147024860. Il existe une défaillance de limitation de jointure. Code d'erreur :-2147024749.
ArgumentException	Le champ avec le nom interne spécifié ou le titre n'existe pas dans la collection de sites à la portée donnée. Code d'erreur :-2147024809.
UnauthorizedAccessException	L'utilisateur actuel dispose des autorisations suffisantes. Code d'erreur : -2147024891.

Exemples

Cet exemple de code crée un champ en fonction des informations de schéma, puis affiche les champs disponibles dans la liste Annonces, y compris le nouveau champ.

using System;
using Microsoft.SharePoint.Client;

namespace Microsoft.SDK.SharePointFoundation.Samples
{
    class AddFieldAsXmlExample
    {
        static void Main()
        {
            string siteUrl = "http://MyServer/sites/MySiteCollection";

            ClientContext clientContext = new ClientContext(siteUrl);
            Web site = clientContext.Web;
            List targetList = site.Lists.GetByTitle("Announcements");
            FieldCollection collField = targetList.Fields;

            string fieldSchema = "<Field Type='Text' DisplayName='NewField' Name='NewField' />";
            collField.AddFieldAsXml(fieldSchema, true, AddFieldOptions.AddToDefaultContentType);

            clientContext.Load(collField);
            clientContext.ExecuteQuery();

            Console.WriteLine("NewField added to Announcements list.\n\nThe following fields are available:\n\n");
            foreach (Field myField in collField)
               Console.WriteLine(myField.Title);
        }
    }
}

Voir aussi

Référence

FieldCollection classe

FieldCollection - Membres

Microsoft.SharePoint.Client - Espace de noms

Partager via