ReplicatorActivity Class

 
Note: This API is now obsolete.

Runs multiple instances of a child activity.

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


[ToolboxBitmapAttribute(typeof(ReplicatorActivity), "Resources.Replicator.png")]
[WorkflowDebuggerSteppingAttribute(WorkflowDebuggerSteppingOption.Concurrent)]
[ObsoleteAttribute("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public sealed class ReplicatorActivity : CompositeActivity

NameDescription
System_CAPS_pubmethodReplicatorActivity()

Initializes a new instance of the ReplicatorActivity class.

System_CAPS_pubmethodReplicatorActivity(String)

Initializes a new instance of the ReplicatorActivity class using the name of the activity.

NameDescription
System_CAPS_pubpropertyActivities

Gets the object representing the collection, ActivityCollection, of all child activities.(Inherited from CompositeActivity.)

System_CAPS_pubpropertyAllChildrenComplete

Gets a value that indicates whether all child instances are complete.

System_CAPS_protpropertyCanModifyActivities

Gets or sets a value which controls whether the individual activities within Activities can be modified.(Inherited from CompositeActivity.)

System_CAPS_pubpropertyCurrentChildData

Returns a list of all child activities.

System_CAPS_pubpropertyCurrentIndex

Gets the index position of the current child activity.

System_CAPS_pubpropertyDescription

Gets or sets the user-defined description of the Activity.(Inherited from Activity.)

System_CAPS_protpropertyDesignMode

Gets the value that indicates whether this instance is in design or run-time mode.(Inherited from DependencyObject.)

System_CAPS_pubpropertyDynamicActivities

Gets an array of running child activity instances.

System_CAPS_pubpropertyEnabled

Gets or sets a value that indicates whether this instance is enabled for execution and validation.(Inherited from Activity.)

System_CAPS_pubpropertyEnabledActivities

Gets the read-only collection that represents the subset of Activities that are enabled. (Inherited from CompositeActivity.)

System_CAPS_pubpropertyExecutionResult

Gets the ActivityExecutionResult of the last attempt to run this instance.(Inherited from Activity.)

System_CAPS_pubpropertyExecutionStatus

Gets the current ActivityExecutionStatus of this instance.(Inherited from Activity.)

System_CAPS_pubpropertyExecutionType

Gets or sets the ExecutionType for the ReplicatorActivity.

System_CAPS_pubpropertyInitialChildData

Gets or sets a list of child activity data.

System_CAPS_pubpropertyIsDynamicActivity

Gets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance.(Inherited from Activity.)

System_CAPS_pubpropertyName

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.)

System_CAPS_pubpropertyParent

Gets the CompositeActivity that contains this Activity.(Inherited from Activity.)

System_CAPS_pubpropertyQualifiedName

Gets the qualified name of the activity. Qualified activity names are always unique in a workflow instance.(Inherited from Activity.)

System_CAPS_pubpropertySite

Gets or sets a reference to the Site component of the DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubpropertyUntilCondition

Gets or sets a completion condition that indicates when the ReplicatorActivity should finish.

System_CAPS_pubpropertyUserData

Gets an IDictionary that associates custom data with this class instance.(Inherited from DependencyObject.)

NameDescription
System_CAPS_pubmethodAddHandler(DependencyProperty, Object)

Adds a handler for an event of a DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodCancel(ActivityExecutionContext)

Called by the workflow runtime to cancel execution of an activity that is currently executing.(Inherited from Activity.)

System_CAPS_pubmethodClone()

Creates a deep copy of the Activity.(Inherited from Activity.)

System_CAPS_pubmethodDispose()

Releases all the resources used by the DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodExecute(ActivityExecutionContext)

Called by the workflow runtime to execute an activity. (Inherited from Activity.)

System_CAPS_pubmethodGetActivityByName(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.)

System_CAPS_pubmethodGetActivityByName(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.)

System_CAPS_pubmethodGetBinding(DependencyProperty)

Provides access to the ActivityBind associated with the specific DependencyProperty.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(DependencyProperty)

Provides access to the value of the designated DependencyProperty.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetValueBase(DependencyProperty)

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

System_CAPS_protmethodHandleFault(ActivityExecutionContext, Exception)

Called when an exception is raised within the context of the execution of this instance.(Inherited from CompositeActivity.)

System_CAPS_protmethodInitialize(IServiceProvider)

Initializes all appropriate child activities of this instance and the specified IServiceProvider.(Inherited from CompositeActivity.)

System_CAPS_protmethodInvoke<T>(EventHandler<T>, T)

Subscribes an EventHandler and invokes that delegate.(Inherited from Activity.)

System_CAPS_protmethodInvoke<T>(IActivityEventListener<T>, T)

Subscribes an IActivityEventListener<T> and invokes that delegate.(Inherited from Activity.)

System_CAPS_pubmethodIsBindingSet(DependencyProperty)

Indicates whether the value of a DependencyProperty is set as a binding. See SetBinding.(Inherited from DependencyObject.)

System_CAPS_pubmethodIsExecuting(Int32)

Indicates whether the specified child activity is currently executing.

System_CAPS_pubmethodMetaEquals(DependencyObject)

Determines whether the metaproperties of this DependencyObject equals the metaproperties of the parameterized DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodOnActivityChangeAdd(ActivityExecutionContext, Activity)

Calls when an activity is added.(Inherited from CompositeActivity.)

System_CAPS_protmethodOnActivityChangeRemove(ActivityExecutionContext, Activity)

Called when an activity is removed.(Inherited from CompositeActivity.)

System_CAPS_protmethodOnActivityExecutionContextLoad(IServiceProvider)

Called by the workflow runtime engine every time the ActivityExecutionContext for this activity is loaded.(Inherited from CompositeActivity.)

System_CAPS_protmethodOnActivityExecutionContextUnload(IServiceProvider)

Called by the workflow runtime engine every time the ActivityExecutionContext for this activity is unloaded.(Inherited from CompositeActivity.)

System_CAPS_protmethodOnWorkflowChangesCompleted(ActivityExecutionContext)

Called after changes have been made to the collection Activities of this instance.(Inherited from CompositeActivity.)

System_CAPS_protmethodRaiseEvent(DependencyProperty, Object, EventArgs)

Raises an Event associated with the specified dependency property.(Inherited from Activity.)

System_CAPS_protmethodRaiseGenericEvent<T>(DependencyProperty, Object, T)

Raises the event associated with the referenced DependencyProperty.(Inherited from Activity.)

System_CAPS_pubmethodRegisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)

