Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Include Protected Members
Include Inherited Members
A collection of SPWorkItem object instances. Derives from Microsoft.SharePoint.SPBaseCollection.
The SPWorkItemCollection type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "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. |
|
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
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ContentDatabase | Gets a content database object instance (SPContentDatabase). |
|
Count | Gets a count of the number of SPWorkItem objects in the collection. (Overrides SPBaseCollection.Count.) |
|
Item[Guid] | Gets a specific SPWorkItem object in the collection by using a globally unique identifier (GUID). |
|
Item[Int32] | Gets a specific SPWorkItem object in the collection by its index into the collection. |
|
ParentId | Gets a globally unique identifier (GUID) for the parent entity. |
|
ParentList | Gets an SPListobject representing the parent list for objects in the SPWorkItemCollection collection. |
|
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. |
|
ProcessingBatchSize | Gets or sets the maximum number of work items that are paged in to a processing timer job. |
|
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. |
|
UpgradedPersistedProperties | (Inherited from SPAutoSerializingObject.) |
|
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
Methods
| Name | Description | |
|---|---|---|
|
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. |
|
CopyTo | Copies one work item collection as an array into another work item collection. |
|
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. |
|
DeleteWorkItem | Deletes a single specified work item from the processing queue. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetEnumerator | Gets an enumerator to iterate through the collection. (Inherited from SPBaseCollection.) |
|
GetHashCode | (Inherited from Object.) |
|
GetObjectData | (Inherited from SPAutoSerializingObject.) |
|
GetType | (Inherited from Object.) |
|
GetTypedEnumerator<T> | Returns a type-safe enumerator to iterate through the collection. (Inherited from SPBaseCollection.) |
|
MemberwiseClone | (Inherited from Object.) |
|
OnDeserialization | (Inherited from SPAutoSerializingObject.) |
|
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. |
|
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. |
|
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. |
|
ToString | (Inherited from Object.) |
|
UpdateParent | (Inherited from SPAutoSerializingObject.) |
|
UpdateWorkItem | Allows you to change the delivery date, the binary payload, or the text payload on a specified work item. |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICollection.CopyTo | Copies the elements of the collection to an array, starting at the specified array index. (Inherited from SPBaseCollection.) |
.gif "Private property") |
ICollection.IsSynchronized | Gets a Boolean value that indicates whether access to the collection is synchronized or thread-safe. (Inherited from SPBaseCollection.) |
|
ICollection.SyncRoot | Gets an object that is used to synchronize access to the collection. (Inherited from SPBaseCollection.) |
Top