SPFieldLinkCollection.Reorder - Méthode

Article
05/12/2015

Modifie l'ordre dans lequel les champs référencés dans cette collection sont répertoriés dans les formulaires.

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

Syntaxe

'Déclaration
Public Sub Reorder ( _
    internalNames As String() _
)
'Utilisation
Dim instance As SPFieldLinkCollection
Dim internalNames As String()

instance.Reorder(internalNames)

public void Reorder(
    string[] internalNames
)

Paramètres

internalNames
Type : []

Un tableau de chaînes, chacune contenant la valeur de la propriété Name pour un objet dans cette SPFieldLinkCollection.

Exceptions

Exception	Condition
ArgumentNullException	internalNames est null .

Remarques

Vous pouvez utiliser cette méthode pour modifier l'ordre dans lequel les champs sont affichent sur les formulaires, tels que le formulaire de Nouvel élément dans une liste. La collection de chaînes que vous passez en tant qu'argument à la méthode doit contenir les noms internes des champs qui sont référencés par les objets dans le SPFieldLinkCollection. Vous pouvez obtenir une liste de noms internes en accédant à la propriété Name pour chaque objet dans la collection.

Si vous passez une liste incomplète, la méthode place les objets figurant dans votre liste dans la première partie de la collection, à tous les objets dont les noms n'apparaissent pas dans votre liste. Si votre liste contient un nom qui n'apparaît pas dans la collection, le nom est ignoré.

Exemples

L'exemple suivant modifie l'ordre des champs dans le type de contenu par défaut pour la liste Annonces, plaçant tout d'abord du champ date d'expiration et de le rendre un champ obligatoire. L'ordre par défaut dans le type de contenu Announcement est « titre, corps, expire. L'exemple de code modifie l'ordre de « Date d'expiration, titre, corps ». Notez que la modification souhaitée ici peut également être effectuée en passant un tableau avec seulement deux chaînes, « Date d'expiration, titre ».

L'application qui inclut cet exemple de code importe les espaces de noms System et Microsoft.Sharepoint .

Dim site As SPSite = New SPSite("https://localhost")
Try
    Dim web As SPWeb = site.OpenWeb()
    Try
        Dim ct As SPContentType = web.Lists("Announcements").ContentTypes("Announcement")
        Dim flinks As SPFieldLinkCollection = ct.FieldLinks

        ' Put the Expires field first and make it required.
        flinks.Reorder(New String() {"Expires", "Title", "Body"})
        flinks("Expires").Required = True
        ct.Update()
        
    Finally
        web.Dispose()
    End Try
Finally
    site.Dispose()
End Try

using (SPSite site = new SPSite("https://localhost"))
{
    using (SPWeb web = site.OpenWeb())
    {
        SPContentType ct = web.Lists["Announcements"].ContentTypes["Announcement"];
        SPFieldLinkCollection flinks = ct.FieldLinks;

        // Put the Expires field first and make it required.
        flinks.Reorder(new[]{"Expires", "Title", "Body"});
        flinks["Expires"].Required = true;
        ct.Update();
    }
}