Registers the specified DependencyProperty for the status change event.(Inherited from Activity.)

System_CAPS_pubmethodRemoveHandler(DependencyProperty, Object)

Removes an EventHandler from an associated DependencyProperty.(Inherited from DependencyObject.)

System_CAPS_pubmethodRemoveProperty(DependencyProperty)

Removes a DependencyProperty from the DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodSave(Stream)

Writes the Activity to a Stream for persistence.(Inherited from Activity.)

System_CAPS_pubmethodSave(Stream, IFormatter)

Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization.(Inherited from Activity.)

System_CAPS_pubmethodSetBinding(DependencyProperty, ActivityBind)

Sets the ActivityBind for the specified DependencyProperty. (Inherited from DependencyObject.)

System_CAPS_protmethodSetReadOnlyPropertyValue(DependencyProperty, Object)

Sets the value of a DependencyProperty, which is read-only.(Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyProperty, Object)

Sets the value of the DependencyProperty to the object.(Inherited from DependencyObject.)

System_CAPS_pubmethodSetValueBase(DependencyProperty, Object)

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

System_CAPS_pubmethodToString()

Provides a string that represents this instance.(Inherited from Activity.)

System_CAPS_protmethodUninitialize(IServiceProvider)

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

System_CAPS_pubmethodUnregisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)

Un-registers the specified DependencyProperty for the status change event.(Inherited from Activity.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticChildCompletedEvent

Occurs when the child activity instance of the ReplicatorActivity has completed.

System_CAPS_pubfieldSystem_CAPS_staticChildInitializedEvent

Occurs when the child activity instance of the ReplicatorActivity has initialized.

System_CAPS_pubfieldSystem_CAPS_staticCompletedEvent

Occurs when the ReplicatorActivity has completed.

System_CAPS_pubfieldSystem_CAPS_staticExecutionTypeProperty

Represents the DependencyProperty that targets the ExecutionType property.

System_CAPS_pubfieldSystem_CAPS_staticInitialChildDataProperty

Represents the DependencyProperty that targets the InitialChildData property.

System_CAPS_pubfieldSystem_CAPS_staticInitializedEvent

Represents the DependencyProperty that targets the Initialized event.

System_CAPS_pubfieldSystem_CAPS_staticUntilConditionProperty

Represents the DependencyProperty that targets the UntilCondition property.

NameDescription
System_CAPS_pubeventCanceling

Occurs when the activity execution is canceled. (Inherited from Activity.)

System_CAPS_pubeventChildCompleted

Occurs immediately after the ReplicatorActivity finishes running a child activity instance.

System_CAPS_pubeventChildInitialized

Occurs immediately after a child activity is initialized.

System_CAPS_pubeventClosed

Occurs when an Activity has completed execution.(Inherited from Activity.)

System_CAPS_pubeventCompensating

Occurs when running a compensation method on the Activity.(Inherited from Activity.)

System_CAPS_pubeventCompleted

Occurs when the ReplicatorActivity completes.

System_CAPS_pubeventExecuting

Occurs when the Activity is run.(Inherited from Activity.)

System_CAPS_pubeventFaulting

Occurs when an exception is raised during the running of the instance.(Inherited from Activity.)

System_CAPS_pubeventInitialized

Occurs when the ReplicatorActivity begins to execute.

System_CAPS_pubeventStatusChanged

Occurs when the ActivityExecutionStatus of a running Activity changes.(Inherited from Activity.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_priveventIComponent.Disposed

Represents the method that handles the Disposed event of a component.(Inherited from DependencyObject.)

System_CAPS_noteNote

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

The ReplicatorActivity is similar to a for each statement in code. If you are presented with a task in which you repeat the same function on many different entities, ReplicatorActivity may be a better solution than WhileActivity.

By default, a ReplicatorActivity is completed when all child instances have completed. You can override this behavior with a custom condition to use when the activity finishes. If this condition evaluates to true before all child instances have completed, then any running incomplete child instances are canceled.

The following code example shows how to create a new instance of the ReplicatorActivity class and define a handler for the Initialized event. This code example is part of the Replicator SDK Sample from the SimpleReplicatorWorkflow.Designer.cs file. For more information, seeUsing Replicator.

workflowRuntime.ServicesExceptionNotHandled += OnExceptionNotHandled;

.NET Framework
Available since 3.0

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

Return to top
Show: