List.GetRelatedFields method
Returns a collection of lookup fields that use this list as a data source and that have FieldLookup.IsRelationship set to true.
Namespace: Microsoft.SharePoint.Client
Assembly: Microsoft.SharePoint.Client (in Microsoft.SharePoint.Client.dll)
Syntax
'Declaration
Public Function GetRelatedFields As RelatedFieldCollection
'Usage
Dim instance As List
Dim returnValue As RelatedFieldCollection
returnValue = instance.GetRelatedFields()
public RelatedFieldCollection GetRelatedFields()
Return value
Type: Microsoft.SharePoint.Client.RelatedFieldCollection
Returns a RelatedFieldCollection instance representing the collection of lookup fields that use this list as a data source and that have FieldLookup.IsRelationship set to true.
Exceptions
| Exception | Condition |
|---|---|
| [System.UnauthorizedAccessException] | The current user has insufficient permissions. Error code: -2147024891. |
Examples
This code example displays the identifier of any fields related to the current site’s Tasks list.
using System;
using Microsoft.SharePoint.Client;
namespace Microsoft.SDK.SharePointFoundation.Samples
{
class List_getRelatedFieldsExample
{
static void Main()
{
string siteUrl = "http://MyServer/sites/MySiteCollection";
ClientContext clientContext = new ClientContext(siteUrl);
Web site = clientContext.Web;
List targetList = site.Lists.GetByTitle("Tasks");
RelatedFieldCollection collRelatedField = targetList.GetRelatedFields();
clientContext.Load(collRelatedField);
clientContext.ExecuteQuery();
foreach (RelatedField targetField in collRelatedField)
Console.WriteLine("Related Field ID: {0}", targetField.FieldId);
}
}
}
}