HandleExternalEventActivity.CorrelationToken HandleExternalEventActivity.CorrelationToken HandleExternalEventActivity.CorrelationToken HandleExternalEventActivity.CorrelationToken Property

Definition

Gets or sets the binding to a CorrelationToken.

public:
 virtual property System::Workflow::Runtime::CorrelationToken ^ CorrelationToken { System::Workflow::Runtime::CorrelationToken ^ get(); void set(System::Workflow::Runtime::CorrelationToken ^ value); };
[System.ComponentModel.TypeConverter(typeof(System.Workflow.Activities.CorrelationTokenTypeConverter))]
public virtual System.Workflow.Runtime.CorrelationToken CorrelationToken { get; set; }
member this.CorrelationToken : System.Workflow.Runtime.CorrelationToken with get, set
Public Overridable Property CorrelationToken As CorrelationToken

Property Value

This property is used to correlate an event to the correct IEventActivity-inherited activity based on the payload of the event. For example, when a single workflow instance is listening for multiple instances of the same event at the same time, the CorrelationToken property is used to route the event to the proper activity in that workflow instance.

This correlation should not be confused with correlating an event to the correct workflow instance. The correlation to the correct workflow instance is done by sending the event to an explicit workflow instance and using the InstanceId property to properly identify the correct workflow instance.

For an example of correlation, see the Correlated Local Service Sample.

Examples

The following example shows how to access the CorrelationToken property of a HandleExternalEventActivity. This example is from the Correlated Local Service SDK sample, from the CorrelatedLocalServiceWorkflow.designer.cs file. For more information, see Correlated Local Service Sample.

this.taskCompleted2.CorrelationToken = correlationtoken1;
Me.taskCompleted2.CorrelationToken = correlationtoken1

Applies to

See also