1 out of 1 rated this helpful - Rate this topic

SPField class

SharePoint 2013

Other Versions

Represents a field in a list on a SharePoint Foundation Web site.

Inheritance hierarchy

System.Object
Microsoft.SharePoint.SPField

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

Syntax

[SubsetCallableTypeAttribute(ForcePolymorphicForReturnTypes = true)]
public class SPField

Remarks

Use the Fields property of either the SPList class or the SPListItem class to return an SPFieldCollection object that represents the collection of fields for a list or list item. Use an indexer to return a single field from this collection. For example, if the collection is assigned to a variable named collFields, use collFields[index] in C#, or collFields(index) in Microsoft Visual Basic, where index is either the index number of the field in the collection or the display name of the field.

If you set properties of the SPField class and its inheriting classes, you must call the Update method for changes to take effect in the database.

Examples

The following example is a console application that gets a reference to the Expires field in the Announcements list and sets the default expiration date to one week after an item is created.

using System;
using Microsoft.SharePoint;

namespace ConsoleApp
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("http://localhost"))
            {
                using (SPWeb web = site.RootWeb)
                {
                    SPList list = web.Lists.TryGetList("Announcements");
                    if (list != null)
                    {
                        SPField fld = list.Fields[SPBuiltInFieldId.Expires];
                        fld.DefaultFormula = "=TODAY()+7";
                        fld.Update();
                    }
                }
            }
            Console.Write("\nPress ENTER to continue....");
            Console.Read();
        }
    }
}

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.

Reference

SPField members

Microsoft.SharePoint namespace

Inheritance hierarchy

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD