Export (0) Print
Expand All

CompositeActivity Class

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.

System.Object
  System.Workflow.ComponentModel.DependencyObject
    System.Workflow.ComponentModel.Activity
      System.Workflow.ComponentModel.CompositeActivity
        More...

Namespace:  System.Workflow.ComponentModel
Assembly:  System.Workflow.ComponentModel (in System.Workflow.ComponentModel.dll)

'Declaration
<ActivityValidatorAttribute(GetType(CompositeActivityValidator))> _
<ActivityCodeGeneratorAttribute(GetType(CompositeActivityCodeGenerator))> _
<ContentPropertyAttribute("Activities")> _
Public Class CompositeActivity _
	Inherits Activity

The CompositeActivity type exposes the following members.

  NameDescription
Public methodCompositeActivityInitializes a new instance of the CompositeActivity class.
Public methodCompositeActivity(IEnumerable(Of Activity))Initializes a new instance of the CompositeActivity class from an Object which implements the IEnumerable interface with type Activity.
Public methodCompositeActivity(String)Initializes a new instance of the CompositeActivity class, along with the name for that activity.
Top

  NameDescription
Public propertyActivitiesGets the object representing the collection, ActivityCollection, of all child activities.
Protected propertyCanModifyActivitiesGets or sets a value which controls whether the individual activities within Activities can be modified.
Public propertyDescriptionGets or sets the user-defined description of the Activity. (Inherited from Activity.)
Protected propertyDesignModeGets the value that indicates whether this instance is in design or run-time mode. (Inherited from DependencyObject.)
Public propertyEnabledGets or sets a value that indicates whether this instance is enabled for execution and validation. (Inherited from Activity.)
Public propertyEnabledActivitiesGets the read-only collection that represents the subset of Activities that are enabled.
Public propertyExecutionResultGets the ActivityExecutionResult of the last attempt to run this instance. (Inherited from Activity.)
Public propertyExecutionStatusGets the current ActivityExecutionStatus of this instance. (Inherited from Activity.)
Public propertyIsDynamicActivityGets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance. (Inherited from Activity.)
Public propertyNameGets 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.)
Public propertyParentGets the CompositeActivity that contains this Activity. (Inherited from Activity.)
Protected propertyParentDependencyObjectGets the parent DependencyObject in the DependencyObject graph. (Inherited from DependencyObject.)
Public propertyQualifiedNameGets the qualified name of the activity. Qualified activity names are always unique in a workflow instance. (Inherited from Activity.)
Public propertySiteGets or sets a reference to the Site component of the DependencyObject. (Inherited from DependencyObject.)
Public propertyUserDataGets an IDictionary that associates custom data with this class instance. (Inherited from DependencyObject.)
Protected propertyWorkflowInstanceIdGets the Guid associated with the instance. (Inherited from Activity.)
Top

  NameDescription
Public methodAddHandlerAdds a handler for an event of a DependencyObject. (Inherited from DependencyObject.)
Protected methodApplyWorkflowChangesApplies the WorkflowChanges manifest in the parameter to this instance.
Protected methodCancelCalled by the workflow runtime to cancel execution of an activity that is currently executing. (Inherited from Activity.)
Public methodCloneCreates a deep copy of the Activity. (Inherited from Activity.)
Public methodDisposeReleases all the resources used by the DependencyObject. (Inherited from DependencyObject.)
Protected methodDispose(Boolean)Calls Dispose on this instance, and optionally calls Dispose on all child activities of this instance. (Overrides DependencyObject.Dispose(Boolean).)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodExecuteCalled by the workflow runtime to execute an activity. (Inherited from Activity.)
Protected methodFinalizeProvided as an override to Object.Finalize to clean up any unmanaged resources deterministically. (Inherited from DependencyObject.)
Public methodGetActivityByName(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.)
Public methodGetActivityByName(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.)
Public methodGetBindingProvides access to the ActivityBind associated with the specific DependencyProperty. (Inherited from DependencyObject.)
Protected methodGetBoundValueRetrieves the Object that is the subject of an ActivityBind. (Inherited from DependencyObject.)
Protected methodGetDynamicActivitiesReturns an array that contains all of the currently executing instances of the specified activity.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetInvocationList(Of T)Gets an array that contains the delegates for the specified DependencyProperty. (Inherited from DependencyObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueProvides access to the value of the designated DependencyProperty. (Inherited from DependencyObject.)
Public methodGetValueBaseProvides access to the bound object of a DependencyProperty and bypasses the GetValue override. (Inherited from DependencyObject.)
Protected methodHandleFaultCalled when an exception is raised within the context of the execution of this instance. (Overrides Activity.HandleFault(ActivityExecutionContext, Exception).)
Protected methodInitializeInitializes all appropriate child activities of this instance and the specified IServiceProvider. (Overrides Activity.Initialize(IServiceProvider).)
Protected methodInitializePropertiesPerforms initialization on dependency properties when overridden in a derived class. (Inherited from DependencyObject.)
Protected methodInvoke(Of T)(EventHandler(Of T), T)Subscribes an EventHandler and invokes that delegate. (Inherited from Activity.)
Protected methodInvoke(Of T)(IActivityEventListener(Of T), T)Subscribes an IActivityEventListener(Of T) and invokes that delegate. (Inherited from Activity.)
Public methodIsBindingSetIndicates whether the value of a DependencyProperty is set as a binding. See SetBinding. (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMetaEqualsDetermines whether the metaproperties of this DependencyObject equals the metaproperties of the parameterized DependencyObject. (Inherited from DependencyObject.)
Protected methodOnActivityChangeAddCalls when an activity is added.
Protected methodOnActivityChangeRemoveCalled when an activity is removed.
Protected methodOnActivityExecutionContextLoadCalled by the workflow runtime engine every time the ActivityExecutionContext for this activity is loaded. (Overrides Activity.OnActivityExecutionContextLoad(IServiceProvider).)
Protected methodOnActivityExecutionContextUnloadCalled by the workflow runtime engine every time the ActivityExecutionContext for this activity is unloaded. (Overrides Activity.OnActivityExecutionContextUnload(IServiceProvider).)
Protected methodOnClosedCalled by the workflow runtime as part of the activity's transition to the closed state. (Inherited from Activity.)
Protected methodOnListChangedPerforms additional processing when the Activities property changes.
Protected methodOnListChangingEvent that occurs before a change being made to the underlying Activities.
Protected methodOnWorkflowChangesCompletedCalled after changes have been made to the collection Activities of this instance.
Protected methodRaiseEventRaises an Event associated with the specified dependency property. (Inherited from Activity.)
Protected methodRaiseGenericEvent(Of T)Raises the event associated with the referenced DependencyProperty. (Inherited from Activity.)
Public methodRegisterForStatusChangeRegisters the specified DependencyProperty for the status change event. (Inherited from Activity.)
Public methodRemoveHandlerRemoves an EventHandler from an associated DependencyProperty. (Inherited from DependencyObject.)
Public methodRemovePropertyRemoves a DependencyProperty from the DependencyObject. (Inherited from DependencyObject.)
Public methodSave(Stream)Writes the Activity to a Stream for persistence. (Inherited from Activity.)
Public methodSave(Stream, IFormatter)Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization. (Inherited from Activity.)
Public methodSetBindingSets the ActivityBind for the specified DependencyProperty. (Inherited from DependencyObject.)
Protected methodSetBoundValueSets the value of the target ActivityBind. (Inherited from DependencyObject.)
Protected methodSetReadOnlyPropertyValueSets the value of a DependencyProperty, which is read-only. (Inherited from DependencyObject.)
Public methodSetValueSets the value of the DependencyProperty to the object. (Inherited from DependencyObject.)
Public methodSetValueBaseSets the value of the DependencyProperty to the specified Object, bypassing the SetValue. (Inherited from DependencyObject.)
Public methodToStringProvides a string that represents this instance. (Inherited from Activity.)
Protected methodTrackData(Object)Informs the run-time tracking infrastructure of pending tracking information. (Inherited from Activity.)
Protected methodTrackData(String, Object)Informs the run-time tracking infrastructure of pending tracking information. (Inherited from Activity.)
Protected methodUninitializeCalled by the workflow runtime engine when an activity transitions into the Closed state from the Initialized state. (Overrides Activity.Uninitialize(IServiceProvider).)
Public methodUnregisterForStatusChangeUn-registers the specified DependencyProperty for the status change event. (Inherited from Activity.)
Top

  NameDescription
Public eventCancelingOccurs when the activity execution is canceled. (Inherited from Activity.)
Public eventClosedOccurs when an Activity has completed execution. (Inherited from Activity.)
Public eventCompensatingOccurs when running a compensation method on the Activity. (Inherited from Activity.)
Public eventExecutingOccurs when the Activity is run. (Inherited from Activity.)
Public eventFaultingOccurs when an exception is raised during the running of the instance. (Inherited from Activity.)
Public eventStatusChangedOccurs when the ActivityExecutionStatus of a running Activity changes. (Inherited from Activity.)
Top

  NameDescription
Explicit interface implemetationPrivate eventIComponent.DisposedRepresents the method that handles the Disposed event of a component. (Inherited from DependencyObject.)
Top

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.

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();
    }
}

.NET Framework

Supported in: 4, 3.5, 3.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft