SPListItemCollectionPosition Class

Supports paging through data sets, storing the state that is required to get the next page of data for a specific view of a list.

Inheritance Hierarchy


Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online


<SubsetCallableTypeAttribute> _
<ClientCallableTypeAttribute(Name := "ListItemCollectionPosition", ServerTypeId := "{922354eb-c56a-4d88-ad59-67496854efe1}",  _
    ValueObject := True)> _
Public Class SPListItemCollectionPosition
Dim instance As SPListItemCollectionPosition
[ClientCallableTypeAttribute(Name = "ListItemCollectionPosition", ServerTypeId = "{922354eb-c56a-4d88-ad59-67496854efe1}", 
    ValueObject = true)]
public class SPListItemCollectionPosition


The following code example uses the ListItemCollectionPosition properties of the SPListItemCollection class and the SPQuery class to return an SPListItemCollectionPosition object that stores information about where each page of data ends in the collection of items, and which displays the titles of items in groups of 10 rows. The example assumes that the list is a document library or that folders are enabled in the list.

This example requires using directives (Imports in Microsoft Visual Basic) for the Microsoft.SharePoint and Microsoft.SharePoint.Utilities namespaces.

Dim site As SPWeb = SPControl.GetContextWeb(Context)
Dim list As SPList = site.Lists("Announcements")

Dim query As New SPQuery()
query.RowLimit = 10
query.Query = "<OrderBy Override=\"TRUE\">" & _
    "<FieldRef Name=\"FileLeafRef\" /></OrderBy>";

Dim i As Integer = 1


    Response.Write("<BR>Page: " & i & "<BR>")

    Dim listItems As SPListItemCollection = list.GetItems(query)
    Dim listItem As SPListItem

    For Each listItem In  listItems

            (SPEncode.HtmlEncode(listItem("Title").ToString()) & _

    Next listItem

    query.ListItemCollectionPosition = _

    i += 1

Loop While  Not (query.ListItemCollectionPosition Is Nothing) 
SPWeb oWebsite = SPContext.Current.Web;
SPList oList = oWebsite.Lists["Announcements"];

SPQuery oQuery = new SPQuery();
oQuery.RowLimit = 10;
oQuery.Query = "<OrderBy Override=\"TRUE\">" + 
    "<FieldRef Name=\"FileLeafRef\" /></OrderBy>";

int intIndex = 1;

    Response.Write("<BR>Page: " + intIndex + "<BR>");
    SPListItemCollection collListItems = oList.GetItems(oQuery);

    foreach (SPListItem oListItem in collListItems)
        Response.Write(SPEncode.HtmlEncode(oListItem["Title"].ToString()) +

    oQuery.ListItemCollectionPosition =
} while (oQuery.ListItemCollectionPosition != null);


For information about how to use Language-Integrated Query (LINQ) queries to retrieve list items in SharePoint Foundation, see Managing Data with LINQ to SharePoint.

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


SPListItemCollectionPosition Members

Microsoft.SharePoint Namespace