Partager via


SPFieldLink.DisplayName - Propriété

Obtient ou définit le nom complet de la référence de champ.

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Property DisplayName As String
    Get
    Set
'Utilisation
Dim instance As SPFieldLink
Dim value As String

value = instance.DisplayName

instance.DisplayName = value
public string DisplayName { get; set; }

Valeur de propriété

Type : System.String
Le nom complet de la référence de champ.

Remarques

Si la propriété DisplayName n'a pas été explicitement définie, elle renvoie la valeur de la propriété Name de l'objet.

La propriété DisplayName a un objectif semblable à celui pris en charge par la propriété SPField.Title . Les deux propriétés fournissent un nom d'affichage d'une colonne. Par exemple, lorsque les colonnes sont répertoriées dans la Galerie des colonnes de Site, les noms dans la liste proviennent de la propriété Title pour chaque objet SPField dans la collection de champs du site. Lorsque les colonnes sont répertoriées dans la page Type de contenu de Site pour un type de contenu particulière, les noms sont extraites de la propriété DisplayName de chaque objet SPFieldLink dans la collection de références de champ du type de contenu.

Lorsque vous ajoutez une colonne de site à un type de contenu, vous pouvez définir la valeur de la propriété DisplayName de l'objet SPFieldLink sur une valeur différente de la valeur de la propriété Title de l'objet SPField , ce qui permet le type de contenu à utiliser un autre nom d'affichage pour la définition de la même colonne.

Exemples

L'exemple suivant montre une application console qui crée un type de contenu Company . Étant donné que le nouveau type de contenu est basé sur le type de contenu Item , elle hérite d'une référence à une colonne de site nommée « Title ». L'application modifie le nom complet de cette colonne dans le type de contenu Company à partir de « Title » à « Société ». Pour vérifier que le nom complet de la colonne type de contenu est maintenant différent du nom complet de la colonne de site, l'application imprime les deux noms dans la 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();
        }
    }
}

L'application imprime la sortie suivante sur la console.

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

Voir aussi

Référence

SPFieldLink classe

SPFieldLink - Membres

Microsoft.SharePoint - Espace de noms

Autres ressources

Fields and Field References

Introduction to Columns

Introduction to Content Types