SPField.ListsFieldUsedIn Method

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)
Available in Sandboxed Solutions: No
Available in SharePoint Online

Syntax

'Declaration
<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.UnsupportedSPType)> _
Public Function ListsFieldUsedIn As ICollection(Of SPFieldTemplateUsage)
'Usage
Dim instance As SPField
Dim returnValue As ICollection(Of SPFieldTemplateUsage)

returnValue = instance.ListsFieldUsedIn()

[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("https://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();
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports Microsoft.SharePoint

Module ConsoleApp

    Sub Main()
        Using site As New SPSite("https://localhost")

            Dim fld As SPField = site.RootWeb.AvailableFields(SPBuiltInFieldId.Attachments)
            Console.WriteLine("The {0} field is used in:" & vbLf, fld.Title)

            Dim collection As ICollection(Of SPFieldTemplateUsage) = fld.ListsFieldUsedIn()
            For Each usage As SPFieldTemplateUsage In collection
                Dim web As SPWeb = site.AllWebs(usage.WebID)
                Dim list As SPList = web.Lists(usage.ListID)
                Console.WriteLine("{0} list in {1}", list.Title, web.Title)

                web.Dispose()
            Next

        End Using
        Console.Write(vbCrLf & "Press ENTER to continue....")
        Console.Read()
    End Sub

End Module

See Also

Reference

SPField Class

SPField Members

Microsoft.SharePoint Namespace