OfficeTask OfficeTask OfficeTask Class

Definition

The OfficeTask class workflow activity is included with the installation of Microsoft SharePoint Server 2010. It allows the customization of task centric workflows using SharePoint Designer that was not possible in Microsoft Office SharePoint Server 2007. The OfficeTask activity will not be available to users of Microsoft SharePoint Foundation 2010.

public ref class OfficeTask : System::Workflow::ComponentModel::CompositeActivity, Microsoft::SharePoint::Workflow::ISPActivityDetailsSerializable, System::Workflow::ComponentModel::IActivityEventListener<System::Workflow::ComponentModel::QueueEventArgs ^>
[System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(Microsoft.Office.Workflow.Actions.OfficeTaskValidator))]
public class OfficeTask : System.Workflow.ComponentModel.CompositeActivity, Microsoft.SharePoint.Workflow.ISPActivityDetailsSerializable, System.Workflow.ComponentModel.IActivityEventListener<System.Workflow.ComponentModel.QueueEventArgs>
Public Class OfficeTask
Inherits CompositeActivity
Implements IActivityEventListener(Of QueueEventArgs), ISPActivityDetailsSerializable
Inheritance
Derived
Attributes
Implements

Constructors

OfficeTask() OfficeTask() OfficeTask()

Creates a new instance of the OfficeTask class.

Fields

__ActivationPropertiesProperty __ActivationPropertiesProperty __ActivationPropertiesProperty

Represents a DependencyPropertySPWorkflowActivationProperties object exposed by the dependency property.

__ContextProperty __ContextProperty __ContextProperty

Returns a DependencyProperty

AssignedToProperty AssignedToProperty AssignedToProperty

Returns a DependencyPropertyAssignedTo property of the SharePoint Foundation 2010 list item that is associated with the workflow instance.

CCProperty CCProperty CCProperty

Returns a DependencyPropertyCC property of the SharePoint Foundation 2010 list item that is associated with the workflow instance.

CommentsProperty CommentsProperty CommentsProperty

Returns a DependencyPropertyComments property of the SharePoint Foundation 2010 list item that is associated with the workflow instance.

ContentTypeIdProperty ContentTypeIdProperty ContentTypeIdProperty

A DependencyPropertyContentTypeId property of the SharePoint list item associated with the running workflow instance.

DeleteTasksOnCompleteProperty DeleteTasksOnCompleteProperty DeleteTasksOnCompleteProperty

A DependencyPropertyDeleteTasksOnComplete property of the SharePoint list item associated with the running workflow instance.

DueDateProperty DueDateProperty DueDateProperty

A DependencyPropertyDueDate property of the SharePoint list item associated with the running workflow instance.

DurationProperty DurationProperty DurationProperty

A DependencyPropertyDuration property of the SharePoint list item associated with the running workflow instance.

DurationUnitProperty DurationUnitProperty DurationUnitProperty

A DependencyPropertyDurationUnit property of the SharePoint list item associated with the running workflow instance.

ExpandGroupsProperty ExpandGroupsProperty ExpandGroupsProperty
ItemIdProperty ItemIdProperty ItemIdProperty

DependencyProperty for a bindable property of this workflow activity. This should not be used directly.

ListIdProperty ListIdProperty ListIdProperty

DependencyProperty for a bindable property of this workflow activity. This should not be used directly.

OutcomesProperty OutcomesProperty OutcomesProperty

A DependencyPropertyOutcomes property of the list item associated with the task.

OverdueRepeatProperty OverdueRepeatProperty OverdueRepeatProperty
OverdueRepeatTimesProperty OverdueRepeatTimesProperty OverdueRepeatTimesProperty
PermissionSetProperty PermissionSetProperty PermissionSetProperty
SendDefaultTaskNotificationsProperty SendDefaultTaskNotificationsProperty SendDefaultTaskNotificationsProperty
SubjectProperty SubjectProperty SubjectProperty
TaskDeletedOutcomeProperty TaskDeletedOutcomeProperty TaskDeletedOutcomeProperty
TaskProcessNameProperty TaskProcessNameProperty TaskProcessNameProperty
TaskProcessOwnerProperty TaskProcessOwnerProperty TaskProcessOwnerProperty

Properties

__ActivationProperties __ActivationProperties __ActivationProperties

A activation properties for this OfficeTask's workflow. This property is recommended to be set.

__Context __Context __Context

An optional WorkflowContext for this OfficeTask. Binding this property is reccomended.

ActiveTaskCount ActiveTaskCount ActiveTaskCount
AllowChangeRequest AllowChangeRequest AllowChangeRequest

