Home Library Learn Downloads Support Community
Sign in | United States - English | |
3 out of 3 rated this helpful Rate this topic

SPQuery Class

SharePoint 2010

Represents a query in a list view.

System.Object
  Microsoft.SharePoint.SPQuery

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online
C#
VB
Copy 
[ClientCallableTypeAttribute(Name = "CamlQuery", ServerTypeId = "{3d248d7b-fc86-40a3-aa97-02a75d69fb8a}", 
	ValueObject = true)]
[SubsetCallableTypeAttribute]
public class SPQuery

The Type attribute is particularly useful for Lookup and User fields. Otherwise, without that attribute, the query may not return the expected results. In some cases, the query may fail completely.

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.

The following code example displays the titles of items in a Tasks list where the Status column equals Completed. The example uses Collaborative Application Markup Language (CAML) to define the query.

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

C#
VB
Copy 

SPWeb oWebsiteRoot = SPContext.Current.Site.RootWeb
SPList oList = oWebsiteRoot.Lists["Tasks"];

SPQuery oQuery = new SPQuery();
oQuery.Query = "<Where><Eq><FieldRef Name='Status'/>" +
    "<Value Type='Text'>Completed</Value></Eq></Where>";
SPListItemCollection collListItems = oList.GetItems(oQuery);

foreach (SPListItem oListItem in collListItems)
{
    Response.Write(SPEncode.HtmlEncode(oListItem["Title"].ToString()) + 
        "<BR>");
}
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(2000 characters remaining)
Community Content Add
Annotations FAQ
Disposal
Note: An SPWeb object obtained through the SPContext object should not be disposed. This code sample was be corrected in the most recent version of the SharePoint SDK to reflect that.
History
Query items by rating values using CAML
In this post I illustrate through examples how you can use the rating average and the number of the rates in CAML query:
http://pholpar.wordpress.com/2010/02/03/query-items-by-rating-values-using-caml/
History
CAML query on metadata using a TaxonomyFieldValue or Term
If you would like to know how to query items using CAML based on managed metadata taxonomies, see this post:
http://pholpar.wordpress.com/2010/02/03/some-words-about-taxonomyfieldvalue-and-its-wssid-property/
History