Field Class
Represents a field in a list on a Microsoft SharePoint Foundation Web site.
Inheritance Hierarchy
System.Object
Microsoft.SharePoint.Client.ClientObject
Microsoft.SharePoint.Client.Field
Namespace: Microsoft.SharePoint.Client
Assemblies: Microsoft.SharePoint.Client.Silverlight (in Microsoft.SharePoint.Client.Silverlight.dll); Microsoft.SharePoint.Client (in Microsoft.SharePoint.Client.dll)
Syntax
'Declaration
<ScriptTypeAttribute("SP.Field", ServerTypeId := "{c4121b04-0f57-4b1d-a145-d25426b16480}")> _
Public Class Field _
Inherits ClientObject
'Usage
Dim instance As Field
[ScriptTypeAttribute("SP.Field", ServerTypeId = "{c4121b04-0f57-4b1d-a145-d25426b16480}")]
public class Field : ClientObject
Remarks
A field is an element of a list or content type schema that specifies a property that is tracked for a list item. A field has an Internal Name, which specifies an identifier for the field. A field internal name is unique among other fields within a list and cannot contain spaces. A field has an Id, which is a GUID.A field has a specified field type. A field also contains state information for settings and additional metadata specified by the field type.
Examples
This code example gets a specified field, creates a description for the field, and displays the field title and new description.
using System;
using Microsoft.SharePoint.Client;
namespace Microsoft.SDK.SharePointFoundation.Samples
{
class FieldExample
{
static void Main()
{
string siteUrl = "http://MyServer/sites/MySiteCollection";
ClientContext clientContext = new ClientContext(siteUrl);
Web site = clientContext.Web;
List taskList = site.Lists.GetByTitle("Tasks");
FieldCollection collField = taskList.Fields;
Field oneField = collField.GetByInternalNameOrTitle("Title");
oneField.Description = "MyNewFieldDescription";
oneField.Update();
clientContext.Load(collField);
clientContext.Load(oneField);
clientContext.ExecuteQuery();
string fieldInfo = "Field Title: " + oneField.Title + "\n" +
"Description: " + oneField.Description + "\n";
Console.WriteLine(fieldInfo);
}
}
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Reference
Microsoft.SharePoint.Client Namespace
Inheritance Hierarchy
System.Object
Microsoft.SharePoint.Client.ClientObject
Microsoft.SharePoint.Client.Field
Microsoft.SharePoint.Client.FieldCalculated
Microsoft.SharePoint.Client.FieldComputed
Microsoft.SharePoint.Client.FieldDateTime
Microsoft.SharePoint.Client.FieldGuid
Microsoft.SharePoint.Client.FieldLookup
Microsoft.SharePoint.Client.FieldMultiChoice
Microsoft.SharePoint.Client.FieldMultiLineText
Microsoft.SharePoint.Client.FieldNumber
Microsoft.SharePoint.Client.FieldText
Microsoft.SharePoint.Client.FieldUrl