Indicates whether a user can request a change to a workflow task.

AllowReassign AllowReassign AllowReassign

Indicates whether a user can reassign a workflow task to someone else.

AssignedTaskCount AssignedTaskCount AssignedTaskCount
AssignedTo AssignedTo AssignedTo

Returns the names of the people assigned to the tasks in a task process.

Assignments Assignments Assignments

A container of all of the initial stages for this OfficeTask.

CC CC CC

Returns an array of user names or e-mail addresses included on the CC line of task process notification e-mail messages.

CCList CCList CCList

A string form of the CC property in the format of Microsoft.Office.Workflow.Utility.Contact XML

Comments Comments Comments

Returns the value of the Description field of task list items that are created by the task process.

CompletedTaskCount CompletedTaskCount CompletedTaskCount

Returns the number of tasks in the task process that are marked as completed.

ConsolidatedComments ConsolidatedComments ConsolidatedComments
ContentTypeId ContentTypeId ContentTypeId

Returns the value of the ContentTypeId property of the task.

CurrentUICulture CurrentUICulture CurrentUICulture

Correct CultureInfo to use for UI this OfficeTask process

CurrentWeb CurrentWeb CurrentWeb

The SPWeb of this workflow, with its Site.CurrentUser set according to impersonation settings in the workflow

DeletedTaskCount DeletedTaskCount DeletedTaskCount

The number of deleted tasks for this OfficeTask process

DeleteTasksOnComplete DeleteTasksOnComplete DeleteTasksOnComplete

Indicates whether the child tasks of the task process should be deleted when they are marked as completed.

DueDate DueDate DueDate

Returns the date when child tasks of the task process are due to be completed.

Duration Duration Duration

Returns the amount of time from when the task was initially created to when it is due to be completed.

DurationUnit DurationUnit DurationUnit

Get or sets an enumeration value that indicates whether the value of the Duration property is counted in days, weeks, or months.

ExpandGroups ExpandGroups ExpandGroups

Indicates whether a task is assigned to each member of a group or to an entire group.

FutureTaskCount FutureTaskCount FutureTaskCount
Item Item Item

The SPListItem indicated by this OfficeTask's ItemId property

ItemCreatedBy ItemCreatedBy ItemCreatedBy

loginName of the SPUser who created the item for this OfficeTask process

ItemExternalURL ItemExternalURL ItemExternalURL
ItemId ItemId ItemId

Returns the ID of the of list item that represents the workflow task that the task process is executing against.

ItemModifiedBy ItemModifiedBy ItemModifiedBy

loginName of the SPUser who last modified the item for this OfficeTask process

ItemTitle ItemTitle ItemTitle

encoded title property of the SPListItem for this OfficeTask process

ItemTitleNotEncoded ItemTitleNotEncoded ItemTitleNotEncoded

unencoded title property of the SPListItem for this OfficeTask process

ItemURL ItemURL ItemURL

encoded web-relative URL for the item for this OfficeTask process

List List List

The SPList indicated by this OfficeTask's ListId property

ListId ListId ListId

Returns the ID of the list that contains the workflow task that the task process is executing against.

Outcomes Outcomes Outcomes

A list of outcomes for all tasks in this process, in the form of "display1,outcome1;display2,outcome2"

OverdueRepeat OverdueRepeat OverdueRepeat

Gets or sets an object that represents the frequency with which OnTaskExpired should run, if the task is past the due date and not yet completed.

OverdueRepeatTimes OverdueRepeatTimes OverdueRepeatTimes

Gets or sets a value that represents the number of times that OnTaskExpired should be run on the frequency of OverdueRepeat, if the task is past the due date and not yet complete.

ParticipantList ParticipantList ParticipantList

A list of display name of each participant. This is delimited as if it were a multi-user lookup e.g."1;#John Doe;#2;#Jane Roe;#3;#FrontPage Lab Account"

PermissionSet PermissionSet PermissionSet

Returns the set of permissions associated with the workflow task list items that are generated as part of the task process.

SendDefaultTaskNotifications SendDefaultTaskNotifications SendDefaultTaskNotifications

Indicates whether default task notifications are sent for a task created by the task process.

Subject Subject Subject

Returns the value of the Subject property of a workflow task.

SuperWeb SuperWeb SuperWeb

an SPWeb created from an SPSite impersonated as the process account

TaskDeletedOutcome TaskDeletedOutcome TaskDeletedOutcome

Gets or sets a value that represents which key in the TaskResults hash table needs to be incremented if a task is deleted.

TaskProcessName TaskProcessName TaskProcessName

Gets or sets the name of the task process.

TaskProcessOwner TaskProcessOwner TaskProcessOwner

Returns the name of the owner of the task process.

TaskProcessWasCanceled TaskProcessWasCanceled TaskProcessWasCanceled

Bind to check if this task process has been canceled

TaskResults TaskResults TaskResults

Returns the results of a task process.

WebURL WebURL WebURL

The full url pointing to the web. e.g."http://www.fabrikam.com:8080/foo/bar" or "http://www.fabrikam.com/foo/bar"

Methods

AllowEnableModificationUpdateAllTasks() AllowEnableModificationUpdateAllTasks() AllowEnableModificationUpdateAllTasks()

Override this function to allow or disallow the UpdateAllTasks modificiation for this OfficeTask process

AllowEnableModificationUpdateReviewers() AllowEnableModificationUpdateReviewers() AllowEnableModificationUpdateReviewers()

Override this function to allow or disallow the UpdateReviewers modificiation for this OfficeTask process

AllowEnableWorkflowModificationCancelTaskProcess() AllowEnableWorkflowModificationCancelTaskProcess() AllowEnableWorkflowModificationCancelTaskProcess()

Override this function to allow or disallow the CancelTask modificiation for this OfficeTask process

AssignNextSetOfTasks(ActivityExecutionContext, ITaskService) AssignNextSetOfTasks(ActivityExecutionContext, ITaskService) AssignNextSetOfTasks(ActivityExecutionContext, ITaskService)
AssignNextSetOfTasksForCurrentStage(ActivityExecutionContext, ITaskService) AssignNextSetOfTasksForCurrentStage(ActivityExecutionContext, ITaskService) AssignNextSetOfTasksForCurrentStage(ActivityExecutionContext, ITaskService)

Override this method to alter how new sets of tasks are assigned, stages are evaluated and update existing modifications

Cancel(ActivityExecutionContext) Cancel(ActivityExecutionContext) Cancel(ActivityExecutionContext)
CreateTaskAssignments() CreateTaskAssignments() CreateTaskAssignments()
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)
EnableModificationUpdateReviewers(ActivityExecutionContext) EnableModificationUpdateReviewers(ActivityExecutionContext) EnableModificationUpdateReviewers(ActivityExecutionContext)
Execute(ActivityExecutionContext) Execute(ActivityExecutionContext) Execute(ActivityExecutionContext)
GetActivityDetails() GetActivityDetails() GetActivityDetails()

Gets ActivityDetails XML for this OfficeTask process

IsChangeAllowed(ActivityExecutionContext, Guid, SPWorkflowTaskProperties, SPWorkflowTaskProperties, String, String) IsChangeAllowed(ActivityExecutionContext, Guid, SPWorkflowTaskProperties, SPWorkflowTaskProperties, String, String) IsChangeAllowed(ActivityExecutionContext, Guid, SPWorkflowTaskProperties, SPWorkflowTaskProperties, String, String)

Override this function to manage if task changes should be rolled back or not Users who are allowed to change the task: 1) AssignedTo for the task, including if the original assigned to was a group, any user of the group. 2) Task process owner (TaskProcessOwner is the login name of the user/group) 3) Members of the site owners group, aka the group pointed to by SPWeb.AssociatedOwnersGroup 4) Site collection admins

IsTaskCompleted(ActivityExecutionContext, Guid, SPWorkflowTaskProperties, Hashtable, String, String) IsTaskCompleted(ActivityExecutionContext, Guid, SPWorkflowTaskProperties, Hashtable, String, String) IsTaskCompleted(ActivityExecutionContext, Guid, SPWorkflowTaskProperties, Hashtable, String, String)

Override this method to control how a task determines its completion

MoveToNextStage() MoveToNextStage() MoveToNextStage()

Moves the OfficeTask on to the next stage of this OfficeTask process

OnTaskCanceled(ActivityExecutionContext, Guid, SPWorkflowTaskProperties, String) OnTaskCanceled(ActivityExecutionContext, Guid, SPWorkflowTaskProperties, String) OnTaskCanceled(ActivityExecutionContext, Guid, SPWorkflowTaskProperties, String)

Override this method to alter behavior when this OfficeTask process has one of its tasks canceled

ShouldDelete() ShouldDelete() ShouldDelete()

Override this method to bypass reliance on DeleteTasksOnComplete

Explicit Interface Implementations

IActivityEventListener<QueueEventArgs>.OnEvent(Object, QueueEventArgs) IActivityEventListener<QueueEventArgs>.OnEvent(Object, QueueEventArgs) IActivityEventListener<QueueEventArgs>.OnEvent(Object, QueueEventArgs)

Applies to