SPFieldLookup.PrimaryFieldId property

Artigo
05/12/2015

Obtém ou define uma representação de seqüência de caracteres do GUID que identifica o campo de pesquisa primário se o campo for um campo de pesquisa dependente.

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

Syntax

'Declaração
Public Property PrimaryFieldId As String
    Get
    Set
'Uso
Dim instance As SPFieldLookup
Dim value As String

value = instance.PrimaryFieldId

instance.PrimaryFieldId = value

public string PrimaryFieldId { get; set; }

Property value

Type: System.String
Se o campo for um campo secundário em uma pesquisa de várias coluna, essa propriedade retorna a representação de seqüência de caracteres do GUID que identifica o campo de pesquisa primário; Caso contrário, ele retorna uma seqüência vazia.

Exceptions

Exception	Condition
SPException	Você não pode alterar o valor dessa propriedade após ela ter sido definida.
NotSupportedException	O campo pertence a uma lista externa.

Comentários

Quando você criar uma pesquisa de colunas múltiplas, o campo primário é o objeto de SPFieldLookup que estabelece a relação com a lista de origem. Um ou mais campos secundários dependem do campo primário para a relação com a lista de origem.

Se a propriedade do objeto atual SPFieldLookupIsDependentLookup retorna true, e em seguida, o objeto atual é um campo secundário e sua propriedade PrimaryFieldId retornará a representação de seqüência de caracteres do GUID que identifica o campo de pesquisa primário do qual ele depende.

Examples

O exemplo a seguir é um aplicativo de console que examina a coleção de campos associados a uma lista, em busca de objetos SPFieldLookup . Quando encontrar uma, o código no aplicativo determina se o objeto representa uma coluna primária ou secundária. Se o objeto representa uma coluna secundária, o código usa o valor retornado pela propriedade PrimaryFieldId para obter o nome de exibição da coluna principal.

using System;
using Microsoft.SharePoint;

namespace ConsoleApp
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite siteCollection = new SPSite("https://localhost"))
            {
                using (SPWeb site = siteCollection.OpenWeb())
                {
                    SPList list = site.Lists["Complete Orders"];

                    foreach (SPField item in list.Fields)
                    {
                        if (item is SPFieldLookup)
                        {
                            SPFieldLookup field = (SPFieldLookup)item;

                            if (!String.IsNullOrEmpty(field.LookupList) && !String.IsNullOrEmpty(field.LookupField))
                            {
                                // Is this the primary or secondary field for a list relationship? 
                                string strRelationship = field.IsRelationship ? "Primary":"Secondary"; 

                                // Print the display name of the field.
                                Console.WriteLine("\nField: {0} ({1} Field)", field.Title, strRelationship);

                                // Is this a secondary field in a list relationship?
                                if (field.IsDependentLookup)
                                {
                                    SPField primaryField = list.Fields[new Guid(field.PrimaryFieldId)];
                                    Console.WriteLine("Primary Field: {0}", primaryField.Title);
                                }
                            }
                        }
                    }
                }
            }
            Console.Write("\nPress ENTER to continue...");
            Console.ReadLine();
        }
    }
}

Imports System
Imports Microsoft.SharePoint

Module ConsoleApp

    Sub Main()
        Using siteCollection As New SPSite("https://localhost")
            Using site As SPWeb = siteCollection.OpenWeb()
                Dim list As SPList = site.Lists("Pending Orders")

                For Each item As SPField In list.Fields
                    If TypeOf item Is SPFieldLookup Then
                        Dim field As SPFieldLookup = DirectCast(item, SPFieldLookup)

                        If Not String.IsNullOrEmpty(field.LookupList) AndAlso Not String.IsNullOrEmpty(field.LookupField) Then
                            ' Is this the primary or secondary field for a list relationship?
                            Dim strRelationship As String = If(field.IsRelationship, "Primary", "Secondary")

                            ' Print the display name of the field.
                            Console.WriteLine(vbLf & "Field: {0} ({1} Field)", field.Title, strRelationship)

                            ' Is this a secondary field in a list relationship?
                            If field.IsDependentLookup Then
                                Dim primaryField As SPField = list.Fields(New Guid(field.PrimaryFieldId))
                                Console.WriteLine("Primary Field: {0}", primaryField.Title)
                            End If
                        End If
                    End If
                Next
            End Using
        End Using
        Console.Write(vbLf & "Press ENTER to continue...")
        Console.ReadLine()
    End Sub
End Module