Check if a List Column Exists using SharePoint Client Object Model?

Question

Using the Client Object Model (C#) in SharePoint 2010, how can I determine if a specified column (field) name exists in a given List?

Thanks, MagicAndi.

score 12 · Answer 1 · answered Mar 19 '12 at 15:47

Just found this while searching for the same thing, but it looks like Sharepoint 2010 has something built in for this, at least for the Server model: list.Fields.ContainsField("fieldName");

Not sure if it exists for Client side though. Figured it would be a good place to store this information however.

score 7 · Answer 2 · edited Oct 02 '14 at 21:24

7

Server Object Model

string siteUrl = "http://mysite";
using (SPSite site = new SPSite(siteUrl))
{
    using (SPWeb web = site.OpenWeb())
    {
        SPList list = web.Lists["my forum"];
        for (int i = 0; i < list.Fields.Count; i++)
        {
            if (list.Fields[i].Title == "xyz")
            {
                -
                -
            }
        }
    }
}

Client Object Model

string siteUrl = "http://MyServer/sites/MySiteCollection";
ClientContext clientContext = new ClientContext(siteUrl);
SP.List List = clientContext.Web.Lists.GetByTitle("my forum");
for (int i = 0; i < list.Fields.Count; i++)
{
    if (list.Fields[i].Title == "xyz")
    {
        -
        -
    }
}

edited Oct 02 '14 at 21:24

EtherDragon

2,629
1
16
24

answered Dec 09 '10 at 18:32

Ashutosh Singh-MVP SharePoint

5,298
5
24
42

It is server object model in your example – axk Dec 09 '10 at 19:16
their is no much difference in both codes except the client context – Ashutosh Singh-MVP SharePoint Dec 10 '10 at 06:20
Ashutosh, you could remove a lot of the boilerplate code above by using a lambda operator to query the fields collection. – MagicAndi Dec 11 '10 at 21:35
That client object model code won't work as written as nothing is loaded by context.load() and context.executequery() before its used. – Ryan Jun 28 '13 at 15:16
I added a suggested edit in the Server Object Model example to follow MSDN best practices by using / disposing of SPSite and SPWeb objects. – EtherDragon Oct 02 '14 at 21:25

Vadim Gremyachev · Answer 3 · 2014-11-10T14:27:12.170

The following method demonstrates how to determine whether a specified column exists in a List using CSOM:

static class FieldCollectionExtensions
{
    public static bool ContainsField(this List list,string fieldName)
    {
        var ctx = list.Context;
        var result = ctx.LoadQuery(list.Fields.Where(f => f.InternalName == fieldName));
        ctx.ExecuteQuery();
        return result.Any();
    }
}

Usage

using(var ctx = new ClientContext(webUrl))
{
    var list = ctx.Web.Lists.GetByTitle(listTitle);
    if(list.ContainsField("Title")){
       //...
    }
}

score 4 · Answer 4 · answered Dec 29 '15 at 10:10

Here's an extension code (CSOM) for sharepoint list

    public static bool DoesFieldExist(this List list, ClientContext clientContext, string internalFieldname)
    {
        bool exists = false;

        clientContext.Load(list.Fields, fCol => fCol.Include(
                f => f.InternalName
            ).Where(field => field.InternalName == internalFieldname));
        clientContext.ExecuteQuery();

        if (list.Fields != null && list.Fields.Count > 0)
        {
            exists = true;
        }

        return exists;
    }

usage

List targetList = this.Context.Web.Lists.GetById(<ListID>);
targetList.DoesFieldExist(<ClientContext>, <Field internal Name>)

enjoy :)

score 2 · Answer 5 · answered Jul 22 '16 at 12:35

Some good answers above. I personally used this one:

            List list = ctx.Web.Lists.GetByTitle("Some list");
            FieldCollection fields = list.Fields;
            IEnumerable<Field> fieldsColl = ctx.LoadQuery(fields.Include(f => f.InternalName));
            ctx.ExecuteQuery();

            bool fieldMissing = fieldsColl.Any(f => f.InternalName != "Internal_Name");

You can also use 'Where' after Include method and check if returned collection/field is null. It's about personal preference, because both options are querying on client side.

MagicAndi · Answer 6 · 2010-12-11T21:34:13.657

I ended up retrieving the details of the list's fields prior to my operation, and saving them in a generic list of structs (containing details of each field). I then query this (generic) list to see if the current field actually exists in the given (SharePoint) list.

// Retrieve detail sof all fields in specified list
using (ClientContext clientContext = new ClientContext(SharePointSiteUrl))
{
    List list = clientContext.Web.Lists.GetByTitle(listName);
    _listFieldDetails = new List<SPFieldDetails>();

    // get fields name and their types
    ClientObjectPrototype allFields = list.Fields.RetrieveItems();
    allFields.Retrieve( FieldPropertyNames.Title, 
                        FieldPropertyNames.InternalName,
                        FieldPropertyNames.FieldTypeKind,
                        FieldPropertyNames.Id,
                        FieldPropertyNames.ReadOnlyField);
    clientContext.ExecuteQuery();

    foreach (Field field in list.Fields)
    {
        SPFieldDetails fieldDetails = new SPFieldDetails();
        fieldDetails.Title = field.Title;
        fieldDetails.InternalName = field.InternalName;
        fieldDetails.Type = field.FieldTypeKind;
        fieldDetails.ID = field.Id;
        fieldDetails.ReadOnly = field.ReadOnlyField;
        listFieldDetails.Add(fieldDetails);
    }
}

// Check if field name exists
_listFieldDetails.Exists(field => field.Title == fieldName);

 // Struct to hold details of the field
public struct SPFieldDetails
{
    public string Title { get; set; }
    public string InternalName { get; set; }
    public Guid ID { get; set; }
    public FieldType Type { get; set; }
    public bool ReadOnly { get; set; }
}

score 0 · Answer 7 · answered Nov 19 '15 at 05:04

I prefer the SharePoint Plus Library as it is really clean: http://aymkdn.github.io/SharepointPlus/symbols/%24SP%28%29.list.html

$SP().list("My List").get({
  fields:"Title",
  where:"Author = '[Me]'"
},function getData(row) {
  console.log(row[0].getAttribute("Title"));
});

You could setup a for loop to loop through the row and check if the column you're looking for exists.

score 0 · Answer 8 · answered Mar 10 '19 at 00:08

A cut down and simplified version of Mitya's extension method:

 public static bool FieldExists(this List list, string internalFieldname)
    {
        using (ClientContext clientContext = list.Context as ClientContext)
        {
            clientContext.Load(list.Fields, fCol => fCol.Include(
                    f => f.InternalName
                ).Where(field => field.InternalName == internalFieldname));
            clientContext.ExecuteQuery();

            return (list.Fields != null) && (list.Fields.Count > 0);
        }
    }

There's no need to pass in a separate client context parameter when you can already use the context that comes in with the list.

score -2 · Answer 9 · edited Oct 12 '17 at 17:31

-2

to much code use this

load Fields first then

 bool exists= clientContext2.Site.RootWeb.Fields.Any(o => o.Id.ToString() == a.Id.ToString());

edited Oct 12 '17 at 17:31

Arun Vinoth

20,360
14
48
135

answered Oct 12 '17 at 15:01

David

1

Check if a List Column Exists using SharePoint Client Object Model?

9 Answers9

Linked