SPWorkflow Members

Include Protected Members
Include Inherited Members

Represents a workflow instance that has run or is currently running on a site.

The SPWorkflow type exposes the following members.

Constructors

	Name	Description
	SPWorkflow(SPListItem, Guid)	Initializes a new instance of a single workflow instance running on a SPListItem to be retrieved from the database.
	SPWorkflow(SPWeb, Guid)	Initializes a new instance of a single workflow instance running on an SPWeb to be retrieved from the database.

Top

Properties

	Name	Description
	AssociationId	Gets the ID of the workflow association on which this workflow instance is based.
	Author	Returns the ID of the user who initiated the workflow instance.
	AuthorUser	Returns the user who initiated the workflow instance.
	Created	Gets the date and time when the workflow instance was created.
	HasNewEvents	Gets a value that indicates whether the SPWorkflow has new events to be processed.
	HistoryList	Gets the list to log workflow history events to for this workflow instance.
	HistoryListId	Gets the list ID of the list to log workflow history events to for this workflow instance.
	InstanceId	Gets the ID of this workflow instance.
	InternalState	Gets the current internal state of the workflow instance.
	IsCompleted	true if the workflow instance has completed; false if the workflow instance is still in progress.
	IsLocked	true if the workflow instance is locked; false if it is not.
	ItemGuid	Gets the ID of the item on which this workflow instance was created.
	ItemId	Gets the list ID of the item on which this workflow instance was created.
	ItemName	Gets the name of the SPListItem on which the SPWorkflow instance was created.
	ListId	Gets the ID of the list on which this workflow instance was created.
	Modifications	Gets a collection of the workflow modifications currently in scope for this workflow instance.
	Modified	Gets the date and time of the last modification to the workflow instance.
	OwnerUser	Gets the owner of the SPWorkflowTemplate on which this SPWorkflow instance is based.
	ParentAssociation	Gets the workflow association on which the workflow instance is based.
	ParentItem	Gets the list item on which this workflow instance was created.
	ParentList	Gets the list on which this workflow instance was created.
	ParentWeb	Gets the SharePoint site on which this workflow instance was created.
	SiteId	Gets the ID of the site collection on which this workflow instance was created.
	StatusUrl	Gets the URL of a custom workflow status page for the SPWorkflow.
	TaskFilter	Gets or sets the filter criteria applied to the workflow task collection, such as to whom the workflow is assigned, and the workflow state.
	TaskList	Gets the workflow task list.
	TaskListId	Gets the ID of the workflow task list.
	Tasks	Gets the collection of workflow tasks for this workflow instance.
	VisibleParentItem	Gets a value that represents whether the item the workflow is running on is visible.
	WebId	Gets the ID of the SharePoint site on which this workflow instance was created.
	Xml	Returns a string that represents the workflow instance in XML format.

Top

Methods

	Name	Description
	CompareTo	Compares this instance to a specified SPWorkflow object.
	CreateHistoryDurationEvent	Writes a workflow history duration event to the specified workflow history list.
	CreateHistoryEvent(Int32, Object, SPMember, String, String, String)	Writes a workflow history event to the specified workflow history list.
	CreateHistoryEvent(SPWeb, Guid, Int32, SPMember, TimeSpan, String, String, String)	Writes a workflow history event to the specified workflow history list.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetActivityDetails	Returns an array of objects with detailed information about each workflow activity.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

See Also

Reference

SPWorkflow Class

Microsoft.SharePoint.Workflow Namespace