WorkflowInstance Class

.NET Framework (current version)
 

WorkflowInstance is a lightweight, per-instance runtime for executing a workflow program. It can be constructed to create a new workflow instance or from existing instance state. The APIs that WorkflowInstance.WorkflowInstanceControl exposes are the minimal set of runtime controls from which higher level operations can be implemented. This API set represents the entire breadth of functionality of the runtime. WorkflowInstance is an abstract class and relies on a host’s implementation of its abstract methods in order to provide host functionality such as synchronization, persistence, tracking, and extensions.

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

System.Object
  System.Activities.Hosting.WorkflowInstance
    System.Activities.WorkflowApplication

[<AbstractClass>]
type WorkflowInstance = class end

NameDescription
System_CAPS_protmethodWorkflowInstance(Activity)

Initializes a new instance of the WorkflowInstance class with the specified workflow definition.

System_CAPS_protmethodWorkflowInstance(Activity, WorkflowIdentity)

Initializes a new instance of the WorkflowInstance class with the specified workflow definition and definition identity.

NameDescription
System_CAPS_protpropertyController

Gets the WorkflowInstance.WorkflowInstanceControl instance for this WorkflowInstance.

System_CAPS_pubpropertyDefinitionIdentity

Gets or sets the definition identity of WorkflowInstance.

System_CAPS_pubpropertyHostEnvironment

Gets or sets the root environment for the workflow instance’s arguments and variables.

System_CAPS_pubpropertyId

Gets the unique identifier for the workflow instance.

System_CAPS_protpropertyIsReadOnly

Gets a value that indicates whether the workflow instance has been initialized.

System_CAPS_protpropertySupportsInstanceKeys

Gets a value that indicates whether the host supports the association of P:System.Runtime.Persistence.InstanceView.InstanceKeys with a run-time instance.

System_CAPS_pubpropertySynchronizationContext

Gets or sets the SynchronizationContext used for scheduling the workflow instance.

System_CAPS_pubpropertyWorkflowDefinition

Gets the workflow definition of the workflow instance.

NameDescription
System_CAPS_protmethodBeginFlushTrackingRecords(TimeSpan, AsyncCallback, Object)

Called by the workflow runtime to begin sending pending tracking records to tracking participants asynchronously.

System_CAPS_protmethodDisposeExtensions()

Calls M:System.Disposable.Dispose on all extensions that implement IDisposable.

System_CAPS_protmethodEndFlushTrackingRecords(IAsyncResult)

Called by the workflow runtime to end the track operation.

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodFlushTrackingRecords(TimeSpan)

Called by the workflow runtime to send pending tracking records to tracking participants.

System_CAPS_protmethodSystem_CAPS_staticGetActivitiesBlockingUpdate(Object, DynamicUpdateMap)

Retrieves the list of activity that is blocking the update of the workflow.

System_CAPS_protmethodGetExtension<'T>()

Returns an extension of the specified type.

System_CAPS_protmethodGetExtensions<'T>()

Returns all extensions found for the specified type.

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_protmethodInitialize(IDictionary<String, Object>, IList<Handle>)

Called by the host to initialize the workflow instance with the argument values and execution properties.

System_CAPS_protmethodInitialize(Object)

Called by the host to initialize the workflow instance with the workflow run-time state.

System_CAPS_protmethodInitialize(Object, DynamicUpdateMap)

Called by the host to initialize the workflow instance with the workflow run-time state and update map.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnBeginAssociateKeys(ICollection<InstanceKey>, AsyncCallback, Object)

Called by the workflow runtime to notify the host that new instance keys should be associated with this instance.

System_CAPS_protmethodOnBeginFlushTrackingRecords(AsyncCallback, Object)

Asynchronous call to ask host to flush pending tracking records to tracking participants.

System_CAPS_protmethodOnBeginPersist(AsyncCallback, Object)

Asynchronous call to ask the host to persist the workflow.

System_CAPS_protmethodOnBeginResumeBookmark(Bookmark, Object, TimeSpan, AsyncCallback, Object)

Called by the workflow runtime to notify the host that a resume bookmark operation is beginning.

System_CAPS_protmethodOnDisassociateKeys(ICollection<InstanceKey>)

Called by the workflow runtime to notify the host that a certain set of instance keys should no longer be associated with this instance.

System_CAPS_protmethodOnEndAssociateKeys(IAsyncResult)

Called by the workflow runtime to notify the host that an associate keys operation is complete.

System_CAPS_protmethodOnEndFlushTrackingRecords(IAsyncResult)

Called by the workflow runtime to notify the host when the flush tracking records operation is complete.

System_CAPS_protmethodOnEndPersist(IAsyncResult)

Called by the workflow runtime to notify the host that a persist operation is complete.

System_CAPS_protmethodOnEndResumeBookmark(IAsyncResult)

Called by the workflow runtime to notify the host that a resume bookmark operation is complete.

System_CAPS_protmethodOnNotifyPaused()

Called by the workflow runtime to notify the host that the workflow instance has transitioned from the running state to the paused state.

System_CAPS_protmethodOnNotifyUnhandledException(Exception, Activity, String)

Called by the workflow runtime to notify the host an unhandled exception has occurred in the workflow instance.

System_CAPS_protmethodOnRequestAbort(Exception)

Called by the workflow runtime to notify the host that an abort operation has been requested for the workflow instance.

System_CAPS_protmethodRegisterExtensionManager(WorkflowInstanceExtensionManager)

Called by the host to register the specified extension manager, validate that all required extensions are present, and to initialize the collection of extensions to be used.

System_CAPS_protmethodThrowIfReadOnly()

Throws an InvalidOperationException if the workflow instance has been initialized, as determined by IsReadOnly.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

WorkflowInstance is single threaded and assumes that the host synchronizes all access to it. An attempt to call multiple APIs simultaneously will result in an InvalidOperationException being thrown.

Internally, a WorkflowInstance has two states: Running and Paused. The only way to cause the runtime to transition from paused to running is to call Run. All actions (except Pause) can only be taken while the runtime is Paused. The runtime will become spontaneously Paused in the following situations:

  • An error fatal to the runtime has occurred. The host will be signaled through OnRequestAbort (which does not signal a transition to Paused) and then notified through OnNotifyPaused.

  • An exception in the workflow was uncaught and escaped the root. The host will be notified through the OnNotifyUnhandledException method.

  • The scheduler has run out of work items and is now Idle. The host will be notified through the OnNotifyPaused method. Note that the scheduler could have run out of work items because the instance is idle or because the instance is complete. The State value of the Controller property can be used to differentiate between the two.

The host can request a change from Running to Paused by calling the RequestPause or PauseWhenPersistable methods of the WorkflowInstance.WorkflowInstanceControl instance returned by the Controller property. This request should not be considered to have a specific response meaning that the host should not attempt to correlate an OnNotify* or OnRequestAbort with a specific call to pause. In response to a pause request, the runtime may transition to Paused and call OnNotifyPaused while the scheduler still has pending work items. The State value of the Controller property can be used to determine whether the scheduler has no more work or was interrupted by a request to pause.

The RequestPause method of the WorkflowInstance.WorkflowInstanceControl instance returned by the Controller property is the only method which can be called while the WorkflowInstance is in the Running state. All other methods will throw an InvalidOperationException if called.Given the rules for how WorkflowInstance transitions from one state to another, the public notion of Running and Paused can be defined as follows:

  • Running – The state between a call to Run and the next WorkflowInstance.OnNotify*.

  • Paused – The state between the last WorkflowInstance.OnNotify* and the next call to Run.

.NET Framework
Available since 4.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: