ContentIterator members

Provides methods to iterate list items, lists, sites to regulate the amount of data that is transferred (i.e., to avoid throwing a SPQueryThrottledException).

The ContentIterator type exposes the following members.

Constructors

  Name Description
Public method ContentIterator() Initializes a new instance of the ContentIterator class.
Public method ContentIterator(String) Initializes a new instance of the ContentIterator class with the specified name.
Public method ContentIterator(ContentIterator) Initializes a new instance of the ContentIterator class that contains the child objects of the specified parent object.
Public method ContentIterator(String, ContentIterator) Initializes a new instance of the ContentIterator class with the specified name and for the specified parent object.

Top

Properties

  Name Description
Public property Cancel Gets or sets whether the current iteration should be canceled.
Public property Cancelled Gets a flag that indicates whether the iteration was canceled.
Public propertyStatic member FolderCoreViewFields Gets common view fields for limiting the columns fetched in a query for folders.
Public propertyStatic member ItemCoreViewFields Gets common view fields for limiting the columns fetched in a query for items.
Public propertyStatic member ItemEnumerationOrderByID Gets an OrderBy clause for a query that orders items by ID.
Public propertyStatic member ItemEnumerationOrderByIDDesc Gets an OrderBy clause for a query that orders items by ID in descending order.
Public propertyStatic member ItemEnumerationOrderByNVPField Gets an OrderBy clause for a query that orders items by the NVP index used in the Where clause.
Public propertyStatic member ItemEnumerationOrderByPath Gets an OrderBy clause that orders query items by URL.
Public property Name Gets or sets the name of the content iterator.
Public property StrictQuerySemantics Gets or sets whether the query should follow strict query semantics.

Top

Methods

  Name Description
