SPFieldLinkCollection.Reorder method

Artigo
05/12/2015

Altera a ordem na qual os campos referenciados neste conjunto são listados em formulários.

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

Syntax

'Declaração
Public Sub Reorder ( _
    internalNames As String() _
)
'Uso
Dim instance As SPFieldLinkCollection
Dim internalNames As String()

instance.Reorder(internalNames)

public void Reorder(
    string[] internalNames
)

Parâmetros

internalNames
Type: []

Uma matriz de seqüências de caracteres, cada um contendo o valor da propriedade Name para um objeto neste SPFieldLinkCollection.

Exceptions

Exception	Condition
ArgumentNullException	internalNames é null .

Comentários

Você pode usar esse método para alterar a ordem na qual os campos são exibidos em formulários, como o formulário Novo Item em uma lista. A coleção de seqüências de caracteres que você passar como um argumento para o método deve conter os nomes internos dos campos referenciados pelos objetos do SPFieldLinkCollection. Você pode obter uma lista de nomes internos, acessando a propriedade Name para cada objeto na coleção.

Se você passar uma lista incompleta, o método coloca os objetos nomeados na sua lista na primeira parte da coleção, antes de quaisquer objetos cujos nomes não aparecem na lista. Se a lista contiver um nome que não aparece na coleção, o nome será ignorado.

Examples

O exemplo a seguir altera a ordem dos campos no tipo de conteúdo padrão para a lista de anúncios, colocar o campo expira em primeiro lugar e torná-lo um campo obrigatório. A ordem padrão no tipo de conteúdo Announcement é "Título, corpo, expira." O exemplo de código altera a ordem para "Expira, título, corpo". Observe que a alteração desejada aqui também pode ser realizada, passando uma matriz com apenas duas cadeias de caracteres, "Expira, título".

O aplicativo que contém o código a seguir importa os namespaces System e 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();
    }
}