List class

Represents a list on a SharePoint Web site.

Inheritance hierarchy

System.Object
  Microsoft.SharePoint.Client.ClientObject
    Microsoft.SharePoint.Client.SecurableObject
      Microsoft.SharePoint.Client.List

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

Syntax

'Declaration
Public Class List _
    Inherits SecurableObject
'Usage
Dim instance As List
public class List : SecurableObject

Remarks

The BrowserFileHandling, DataSource, EffectiveBasePermissions, HasUniqueRoleAssignments, IsAttachmentLibrary, OnQuickLaunch, SchemaXml, ValidationFormula and ValidationMessage properties are not included in the default scalar property set for this type. TheDocument library templates sample app for SharePoint shows how to use this object.

Examples

This code example creates a new discussion board list on the current site.

using System;
using Microsoft.SharePoint.Client;

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

            ClientContext clientContext = new ClientContext(siteUrl);
            Web site = clientContext.Web;
            ListCreationInformation newListInfo = new ListCreationInformation();
            newListInfo.Title = "New Discussion Board";
            newListInfo.TemplateType = (int)ListTemplateType.DiscussionBoard;
            List newList = site.Lists.Add(newListInfo);

            clientContext.Load(newList);
            clientContext.ExecuteQuery();

            Console.WriteLine("Added Discussion Board: " + newList.Title);

        }
    }
}

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

List members

Microsoft.SharePoint.Client namespace