Public methodStatic member EnsureContentTypeIndexed Ensures that the ContentTypeId field is indexed for a list.
Public methodStatic member EnsureContentTypeIndexedIfLargeList Ensures that the ContentTypeId field is indexed for a list if it is a large list.
Public methodStatic member EnsureFieldIndexed Ensures that the field is indexed for a list.
Public methodStatic member EnsureFieldIndexedEx(SPList, SPField, Boolean) Ensures that the SPField object is indexed for a SPList object.
Public methodStatic member EnsureFieldIndexedEx(SPList, Guid, Boolean) Ensures that the SPField object is indexed for a SPList object.
Public methodStatic member EnsureFieldIndexedEx(SPList, String, Boolean) Ensures that the SPField object is indexed for a SPList object.
Public method ExecuteSitesProcessingDirect Iterates over every site collection in the farm.
Public methodStatic member GetAnyListItemInList Gets an arbitrary but consistent SPListItem object from a SPList object.
Public methodStatic member GetFileInFolder Gets the specified file from the specified folder without inflating the entire Files property collection.
Protected method GetMonitoredScopeName
Public methodStatic member ItemsOfContentTypeIdQuery
Public methodStatic member ItemsOfContentTypeIdQueryInFolder
Public methodStatic member ItemsOfContentTypeOrChildQuery
Public methodStatic member ItemsOfContentTypeOrChildQueryInFolder
Public methodStatic member ItemsOfContentTypeQuery Generates the query for an SPQuery object that returns all of the items of a specified content type.
Public methodStatic member ItemsOfContentTypeQueryInFolder Generates the query for a SPQuery object that returns all items of a specified content type inside a folder.
Public methodStatic member ListHasIndexedContentType Determines whether the content type field ID is indexed for the SPList object.
Public methodStatic member ListHasItemsOfContentType Determines if a SPList object or a SPFolder object has items of a specified content type.
Public methodStatic member ListHasItemsOfContentTypeId
Public methodStatic member ListHasItemsOfContentTypeOrChild
Protected method OnProcessedList Determines if a SPList object or a SPFolder object has items of a specified content type for a processed list.
Protected method OnProcessedListItemsBatch Determines if a SPList object or a SPFolder object has items of a specified content type for a batch of items on a processed list.
Protected method OnProcessedSite Determines if a SPList object or a SPFolder object has items of a specified content type for a batch of items on a processed site.
Protected method OnProcessedWeb Determines if a SPList object or a SPFolder object has items of a specified content type for a batch of items on a processed web.
Protected method ProcessFile Determines if a SPList object or a SPFolder object has items of a specified content type for a batch of items on a processed file.
Public method ProcessFiles(SPListItemCollection, ContentIterator.FileProcessor, ContentIterator.FileProcessorErrorCallout) Iterates over all of the files in an item collection.
Public method ProcessFiles(SPListItemCollection, Boolean, ContentIterator.FileProcessor, ContentIterator.FileProcessorErrorCallout) This member is reserved for internal use and is not intended to be used directly from your code.
Public method ProcessFilesInFolder(SPFolder, Boolean, ContentIterator.FileProcessor, ContentIterator.FileProcessorErrorCallout) Iterates over items in a folder.
Public method ProcessFilesInFolder(SPList, SPFolder, Boolean, ContentIterator.FileProcessor, ContentIterator.FileProcessorErrorCallout) Iterates over items in a folder.
Public method ProcessItems(SPListItemCollection, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Iterates over all items in a collection.
Public method ProcessItems(SPListItemCollection, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Iterates over items in a folder.
Public method ProcessItems(SPListItemCollection, Boolean, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Iterates over items in a folder.
Public method ProcessItemsInFolder(SPList, SPFolder, Boolean, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Iterates over items in a folder.
Public method ProcessItemsInFolder(SPList, SPFolder, Boolean, Boolean, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Iterates over items in a folder.
Public method ProcessListItems(SPList, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Processes list items.
Public method ProcessListItems(SPList, SPQuery, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Processes list items.
Public method ProcessListItems(SPList, SPQuery, ContentIterator.ItemsProcessor, ContentIterator.ItemsProcessorErrorCallout) Processes list items.
Public method ProcessListItems(SPList, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Processes list items.
Public method ProcessListItems(SPList, SPQuery, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Processes list items.
Public method ProcessListItems(SPList, String, Boolean, ContentIterator.ItemsProcessor, ContentIterator.ItemsProcessorErrorCallout) Processes list items.
Public method ProcessListItems(SPList, String, UInt32, Boolean, ContentIterator.ItemsProcessor, ContentIterator.ItemsProcessorErrorCallout) Processes list items.
Public method ProcessListItems(SPList, String, UInt32, Boolean, SPFolder, ContentIterator.ItemsProcessor, ContentIterator.ItemsProcessorErrorCallout) Processes list items.
Public method ProcessLists Processes a collection of lists.
Public method ProcessSite(SPSite, ContentIterator.WebProcessor, ContentIterator.WebProcessorErrorCallout) Processes all SPSite objects within a site collection.
Public method ProcessSite(SPSite, Boolean, ContentIterator.WebProcessor, ContentIterator.WebProcessorErrorCallout) Processes all SPSite objects within the site collection.
Public method ProcessSites Processes an SPSiteCollection object.
Protected method ResumeProcessListItemsBatch Manages resume functions for a batch of list items.
Protected method ResumeProcessLists Manages resume functions for a collection of lists.
Protected method ResumeProcessSites Manages resume functions for a collection of sites.
Protected method ResumeProcessWebs Manages resume actions for a collection of webs.
Public method ShouldCancel Determines whether the iteration should be cancelled at the specified granularity.
Protected method ShouldCancelCore Determines whether the iteration should be cancelled at the specified granularity.
Public methodStatic member UseLargeListQuerySemantics Indicates whether queries against the specified SPList object should use large list query semantics.

Top

Fields

  Name Description
Public fieldStatic member MaxItemsPerQuery The maximum number of items for a SPQuery query.
Public fieldStatic member MaxItemsPerQueryWithViewFields The maximum number of items to return for a SPQuery query where view fields have been explicitly specified.

Top

See also

Reference

ContentIterator class

Microsoft.Office.Server.Utilities namespace