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)

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

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.

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

Module ConsoleApp

    Sub Main()
        Using site As New SPSite("http://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

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