CompositeActivity CompositeActivity CompositeActivity CompositeActivity Class

Definition

Warning

This API is now obsolete.

Derivative of Activity that is the base class for all activities that contain other activities. A CompositeActivity is responsible for managing the execution of its child activities.

public ref class CompositeActivity : System::Workflow::ComponentModel::Activity
[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
[System.Workflow.ComponentModel.Compiler.ActivityCodeGenerator(typeof(System.Workflow.ComponentModel.Compiler.CompositeActivityCodeGenerator))]
[System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.ComponentModel.Compiler.CompositeActivityValidator))]
[System.Workflow.ComponentModel.Serialization.ContentProperty("Activities")]
public class CompositeActivity : System.Workflow.ComponentModel.Activity
type CompositeActivity = class
    inherit Activity
Public Class CompositeActivity
Inherits Activity
Inheritance
Derived
Attributes

Examples

This example shows a basic CompositeActivity that executes its first child activity for execution. When the child activity moves to the Closed state, the composite activity is notified and then completes its execution.

public class HasOneChildActivity : CompositeActivity  
{  
    protected override ActivityExecutionStatus Execute(ActivityExecutionContext executionContext)  
    {  
        Activity child = this.EnabledActivities[0];  
        child.Closed += this.ChildClosed;  
        executionContext.ExecuteActivity(child);  

        return ActivityExecutionStatus.Executing;  
    }  

    void ChildClosed(object sender, ActivityExecutionStatusChangedEventArgs e)  
    {  
        e.Activity.Closed -= this.ChildClosed;  
        ActivityExecutionContext executionContext = sender as ActivityExecutionContext;  

        executionContext.CloseActivity();  
    }  
}  

Remarks

Note

This material discusses types and namespaces that are obsolete. For more information, see Deprecated Types in Windows Workflow Foundation 4.5.

A CompositeActivity manages the execution of its child activities using ActivityExecutionContext class methods and events defined on the Activity class. For example, a child activity is scheduled for execution using the ExecuteActivity of ActivityExecutionContext. A CompositeActivity activity can be notified when a child activity completes its execution by subscribing to the Closed event defined on Activity.

The workflow runtime enforces certain constraints on CompositeActivity execution, the most fundamental of which is that a CompositeActivity activity cannot move to the Closed state if any child activities are still in a Executing, Canceling, Compensating, or Faulting, state.

Constructors

CompositeActivity() CompositeActivity() CompositeActivity() CompositeActivity()

Initializes a new instance of the CompositeActivity class.

CompositeActivity(IEnumerable<Activity>) CompositeActivity(IEnumerable<Activity>) CompositeActivity(IEnumerable<Activity>) CompositeActivity(IEnumerable<Activity>)

Initializes a new instance of the CompositeActivity class from an Object which implements the IEnumerable interface with type Activity.

CompositeActivity(String) CompositeActivity(String) CompositeActivity(String) CompositeActivity(String)

Initializes a new instance of the CompositeActivity class, along with the name for that activity.

Properties

Activities Activities Activities Activities

Gets the object representing the collection, ActivityCollection, of all child activities.

CanModifyActivities CanModifyActivities CanModifyActivities CanModifyActivities

Gets or sets a value which controls whether the individual activities within Activities can be modified.

Description Description Description Description

Gets or sets the user-defined description of the Activity.

(Inherited from Activity)
DesignMode DesignMode DesignMode DesignMode

Gets the value that indicates whether this instance is in design or run-time mode.

(Inherited from DependencyObject)
Enabled Enabled Enabled Enabled

Gets or sets a value that indicates whether this instance is enabled for execution and validation.

(Inherited from Activity)
EnabledActivities EnabledActivities EnabledActivities EnabledActivities

Gets the read-only collection that represents the subset of Activities that are enabled.

ExecutionResult ExecutionResult ExecutionResult ExecutionResult

Gets the ActivityExecutionResult of the last attempt to run this instance.

(Inherited from Activity)
ExecutionStatus ExecutionStatus ExecutionStatus ExecutionStatus

Gets the current ActivityExecutionStatus of this instance.

(Inherited from Activity)
IsDynamicActivity IsDynamicActivity IsDynamicActivity IsDynamicActivity

Gets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance.

(Inherited from Activity)
Name Name Name Name

Gets or sets the name of this instance. This name must conform to the variable naming convention of the programming language that is being used in the Workflow project.

