SPFieldLink.DisplayName property

Artigo
05/12/2015

Obtém ou define o nome de exibição para a referência de campo.

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

Syntax

'Declaração
Public Property DisplayName As String
    Get
    Set
'Uso
Dim instance As SPFieldLink
Dim value As String

value = instance.DisplayName

instance.DisplayName = value

public string DisplayName { get; set; }

Property value

Type: System.String
O nome de exibição da referência de campo.

Comentários

Se a propriedade DisplayName não tiver sido definida explicitamente, ele retornará o valor da propriedade de Name do objeto.

A propriedade DisplayName serve a uma finalidade similar ao atendidas pela propriedade SPField.Title . Ambas as propriedades fornecem um nome de exibição para uma coluna. Por exemplo, quando as colunas são listadas na Galeria de colunas do Site, os nomes na lista exibidos da propriedade Title para cada objeto SPField no conjunto de campo do site. Quando colunas são listadas na página Tipo de conteúdo de Site para um determinado tipo de conteúdo, os nomes são extraídos da propriedade DisplayName de cada objeto SPFieldLink da coleção de referência de campo de tipo de conteúdo.

Quando você adiciona uma coluna de site a um tipo de conteúdo, você pode definir o valor da propriedade DisplayName do objeto SPFieldLink com um valor diferente do que o valor da propriedade Title do objeto SPField , permitindo que o tipo de conteúdo usar um nome de exibição diferentes para a mesma definição de coluna.

Examples

O exemplo a seguir mostra um aplicativo de console que cria um tipo de conteúdo Company . Como o novo tipo de conteúdo é baseado no tipo de conteúdo Item , ele herda de uma referência a uma coluna de site chamada "Title". O aplicativo altera o nome de exibição desta coluna no tipo de conteúdo Company de "Title" para "Empresa". Para verificar que o nome de exibição da coluna de tipo de conteúdo agora é diferente do nome de exibição da coluna do site, o aplicativo imprime os dois nomes no console.

Imports System
Imports Microsoft.SharePoint

Module ConsoleApp

    Sub Main()
        Dim site As SPSite = New SPSite("https://localhost")
        Try
            Dim web As SPWeb = site.OpenWeb()
            Try
                ' Create a new content type.
                Dim companyType As New SPContentType(web.AvailableContentTypes("Item"), _
                                                     web.ContentTypes, "Company")
                web.ContentTypes.Add(companyType)

                ' Get the site field named Title.
                Dim field As SPField = web.Fields("Title")

                ' Get the same field in the content type.
                Dim fieldLink As SPFieldLink = companyType.FieldLinks(field.Id)

                ' Change the display name from Title to Company.
                fieldLink.DisplayName = "Company"
                companyType.Update()

                ' Verify our work.
                Console.WriteLine("The display name of the site column is {0}.", field.Title)
                Console.WriteLine("The display name of the content type column is {0}.", fieldLink.DisplayName)

            Finally
                web.Dispose()
            End Try
        Finally
            site.Dispose()
        End Try
        Console.Write("Press ENTER to continue...")
        Console.ReadLine()

    End Sub

End Module

using System;
using Microsoft.SharePoint;

namespace Test
{
    class ConsoleApp
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("https://localhost"))
            {
                using (SPWeb web = site.OpenWeb())
                {   
                    // Create a new content type.
                    SPContentType companyType = new SPContentType(web.AvailableContentTypes["Item"],
                                                                  web.ContentTypes, "Company");
                    web.ContentTypes.Add(companyType);

                    // Get the site field named Title.
                    SPField field = web.Fields["Title"];

                    // Get the same field in the content type.
                    SPFieldLink fieldLink = companyType.FieldLinks[field.Id];

                    // Change the display name from Title to Company.
                    fieldLink.DisplayName = "Company";
                    companyType.Update();

                    // Verify our work.
                    Console.WriteLine("The display name of the site column is {0}.", field.Title);
                    Console.WriteLine("The display name of the content type column is {0}.", fieldLink.DisplayName);
                }
            }
            Console.Write("Press ENTER to continue...");
            Console.ReadLine();
        }
    }
}

O aplicativo imprime a seguinte saída no console.

The display name of the site column is Title.
The display name of the content type column is Company.
Press ENTER to continue...

Ver também

Referência

SPFieldLink class

SPFieldLink members

Microsoft.SharePoint namespace

Outros recursos

Fields and Field References

Introduction to Columns

Introduction to Content Types

Compartilhar via