WhileActivity Class

Definition

Namespace:

System.Workflow.Activities

Assembly:

System.Workflow.Activities.dll

Caution

The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*

Runs a child activity iteratively as long as a certain condition is true.

public ref class WhileActivity sealed : System::Workflow::ComponentModel::CompositeActivity, System::Workflow::ComponentModel::IActivityEventListener<System::Workflow::ComponentModel::ActivityExecutionStatusChangedEventArgs ^>

[System.Drawing.ToolboxBitmap(typeof(System.Workflow.Activities.WhileActivity), "Resources.While.png")]
[System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.Activities.WhileValidator))]
[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public sealed class WhileActivity : System.Workflow.ComponentModel.CompositeActivity, System.Workflow.ComponentModel.IActivityEventListener<System.Workflow.ComponentModel.ActivityExecutionStatusChangedEventArgs>

[<System.Drawing.ToolboxBitmap(typeof(System.Workflow.Activities.WhileActivity), "Resources.While.png")>]
[<System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.Activities.WhileValidator))>]
[<System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type WhileActivity = class
    inherit CompositeActivity
    interface IActivityEventListener<ActivityExecutionStatusChangedEventArgs>

Public NotInheritable Class WhileActivity
Inherits CompositeActivity
Implements IActivityEventListener(Of ActivityExecutionStatusChangedEventArgs)

Inheritance

Object

DependencyObject

Activity

CompositeActivity

WhileActivity

Attributes

ToolboxBitmapAttribute ActivityValidatorAttribute ObsoleteAttribute

Implements

IActivityEventListener<ActivityExecutionStatusChangedEventArgs>

Examples

The following code example demonstrates how to create a new instance of the WhileActivity class and add the ParallelActivity class to the WhileActivity class. This code example is part of the WhileAndParallel SDK Sample from the WhileAndParallelWorkflow.Designer.cs file. For more information, see Using While and Parallel.

workflowRuntime.WorkflowUnloaded += OnWorkflowUnload;

AddHandler currentWorkflowRuntime.WorkflowUnloaded, AddressOf OnWorkflowUnloaded

Remarks

Note

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

The WhileActivity is a CompositeActivity, meaning the WhileActivity can contain other activities.

Before each iteration, the Condition property is evaluated. If the Condition property evaluates to false, the WhileActivity immediately finishes.

Constructors

WhileActivity()	Initializes a new instance of the WhileActivity class.
WhileActivity(String)	Initializes a new instance of the WhileActivity class using the name of the activity.

Fields

ConditionProperty

Represents the DependencyProperty that targets the Condition property.

Properties

Activities	Gets the object representing the collection, ActivityCollection, of all child activities. (Inherited from CompositeActivity)
CanModifyActivities	Gets or sets a value which controls whether the individual activities within Activities can be modified. (Inherited from CompositeActivity)
Condition	Gets or sets a condition that determines whether the WhileActivity should run or finish.
Description	Gets or sets the user-defined description of the Activity. (Inherited from Activity)
DesignMode	Gets the value that indicates whether this instance is in design or run-time mode. (Inherited from DependencyObject)
DynamicActivity	Gets the dynamic child activities in the WhileActivity.
Enabled	Gets or sets a value that indicates whether this instance is enabled for execution and validation. (Inherited from Activity)
EnabledActivities	Gets the read-only collection that represents the subset of Activities that are enabled. (Inherited from CompositeActivity)
ExecutionResult	Gets the ActivityExecutionResult of the last attempt to run this instance. (Inherited from Activity)
ExecutionStatus	Gets the current ActivityExecutionStatus of this instance. (Inherited from Activity)
IsDynamicActivity	Gets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance. (Inherited from Activity)
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	Gets the CompositeActivity that contains this Activity. (Inherited from Activity)
ParentDependencyObject	Gets the parent DependencyObject in the DependencyObject graph. (Inherited from DependencyObject)
QualifiedName	Gets the qualified name of the activity. Qualified activity names are always unique in a workflow instance. (Inherited from Activity)
Site	Gets or sets a reference to the Site component of the DependencyObject. (Inherited from DependencyObject)
UserData	Gets an IDictionary that associates custom data with this class instance. (Inherited from DependencyObject)
WorkflowInstanceId	Gets the Guid associated with the instance. (Inherited from Activity)

Methods

AddHandler(DependencyProperty, Object)	Adds a handler for an event of a DependencyObject. (Inherited from DependencyObject)
ApplyWorkflowChanges(WorkflowChanges)	Applies the WorkflowChanges manifest in the parameter to this instance. (Inherited from CompositeActivity)
Cancel(ActivityExecutionContext)	Called by the workflow runtime to cancel execution of an activity that is currently executing. (Inherited from Activity)
Clone()	Creates a deep copy of the Activity. (Inherited from Activity)
Dispose()	Releases all the resources used by the DependencyObject. (Inherited from DependencyObject)
Dispose(Boolean)	Calls Dispose(Boolean) on this instance, and optionally calls Dispose() on all child activities of this instance. (Inherited from CompositeActivity)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Execute(ActivityExecutionContext)	Called by the workflow runtime to execute an activity. (Inherited from Activity)
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)
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)
GetBinding(DependencyProperty)	Provides access to the ActivityBind associated with the specific DependencyProperty. (Inherited from DependencyObject)
GetBoundValue(ActivityBind, Type)	Retrieves the Object that is the subject of an ActivityBind. (Inherited from DependencyObject)
GetDynamicActivities(Activity)	Returns an array that contains all of the currently executing instances of the specified activity. (Inherited from CompositeActivity)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetInvocationList<T>(DependencyProperty)	Gets an array that contains the delegates for the specified DependencyProperty. (Inherited from DependencyObject)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(DependencyProperty)	Provides access to the value of the designated DependencyProperty. (Inherited from DependencyObject)
GetValueBase(DependencyProperty)	Provides access to the bound object of a DependencyProperty and bypasses the GetValue(DependencyProperty) override. (Inherited from DependencyObject)
HandleFault(ActivityExecutionContext, Exception)	Called when an exception is raised within the context of the execution of this instance. (Inherited from CompositeActivity)
Initialize(IServiceProvider)	Initializes all appropriate child activities of this instance and the specified IServiceProvider. (Inherited from CompositeActivity)
InitializeProperties()	Performs initialization on dependency properties when overridden in a derived class. (Inherited from DependencyObject)
Invoke<T>(EventHandler<T>, T)	Subscribes an EventHandler and invokes that delegate. (Inherited from Activity)
Invoke<T>(IActivityEventListener<T>, T)	Subscribes an IActivityEventListener<T> and invokes that delegate. (Inherited from Activity)
IsBindingSet(DependencyProperty)	Indicates whether the value of a DependencyProperty is set as a binding. See SetBinding(DependencyProperty, ActivityBind). (Inherited from DependencyObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MetaEquals(DependencyObject)	Determines whether the metaproperties of this DependencyObject equals the metaproperties of the parameterized DependencyObject. (Inherited from DependencyObject)
OnActivityChangeAdd(ActivityExecutionContext, Activity)	Calls when an activity is added. (Inherited from CompositeActivity)
OnActivityChangeRemove(ActivityExecutionContext, Activity)	Called when an activity is removed. (Inherited from CompositeActivity)
OnActivityExecutionContextLoad(IServiceProvider)	Called by the workflow runtime engine every time the ActivityExecutionContext for this activity is loaded. (Inherited from CompositeActivity)
OnActivityExecutionContextUnload(IServiceProvider)	Called by the workflow runtime engine every time the ActivityExecutionContext for this activity is unloaded. (Inherited from CompositeActivity)
OnClosed(IServiceProvider)	Called by the workflow runtime as part of the activity's transition to the closed state. (Inherited from Activity)
OnListChanged(ActivityCollectionChangeEventArgs)	Performs additional processing when the Activities property changes. (Inherited from CompositeActivity)
OnListChanging(ActivityCollectionChangeEventArgs)	Event that occurs before a change being made to the underlying Activities. (Inherited from CompositeActivity)
OnWorkflowChangesCompleted(ActivityExecutionContext)	Called after changes have been made to the collection Activities of this instance. (Inherited from CompositeActivity)
RaiseEvent(DependencyProperty, Object, EventArgs)	Raises an Event associated with the specified dependency property. (Inherited from Activity)
RaiseGenericEvent<T>(DependencyProperty, Object, T)	Raises the event associated with the referenced DependencyProperty. (Inherited from Activity)
RegisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)	Registers the specified DependencyProperty for the status change event. (Inherited from Activity)
RemoveHandler(DependencyProperty, Object)	Removes an EventHandler from an associated DependencyProperty. (Inherited from DependencyObject)
RemoveProperty(DependencyProperty)	Removes a DependencyProperty from the DependencyObject. (Inherited from DependencyObject)
Save(Stream, IFormatter)	Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization. (Inherited from Activity)
Save(Stream)	Writes the Activity to a Stream for persistence. (Inherited from Activity)
SetBinding(DependencyProperty, ActivityBind)	Sets the ActivityBind for the specified DependencyProperty. (Inherited from DependencyObject)
SetBoundValue(ActivityBind, Object)	Sets the value of the target ActivityBind. (Inherited from DependencyObject)
SetReadOnlyPropertyValue(DependencyProperty, Object)	Sets the value of a DependencyProperty, which is read-only. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the value of the DependencyProperty to the object. (Inherited from DependencyObject)
SetValueBase(DependencyProperty, Object)	Sets the value of the DependencyProperty to the specified Object, bypassing the SetValue(DependencyProperty, Object). (Inherited from DependencyObject)
ToString()	Provides a string that represents this instance. (Inherited from Activity)
TrackData(Object)	Informs the run-time tracking infrastructure of pending tracking information. (Inherited from Activity)
TrackData(String, Object)	Informs the run-time tracking infrastructure of pending tracking information. (Inherited from Activity)
Uninitialize(IServiceProvider)	Called by the workflow runtime engine when an activity transitions into the Closed state from the Initialized state. (Inherited from CompositeActivity)
UnregisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)	Un-registers the specified DependencyProperty for the status change event. (Inherited from Activity)

Events

Canceling	Occurs when the activity execution is canceled. (Inherited from Activity)
Closed	Occurs when an Activity has completed execution. (Inherited from Activity)
Compensating	Occurs when running a compensation method on the Activity. (Inherited from Activity)
Executing	Occurs when the Activity is run. (Inherited from Activity)
Faulting	Occurs when an exception is raised during the running of the instance. (Inherited from Activity)
StatusChanged	Occurs when the ActivityExecutionStatus of a running Activity changes. (Inherited from Activity)

Explicit Interface Implementations

IActivityEventListener<ActivityExecutionStatusChangedEventArgs>.OnEvent(Object, ActivityExecutionStatusChangedEventArgs)	Defines the processing procedure when the subscribed-to event occurs.
IComponent.Disposed	Represents the method that handles the Disposed event of a component. (Inherited from DependencyObject)

See also

• Using the While Activity
• Using Conditions in Workflows