OfficeTask members
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.
The OfficeTask type exposes the following members.
Constructors
Name | Description | |
---|---|---|
OfficeTask | Creates a new instance of the OfficeTask class. |
Top
Properties
Name | Description | |
---|---|---|
__ActivationProperties | A activation properties for this OfficeTask's workflow. This property is recommended to be set. | |
__Context | An optional WorkflowContext for this OfficeTask. Binding this property is reccomended. | |
ActiveTaskCount | ||
Activities | (Inherited from CompositeActivity.) | |
AllowChangeRequest | Indicates whether a user can request a change to a workflow task. | |
AllowReassign | Indicates whether a user can reassign a workflow task to someone else. | |
AssignedTaskCount | ||
AssignedTo | Returns the names of the people assigned to the tasks in a task process. | |
Assignments | A container of all of the initial stages for this OfficeTask. | |
CanModifyActivities | (Inherited from CompositeActivity.) | |
CC | Returns an array of user names or e-mail addresses included on the CC line of task process notification e-mail messages. | |
CCList | A string form of the CC property in the format of Microsoft.Office.Workflow.Utility.Contact XML | |
Comments | Returns the value of the Description field of task list items that are created by the task process. | |
CompletedTaskCount | Returns the number of tasks in the task process that are marked as completed. | |
ConsolidatedComments | ||
ContentTypeId | Returns the value of the ContentTypeId property of the task. | |
CurrentUICulture | Correct CultureInfo to use for UI this OfficeTask process | |
CurrentWeb | The SPWeb of this workflow, with its Site.CurrentUser set according to impersonation settings in the workflow | |
DeletedTaskCount | The number of deleted tasks for this OfficeTask process | |
DeleteTasksOnComplete | Indicates whether the child tasks of the task process should be deleted when they are marked as completed. | |
Description | (Inherited from Activity.) | |
DesignMode | (Inherited from DependencyObject.) | |
DueDate | Returns the date when child tasks of the task process are due to be completed. | |
Duration | Returns the amount of time from when the task was initially created to when it is due to be completed. | |
DurationUnit | Get or sets an enumeration value that indicates whether the value of the Duration property is counted in days, weeks, or months. | |
Enabled | (Inherited from Activity.) | |
EnabledActivities | (Inherited from CompositeActivity.) | |
ExecutionResult | (Inherited from Activity.) | |
ExecutionStatus | (Inherited from Activity.) | |
ExpandGroups | Indicates whether a task is assigned to each member of a group or to an entire group. | |
FutureTaskCount | ||
IsDynamicActivity | (Inherited from Activity.) | |
Item | The SPListItem indicated by this OfficeTask's ItemId property | |
ItemCreatedBy | loginName of the SPUser who created the item for this OfficeTask process | |
ItemExternalURL | ||
ItemId | Returns the ID of the of list item that represents the workflow task that the task process is executing against. | |
ItemModifiedBy | loginName of the SPUser who last modified the item for this OfficeTask process | |
ItemTitle | encoded title property of the SPListItem for this OfficeTask process | |
ItemTitleNotEncoded | unencoded title property of the SPListItem for this OfficeTask process | |
ItemURL | encoded web-relative URL for the item for this OfficeTask process | |
List | The SPList indicated by this OfficeTask's ListId property | |
ListId | Returns the ID of the list that contains the workflow task that the task process is executing against. | |
Name | (Inherited from Activity.) | |
Outcomes | A list of outcomes for all tasks in this process, in the form of "display1,outcome1;display2,outcome2" | |
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 | 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. | |
Parent | (Inherited from Activity.) | |
ParentDependencyObject | (Inherited from DependencyObject.) | |
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 | Returns the set of permissions associated with the workflow task list items that are generated as part of the task process. | |
QualifiedName | (Inherited from Activity.) | |
SendDefaultTaskNotifications | Indicates whether default task notifications are sent for a task created by the task process. | |
Site | (Inherited from DependencyObject.) | |
Subject | Returns the value of the Subject property of a workflow task. | |
SuperWeb | an SPWeb created from an SPSite impersonated as the process account | |
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 | Gets or sets the name of the task process. | |
TaskProcessOwner | Returns the name of the owner of the task process. | |
TaskProcessWasCanceled | Bind to check if this task process has been canceled | |
TaskResults | Returns the results of a task process. | |
UserData | (Inherited from DependencyObject.) | |
WebURL | The full url pointing to the web. e.g."http://www.fabrikam.com:8080/foo/bar" or "http://www.fabrikam.com/foo/bar" | |
WorkflowInstanceId | (Inherited from Activity.) |
Top
Methods
Name | Description | |
---|---|---|
AddHandler | (Inherited from DependencyObject.) | |
AllowEnableModificationUpdateAllTasks | Override this function to allow or disallow the UpdateAllTasks modificiation for this OfficeTask process | |
AllowEnableModificationUpdateReviewers | Override this function to allow or disallow the UpdateReviewers modificiation for this OfficeTask process | |
AllowEnableWorkflowModificationCancelTaskProcess | Override this function to allow or disallow the CancelTask modificiation for this OfficeTask process | |
ApplyWorkflowChanges | (Inherited from CompositeActivity.) | |
AssignNextSetOfTasks | ||
AssignNextSetOfTasksForCurrentStage | Override this method to alter how new sets of tasks are assigned, stages are evaluated and update existing modifications | |
Cancel | (Overrides Activity.Cancel(ActivityExecutionContext).) | |
Clone | (Inherited from Activity.) | |
CreateTaskAssignments | ||
Dispose() | (Inherited from DependencyObject.) | |
Dispose(Boolean) | (Overrides CompositeActivity.Dispose(Boolean).) | |
EnableModificationUpdateReviewers | ||
Equals | (Inherited from Object.) | |
Execute | (Overrides Activity.Execute(ActivityExecutionContext).) | |
Finalize | (Inherited from DependencyObject.) | |
GetActivityByName(String) | (Inherited from Activity.) | |
GetActivityByName(String, Boolean) | (Inherited from Activity.) | |
GetActivityDetails | Gets ActivityDetails XML for this OfficeTask process | |
GetBinding | (Inherited from DependencyObject.) | |
GetBoundValue | (Inherited from DependencyObject.) | |
GetDynamicActivities | (Inherited from CompositeActivity.) | |
GetHashCode | (Inherited from Object.) | |
GetInvocationList<T> | (Inherited from DependencyObject.) | |
GetType | (Inherited from Object.) | |
GetValue | (Inherited from DependencyObject.) | |
GetValueBase | (Inherited from DependencyObject.) | |
HandleFault | (Inherited from CompositeActivity.) | |
Initialize | (Inherited from CompositeActivity.) | |
InitializeProperties | (Inherited from DependencyObject.) | |
Invoke<T>(EventHandler<T>, T) | (Inherited from Activity.) | |
Invoke<T>(IActivityEventListener<T>, T) | (Inherited from Activity.) | |
IsBindingSet | (Inherited from DependencyObject.) | |
IsChangeAllowed | 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 | Override this method to control how a task determines its completion | |
MemberwiseClone | (Inherited from Object.) | |
MetaEquals | (Inherited from DependencyObject.) | |
MoveToNextStage | Moves the OfficeTask on to the next stage of this OfficeTask process | |
OnActivityChangeAdd | (Inherited from CompositeActivity.) | |
OnActivityChangeRemove | (Inherited from CompositeActivity.) | |
OnActivityExecutionContextLoad | (Inherited from CompositeActivity.) | |
OnActivityExecutionContextUnload | (Inherited from CompositeActivity.) | |
OnClosed | (Inherited from Activity.) | |
OnListChanged | (Inherited from CompositeActivity.) | |
OnListChanging | (Inherited from CompositeActivity.) | |
OnTaskCanceled | Override this method to alter behavior when this OfficeTask process has one of its tasks canceled | |
OnWorkflowChangesCompleted | (Inherited from CompositeActivity.) | |
RaiseEvent | (Inherited from Activity.) | |
RaiseGenericEvent<T> | (Inherited from Activity.) | |
RegisterForStatusChange | (Inherited from Activity.) | |
RemoveHandler | (Inherited from DependencyObject.) | |
RemoveProperty | (Inherited from DependencyObject.) | |
Save(Stream) | (Inherited from Activity.) | |
Save(Stream, IFormatter) | (Inherited from Activity.) | |
SetBinding | (Inherited from DependencyObject.) | |
SetBoundValue | (Inherited from DependencyObject.) | |
SetReadOnlyPropertyValue | (Inherited from DependencyObject.) | |
SetValue | (Inherited from DependencyObject.) | |
SetValueBase | (Inherited from DependencyObject.) | |
ShouldDelete | Override this method to bypass reliance on DeleteTasksOnComplete | |
ToString | (Inherited from Activity.) | |
TrackData(Object) | (Inherited from Activity.) | |
TrackData(String, Object) | (Inherited from Activity.) | |
Uninitialize | (Inherited from CompositeActivity.) | |
UnregisterForStatusChange | (Inherited from Activity.) |
Top
Events
Name | Description | |
---|---|---|
Canceling | (Inherited from Activity.) | |
Closed | (Inherited from Activity.) | |
Compensating | (Inherited from Activity.) | |
Executing | (Inherited from Activity.) | |
Faulting | (Inherited from Activity.) | |
StatusChanged | (Inherited from Activity.) |
Top
Fields
Name | Description | |
---|---|---|
__ActivationPropertiesProperty | Represents a DependencyProperty object that contains the initial properties of the workflow instance as it starts. Initialization properties are stored in an SPWorkflowActivationProperties object exposed by the dependency property. | |
__ContextProperty | Returns a DependencyProperty object that a solution developer can use to promote the context of the task. | |
AssignedToProperty | Returns a DependencyProperty object that a solution developer can use to promote the AssignedTo property of the SharePoint Foundation 2010 list item that is associated with the workflow instance. | |
CCProperty | Returns a DependencyProperty object that a solution developer can use to promote the CC property of the SharePoint Foundation 2010 list item that is associated with the workflow instance. | |
CommentsProperty | Returns a DependencyProperty object that a solution developer can use to promote the Comments property of the SharePoint Foundation 2010 list item that is associated with the workflow instance. | |
ContentTypeIdProperty | A DependencyProperty used to promote the ContentTypeId property of the SharePoint list item associated with the running workflow instance. | |
DeleteTasksOnCompleteProperty | A DependencyProperty used to promote the Boolean DeleteTasksOnComplete property of the SharePoint list item associated with the running workflow instance. | |
DueDateProperty | A DependencyProperty used to promote the DueDate property of the SharePoint list item associated with the running workflow instance. | |
DurationProperty | A DependencyProperty used to promote the Duration property of the SharePoint list item associated with the running workflow instance. | |
DurationUnitProperty | A DependencyProperty used to promote the DurationUnit property of the SharePoint list item associated with the running workflow instance. | |
ExpandGroupsProperty | ||
ItemIdProperty | DependencyProperty for a bindable property of this workflow activity. This should not be used directly. | |
ListIdProperty | DependencyProperty for a bindable property of this workflow activity. This should not be used directly. | |
OutcomesProperty | A DependencyProperty used to promote the Outcomes property of the list item associated with the task. | |
OverdueRepeatProperty | ||
OverdueRepeatTimesProperty | ||
PermissionSetProperty | ||
SendDefaultTaskNotificationsProperty | ||
SubjectProperty | ||
TaskDeletedOutcomeProperty | ||
TaskProcessNameProperty | ||
TaskProcessOwnerProperty |
Top
Explicit interface implementations
Name | Description | |
---|---|---|
IActivityEventListener<QueueEventArgs>.OnEvent | ||
IComponent.Disposed | (Inherited from DependencyObject.) |
Top