(Inherited from Activity)
Parent Parent Parent Parent

Gets the CompositeActivity that contains this Activity.

(Inherited from Activity)
ParentDependencyObject ParentDependencyObject ParentDependencyObject ParentDependencyObject

Gets the parent DependencyObject in the DependencyObject graph.

(Inherited from DependencyObject)
QualifiedName QualifiedName QualifiedName QualifiedName

Gets the qualified name of the activity. Qualified activity names are always unique in a workflow instance.

(Inherited from Activity)
Site Site Site Site

Gets or sets a reference to the Site component of the DependencyObject.

(Inherited from DependencyObject)
UserData UserData UserData UserData

Gets an IDictionary that associates custom data with this class instance.

(Inherited from DependencyObject)
WorkflowInstanceId WorkflowInstanceId WorkflowInstanceId WorkflowInstanceId

Gets the Guid associated with the instance.

(Inherited from Activity)

Methods

AddHandler(DependencyProperty, Object) AddHandler(DependencyProperty, Object) AddHandler(DependencyProperty, Object) AddHandler(DependencyProperty, Object)

Adds a handler for an event of a DependencyObject.

(Inherited from DependencyObject)
ApplyWorkflowChanges(WorkflowChanges) ApplyWorkflowChanges(WorkflowChanges) ApplyWorkflowChanges(WorkflowChanges) ApplyWorkflowChanges(WorkflowChanges)

Applies the WorkflowChanges manifest in the parameter to this instance.

Cancel(ActivityExecutionContext) Cancel(ActivityExecutionContext) Cancel(ActivityExecutionContext) Cancel(ActivityExecutionContext)

Called by the workflow runtime to cancel execution of an activity that is currently executing.

(Inherited from Activity)
Clone() Clone() Clone() Clone()

Creates a deep copy of the Activity.

(Inherited from Activity)
Dispose() Dispose() Dispose() Dispose()

Releases all the resources used by the DependencyObject.

(Inherited from DependencyObject)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Calls Dispose(Boolean) on this instance, and optionally calls Dispose() on all child activities of this instance.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Execute(ActivityExecutionContext) Execute(ActivityExecutionContext) Execute(ActivityExecutionContext) Execute(ActivityExecutionContext)

Called by the workflow runtime to execute an activity.

(Inherited from Activity)
GetActivityByName(String) GetActivityByName(String) GetActivityByName(String) GetActivityByName(String)

Returns the instance of the Activity whose name is requested from the set of all activities running under the root activity of this instance, which is within the workflow.

(Inherited from Activity)
GetActivityByName(String, Boolean) GetActivityByName(String, Boolean) GetActivityByName(String, Boolean) GetActivityByName(String, Boolean)

Returns the instance of the Activity whose name is requested from the set of all activities under the root the Activity of this instance if the second parameter is false and under the current Activity if the second parameter is true.

(Inherited from Activity)
GetBinding(DependencyProperty) GetBinding(DependencyProperty) GetBinding(DependencyProperty) GetBinding(DependencyProperty)

Provides access to the ActivityBind associated with the specific DependencyProperty.

(Inherited from DependencyObject)
GetBoundValue(ActivityBind, Type) GetBoundValue(ActivityBind, Type) GetBoundValue(ActivityBind, Type) GetBoundValue(ActivityBind, Type)

Retrieves the Object that is the subject of an ActivityBind.

(Inherited from DependencyObject)
GetDynamicActivities(Activity) GetDynamicActivities(Activity) GetDynamicActivities(Activity) GetDynamicActivities(Activity)

Returns an array that contains all of the currently executing instances of the specified activity.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetInvocationList<T>(DependencyProperty) GetInvocationList<T>(DependencyProperty) GetInvocationList<T>(DependencyProperty) GetInvocationList<T>(DependencyProperty)

Gets an array that contains the delegates for the specified DependencyProperty.

(Inherited from DependencyObject)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Provides access to the value of the designated DependencyProperty.

(Inherited from DependencyObject)
GetValueBase(DependencyProperty) GetValueBase(DependencyProperty) GetValueBase(DependencyProperty) GetValueBase(DependencyProperty)

Provides access to the bound object of a DependencyProperty and bypasses the GetValue(DependencyProperty) override.

(Inherited from DependencyObject)
HandleFault(ActivityExecutionContext, Exception) HandleFault(ActivityExecutionContext, Exception) HandleFault(ActivityExecutionContext, Exception) HandleFault(ActivityExecutionContext, Exception)

