This topic has not yet been rated - Rate this topic

SPField.ListsFieldUsedIn method

SharePoint 2013

SharePoint 2010

Returns information about the Web sites and lists in which the current field is used.

Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

[SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.UnsupportedSPType)]
public ICollection<SPFieldTemplateUsage> ListsFieldUsedIn()

Return value

Type: System.Collections.Generic.ICollection<SPFieldTemplateUsage>
A collection of SPFieldTemplateUsage objects that contain information about the Web sites and the lists where the field is used.

Examples

The following example is a console application that calls the ListsFieldUsedIn method to determine where the Attachments field is used.

using System;
using System.Collections.Generic;
using Microsoft.SharePoint;

namespace ConsoleApp
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("http://localhost"))
            {
                SPField fld = site.RootWeb.AvailableFields[SPBuiltInFieldId.Attachments];
                Console.WriteLine("The {0} field is used in:\n", fld.Title);

                ICollection<SPFieldTemplateUsage> collection = fld.ListsFieldUsedIn();
                foreach (SPFieldTemplateUsage usage in collection)
                {
                    SPWeb web = site.AllWebs[usage.WebID];
                    SPList list = web.Lists[usage.ListID];
                    Console.WriteLine("{0} list in {1}", list.Title, web.Title);

                    web.Dispose();
                }
            }
            Console.Write("\nPress ENTER to continue....");
            Console.Read();
        }
    }
}

Reference

SPField class

SPField members

Microsoft.SharePoint namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD