FieldCollection.AddFieldAsXml método

Artigo
05/11/2016

Cria um campo com base no esquema especificado, valor booliano e opções de campo.

Namespace: Microsoft.SharePoint.Client
Assemblies: Microsoft.SharePoint.Client.Silverlight (em Microsoft.SharePoint.Client.Silverlight.dll); Microsoft.SharePoint.Client.Phone (em Microsoft.SharePoint.Client.Phone.dll) Microsoft.SharePoint.Client (em Microsoft.SharePoint.Client.dll)

Sintaxe

'Declaração
Public Function AddFieldAsXml ( _
    schemaXml As String, _
    addToDefaultView As Boolean, _
    options As AddFieldOptions _
) As Field
'Uso
Dim instance As FieldCollection
Dim schemaXml As String
Dim addToDefaultView As Boolean
Dim options As AddFieldOptions
Dim returnValue As Field

returnValue = instance.AddFieldAsXml(schemaXml, _
    addToDefaultView, options)

public Field AddFieldAsXml(
    string schemaXml,
    bool addToDefaultView,
    AddFieldOptions options
)

Parâmetros

schemaXml
Tipo: System.String

Uma cadeia de caracteres de colaboração (CAML Application Markup Language) que contém o esquema.

Ele não deve ser uma referência nula (Nothing no Visual Basic). Ele não deve ser vazio. Ele deve ser uma cadeia de caracteres válida colaborativos (CAML Application Markup Language) de acordo com o esquema especificado no [MS-WSSFO2], seção 2.2.9.3.3.1.

addToDefaultView
Tipo: System.Boolean

Especifica para adicionar o campo à exibição de lista padrão.

true se o campo é adicionado à exibição de lista padrão; Caso contrário, false.

options
Tipo: Microsoft.SharePoint.Client.AddFieldOptions

Um valor de AddFieldOptions que especifica as opções de campo.

Valor retornado

Tipo: Microsoft.SharePoint.Client.Field
Um objeto de Field que representa o novo campo.

Exceções

Exceção	Condição
SPException	Um ou mais tipos de campo não estão instalados corretamente, a fórmula está vazia para o tipo de campo calculado ou ocorreu um erro durante o processamento do XML especificado. Código de erro:-2146232832. Um ou mais tipos de campo não estão instalados corretamente. Código de erro:-2130575340. Fórmula está vazia para o tipo de campo calculado. Código de erro:-2130575199.
SPQueryThrottledException	O limite de otimização é alcançado. Código de erro:-2147024860. Não há uma falha de aceleração de junção. Código de erro:-2147024749.
ArgumentException	O campo com o nome interno especificado ou o título não existe no conjunto de no escopo fornecido. Código de erro: -2147024809.
UnauthorizedAccessException	O usuário atual tem permissões suficientes. Código de erro: -2147024891.

Exemplos

Este exemplo de código cria um campo com base nas informações de esquema e exibe os campos disponíveis na lista de anúncios, incluindo o novo campo.

using System;
using Microsoft.SharePoint.Client;

namespace Microsoft.SDK.SharePointFoundation.Samples
{
    class AddFieldAsXmlExample
    {
        static void Main()
        {
            string siteUrl = "http://MyServer/sites/MySiteCollection";

            ClientContext clientContext = new ClientContext(siteUrl);
            Web site = clientContext.Web;
            List targetList = site.Lists.GetByTitle("Announcements");
            FieldCollection collField = targetList.Fields;

            string fieldSchema = "<Field Type='Text' DisplayName='NewField' Name='NewField' />";
            collField.AddFieldAsXml(fieldSchema, true, AddFieldOptions.AddToDefaultContentType);

            clientContext.Load(collField);
            clientContext.ExecuteQuery();

            Console.WriteLine("NewField added to Announcements list.\n\nThe following fields are available:\n\n");
            foreach (Field myField in collField)
               Console.WriteLine(myField.Title);
        }
    }
}

Ver também

Referência

FieldCollection classe

FieldCollection membros

Microsoft.SharePoint.Client namespace

Compartilhar via