Called when an exception is raised within the context of the execution of this instance.

Initialize(IServiceProvider) Initialize(IServiceProvider) Initialize(IServiceProvider) Initialize(IServiceProvider)

Initializes all appropriate child activities of this instance and the specified IServiceProvider.

InitializeProperties() InitializeProperties() InitializeProperties() InitializeProperties()

Performs initialization on dependency properties when overridden in a derived class.

(Inherited from DependencyObject)
Invoke<T>(EventHandler<T>, T) Invoke<T>(EventHandler<T>, T) Invoke<T>(EventHandler<T>, T) Invoke<T>(EventHandler<T>, T)

Subscribes an EventHandler and invokes that delegate.

(Inherited from Activity)
Invoke<T>(IActivityEventListener<T>, T) Invoke<T>(IActivityEventListener<T>, T) Invoke<T>(IActivityEventListener<T>, T) Invoke<T>(IActivityEventListener<T>, T)

Subscribes an IActivityEventListener<T> and invokes that delegate.

(Inherited from Activity)
IsBindingSet(DependencyProperty) IsBindingSet(DependencyProperty) IsBindingSet(DependencyProperty) IsBindingSet(DependencyProperty)

Indicates whether the value of a DependencyProperty is set as a binding. See SetBinding(DependencyProperty, ActivityBind).

(Inherited from DependencyObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MetaEquals(DependencyObject) MetaEquals(DependencyObject) MetaEquals(DependencyObject) MetaEquals(DependencyObject)

Determines whether the metaproperties of this DependencyObject equals the metaproperties of the parameterized DependencyObject.

(Inherited from DependencyObject)
OnActivityChangeAdd(ActivityExecutionContext, Activity) OnActivityChangeAdd(ActivityExecutionContext, Activity) OnActivityChangeAdd(ActivityExecutionContext, Activity) OnActivityChangeAdd(ActivityExecutionContext, Activity)

Calls when an activity is added.

OnActivityChangeRemove(ActivityExecutionContext, Activity) OnActivityChangeRemove(ActivityExecutionContext, Activity) OnActivityChangeRemove(ActivityExecutionContext, Activity) OnActivityChangeRemove(ActivityExecutionContext, Activity)

Called when an activity is removed.

OnActivityExecutionContextLoad(IServiceProvider) OnActivityExecutionContextLoad(IServiceProvider) OnActivityExecutionContextLoad(IServiceProvider) OnActivityExecutionContextLoad(IServiceProvider)

Called by the workflow runtime engine every time the ActivityExecutionContext for this activity is loaded.

OnActivityExecutionContextUnload(IServiceProvider) OnActivityExecutionContextUnload(IServiceProvider) OnActivityExecutionContextUnload(IServiceProvider) OnActivityExecutionContextUnload(IServiceProvider)

Called by the workflow runtime engine every time the ActivityExecutionContext for this activity is unloaded.

OnClosed(IServiceProvider) OnClosed(IServiceProvider) OnClosed(IServiceProvider) OnClosed(IServiceProvider)

Called by the workflow runtime as part of the activity's transition to the closed state.

(Inherited from Activity)
OnListChanged(ActivityCollectionChangeEventArgs) OnListChanged(ActivityCollectionChangeEventArgs) OnListChanged(ActivityCollectionChangeEventArgs) OnListChanged(ActivityCollectionChangeEventArgs)

Performs additional processing when the Activities property changes.

OnListChanging(ActivityCollectionChangeEventArgs) OnListChanging(ActivityCollectionChangeEventArgs) OnListChanging(ActivityCollectionChangeEventArgs) OnListChanging(ActivityCollectionChangeEventArgs)

Event that occurs before a change being made to the underlying Activities.

OnWorkflowChangesCompleted(ActivityExecutionContext) OnWorkflowChangesCompleted(ActivityExecutionContext) OnWorkflowChangesCompleted(ActivityExecutionContext) OnWorkflowChangesCompleted(ActivityExecutionContext)

Called after changes have been made to the collection Activities of this instance.

RaiseEvent(DependencyProperty, Object, EventArgs) RaiseEvent(DependencyProperty, Object, EventArgs) RaiseEvent(DependencyProperty, Object, EventArgs) RaiseEvent(DependencyProperty, Object, EventArgs)

Raises an Event associated with the specified dependency property.

(Inherited from Activity)
RaiseGenericEvent<T>(DependencyProperty, Object, T) RaiseGenericEvent<T>(DependencyProperty, Object, T) RaiseGenericEvent<T>(DependencyProperty, Object, T) RaiseGenericEvent<T>(DependencyProperty, Object, T)

Raises the event associated with the referenced DependencyProperty.

(Inherited from Activity)
RegisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>) RegisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>) RegisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>) RegisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)

