DelayActivity 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.*

Provides the logic to establish a timer and to wait, asynchronously, for timer's expiration. This class cannot be inherited.

public ref class DelayActivity sealed : System::Workflow::ComponentModel::Activity, System::Workflow::Activities::IEventActivity, System::Workflow::ComponentModel::IActivityEventListener<System::Workflow::ComponentModel::QueueEventArgs ^>

[System.Drawing.ToolboxBitmap(typeof(System.Workflow.Activities.DelayActivity), "Resources.Delay.png")]
[System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.Activities.DelayActivity+DelayActivityValidator))]
[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public sealed class DelayActivity : System.Workflow.ComponentModel.Activity, System.Workflow.Activities.IEventActivity, System.Workflow.ComponentModel.IActivityEventListener<System.Workflow.ComponentModel.QueueEventArgs>

[<System.Drawing.ToolboxBitmap(typeof(System.Workflow.Activities.DelayActivity), "Resources.Delay.png")>]
[<System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.Activities.DelayActivity+DelayActivityValidator))>]
[<System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type DelayActivity = class
    inherit Activity
    interface IEventActivity
    interface IActivityEventListener<QueueEventArgs>

Public NotInheritable Class DelayActivity
Inherits Activity
Implements IActivityEventListener(Of QueueEventArgs), IEventActivity

Inheritance

Object

DependencyObject

Activity

DelayActivity

Attributes

ToolboxBitmapAttribute ActivityValidatorAttribute ObsoleteAttribute

Implements

IEventActivity IActivityEventListener<QueueEventArgs>

Examples

The following code example demonstrates how to create a new instance of the DelayActivity class. This code example is part of the SimpleStateMachineWorkflow SDK Sample from the StateMachineWorkflow.cs file. For more information, see Simple State Machine.

this.StartState = new System.Workflow.Activities.StateActivity();

Me.StartState = New System.Workflow.Activities.StateActivity()

Remarks

Note

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

When notified that its timer has expired, a DelayActivity completes its execution.

You can set a time out on the DelayActivity so that your workflow pauses before resuming execution. You specify the TimeoutDuration using TimeSpan. This causes your workflow to pause until the specified TimeSpan has elapsed.

The DelayActivity class runs the code method associated with the InitializeTimeoutDuration event before the activity starts and the code-beside method can be used to initialize the TimeoutDuration property.

The DelayActivity is guaranteed to complete no sooner than the indicated TimeoutDuration. The delay can take longer because the timer notification might occur some time after the TimeoutDuration is reached. One reason for a longer delay is if the workflow is running under high system stress in a server environment.

Constructors

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

Fields

InitializeTimeoutDurationEvent	Represents the DependencyProperty that targets the InitializeTimeoutDuration event.
TimeoutDurationProperty	Represents the DependencyProperty that targets the TimeoutDuration property.

Properties

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)
Enabled	Gets or sets a value that indicates whether this instance is enabled for execution and validation. (Inherited from Activity)
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)
TimeoutDuration	Gets or sets the duration of the delay in the workflow.
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)
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)	Releases the unmanaged resources and optionally releases the managed resources used by DependencyObject. (Inherited from DependencyObject)
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)
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 Activity)
Initialize(IServiceProvider)	Called by the workflow runtime to initialize an activity during the construction of a new workflow instance. This method is called during the construction of a dynamic ActivityExecutionContext. (Inherited from Activity)
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)
OnActivityExecutionContextLoad(IServiceProvider)	Called by the workflow runtime whenever an ActivityExecutionContext is loaded. For example, this method is called during the creation of an ActivityExecutionContext as well as every time the ActivityExecutionContext is reincarnated when a workflow instance is loaded from persistent storage. (Inherited from Activity)
OnActivityExecutionContextUnload(IServiceProvider)	Called by the workflow runtime whenever an ActivityExecutionContext is unloaded. For example, this method is called during completion of an ActivityExecutionContext as well as every time the ActivityExecutionContext is unloaded when a workflow instance is persisted. (Inherited from Activity)
OnClosed(IServiceProvider)	Called by the workflow runtime as part of the activity's transition to the closed state. (Inherited from Activity)
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)	When overridden in a derived class, provides un-initialization by a service provider for the activity. (Inherited from Activity)
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)
InitializeTimeoutDuration	Occurs before the time-out duration starts.
StatusChanged	Occurs when the ActivityExecutionStatus of a running Activity changes. (Inherited from Activity)

Explicit Interface Implementations

IActivityEventListener<QueueEventArgs>.OnEvent(Object, QueueEventArgs)	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)
IEventActivity.QueueName	Gets the name of the workflow queue that will be delivered when the timer expires.
IEventActivity.Subscribe(ActivityExecutionContext, IActivityEventListener<QueueEventArgs>)	Creates the subscription of the DelayActivity to an event.
IEventActivity.Unsubscribe(ActivityExecutionContext, IActivityEventListener<QueueEventArgs>)	Cancels the subscription of the DelayActivity to an event.

See also

• Delay Sample