Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SPWorkItemCollection Members

A collection of SPWorkItem object instances. Derives from Microsoft.SharePoint.SPBaseCollection.

The SPWorkItemCollection type exposes the following members.

  NameDescription
Public method SPWorkItemCollection(SPContentDatabase, Guid) Creates a new instance of SPWorkItemCollection that specifies the content database and provides a unique identifier for the work item type for objects in the collection.
Public method SPWorkItemCollection(SPSite, Guid) Instantiates a new instance of SPWorkItemCollection that specifies the SPSite object, and a uniqe identifier for the work item type for object in the collection.
Top
  NameDescription
Public property ContentDatabase Gets a content database object instance (SPContentDatabase).
Public property Count Gets a count of the number of SPWorkItem objects in the collection. (Overrides SPBaseCollection.Count.)
Public property Item[Guid] Gets a specific SPWorkItem object in the collection by using a globally unique identifier (GUID).
Public property Item[Int32] Gets a specific SPWorkItem object in the collection by its index into the collection.
Public property ParentId Gets a globally unique identifier (GUID) for the parent entity.
Public property ParentList Gets an SPListobject representing the parent list for objects in the SPWorkItemCollection collection.
Public property ParentWeb Gets an SPWeb object representing the parent of objects in the SPWorkItemCollection collection, in cases in which the parent is scoped to the level of the Web.
Public property ProcessingBatchSize Gets or sets the maximum number of work items that are paged in to a processing timer job.
Public property ProcessingThrottle Gets or sets a value that specifies the maximum number of workflow instances that can be obtained on a given query for runnable work items.
Public property UpgradedPersistedProperties (Inherited from SPAutoSerializingObject.)
Public property WorkItemType Gets a globally unique identifier (GUID) that specifies the type of work items in the SPWorkItemCollection collection. The types themselves are user defined.
Top
  NameDescription
Public method CompleteInProgressWorkItems Marks the list of in-progress work items as "complete" upon successfully processing the work item collection. Has the added effect of keeping the work items in the work item table, but in a state where they are not picked up by the GetRunnableWorkItems query.
Public method CopyTo Copies one work item collection as an array into another work item collection.
Public method DeleteInProgressWorkItems Marks the list of in-progress work items as "complete" upon successfully processing the work item collection and deletes the work items from the processing queue.
Public method DeleteWorkItem Deletes a single specified work item from the processing queue.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetEnumerator Gets an enumerator to iterate through the collection. (Inherited from SPBaseCollection.)
Public method GetHashCode (Inherited from Object.)
Public method GetObjectData (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Public method GetTypedEnumerator<T> Returns a type-safe enumerator to iterate through the collection. (Inherited from SPBaseCollection.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization (Inherited from SPAutoSerializingObject.)
Public method RevertInProgressWorkItem Marks an in-process work item as not yet completed, but also not processed. Has the effect of returning the work item to an unprocessed state so it is picked up during a subsequent invocation of the RunnableWorkItems query.
Public method RevertInProgressWorkItems Marks an in-process work item collection as not yet completed, but also not processed. Has the effect of returning the entire collection to an unprocessed state so it is picked up during a subsequent invocation of the RunnableWorkItems query.
Public method SubCollection Returns an SPWorkItemCollection instance (as a subcollection) from individual sites while iterating over all sites to assemble the full work item collection from the site-specific subcollections.
Public method ToString (Inherited from Object.)
Protected method UpdateParent (Inherited from SPAutoSerializingObject.)
Public method UpdateWorkItem Allows you to change the delivery date, the binary payload, or the text payload on a specified work item.
Top
  NameDescription
Explicit interface implemetation Private method ICollection.CopyTo Copies the elements of the collection to an array, starting at the specified array index. (Inherited from SPBaseCollection.)
Explicit interface implemetation Private property ICollection.IsSynchronized Gets a Boolean value that indicates whether access to the collection is synchronized or thread-safe. (Inherited from SPBaseCollection.)
Explicit interface implemetation Private property ICollection.SyncRoot Gets an object that is used to synchronize access to the collection. (Inherited from SPBaseCollection.)
Top
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.