Registers the specified DependencyProperty for the status change event.

(Inherited from Activity)
RemoveHandler(DependencyProperty, Object) RemoveHandler(DependencyProperty, Object) RemoveHandler(DependencyProperty, Object) RemoveHandler(DependencyProperty, Object)

Removes an EventHandler from an associated DependencyProperty.

(Inherited from DependencyObject)
RemoveProperty(DependencyProperty) RemoveProperty(DependencyProperty) RemoveProperty(DependencyProperty) RemoveProperty(DependencyProperty)

Removes a DependencyProperty from the DependencyObject.

(Inherited from DependencyObject)
Save(Stream) Save(Stream) Save(Stream) Save(Stream)

Writes the Activity to a Stream for persistence.

(Inherited from Activity)
Save(Stream, IFormatter) Save(Stream, IFormatter) Save(Stream, IFormatter) Save(Stream, IFormatter)

Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization.

(Inherited from Activity)
SetBinding(DependencyProperty, ActivityBind) SetBinding(DependencyProperty, ActivityBind) SetBinding(DependencyProperty, ActivityBind) SetBinding(DependencyProperty, ActivityBind)

Sets the ActivityBind for the specified DependencyProperty.

(Inherited from DependencyObject)
SetBoundValue(ActivityBind, Object) SetBoundValue(ActivityBind, Object) SetBoundValue(ActivityBind, Object) SetBoundValue(ActivityBind, Object)

Sets the value of the target ActivityBind.

(Inherited from DependencyObject)
SetReadOnlyPropertyValue(DependencyProperty, Object) SetReadOnlyPropertyValue(DependencyProperty, Object) SetReadOnlyPropertyValue(DependencyProperty, Object) SetReadOnlyPropertyValue(DependencyProperty, Object)

Sets the value of a DependencyProperty, which is read-only.

(Inherited from DependencyObject)
SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object)

Sets the value of the DependencyProperty to the object.

(Inherited from DependencyObject)
SetValueBase(DependencyProperty, Object) SetValueBase(DependencyProperty, Object) SetValueBase(DependencyProperty, Object) SetValueBase(DependencyProperty, Object)

Sets the value of the DependencyProperty to the specified Object, bypassing the SetValue(DependencyProperty, Object).

(Inherited from DependencyObject)
ToString() ToString() ToString() ToString()

Provides a string that represents this instance.

(Inherited from Activity)
TrackData(Object) TrackData(Object) TrackData(Object) TrackData(Object)

Informs the run-time tracking infrastructure of pending tracking information.

(Inherited from Activity)
TrackData(String, Object) TrackData(String, Object) TrackData(String, Object) TrackData(String, Object)

Informs the run-time tracking infrastructure of pending tracking information.

(Inherited from Activity)
Uninitialize(IServiceProvider) Uninitialize(IServiceProvider) Uninitialize(IServiceProvider) Uninitialize(IServiceProvider)

Called by the workflow runtime engine when an activity transitions into the Closed state from the Initialized state.

UnregisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>) UnregisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>) UnregisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>) UnregisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)

Un-registers the specified DependencyProperty for the status change event.

(Inherited from Activity)

Events

Canceling Canceling Canceling Canceling

Occurs when the activity execution is canceled.

(Inherited from Activity)
Closed Closed Closed Closed

Occurs when an Activity has completed execution.

(Inherited from Activity)
Compensating Compensating Compensating Compensating

Occurs when running a compensation method on the Activity.

(Inherited from Activity)
Executing Executing Executing Executing

Occurs when the Activity is run.

(Inherited from Activity)
Faulting Faulting Faulting Faulting

Occurs when an exception is raised during the running of the instance.

(Inherited from Activity)
IComponent.Disposed IComponent.Disposed IComponent.Disposed IComponent.Disposed Inherited from DependencyObject
StatusChanged StatusChanged StatusChanged StatusChanged

Occurs when the ActivityExecutionStatus of a running Activity changes.

(Inherited from Activity)

Applies to