CorrelationProperty Class (System.Workflow.Runtime)

Switch View :
ScriptFree
.NET Framework Class Library
CorrelationProperty Class

Represents a name and value pair used to correlate messages to specific receiving activities.

Inheritance Hierarchy

System.Object
  System.Workflow.Runtime.CorrelationProperty

Namespace:  System.Workflow.Runtime
Assembly:  System.Workflow.Runtime (in System.Workflow.Runtime.dll)
Syntax

Visual Basic
<SerializableAttribute> _
Public Class CorrelationProperty
C#
[SerializableAttribute]
public class CorrelationProperty
Visual C++
[SerializableAttribute]
public ref class CorrelationProperty
F#
[<SerializableAttribute>]
type CorrelationProperty =  class end

The CorrelationProperty type exposes the following members.

Constructors

  Name Description
Public method CorrelationProperty Initializes a new instance of the CorrelationProperty class.
Top
Properties

  Name Description
Public property Name Gets the name of the property used in the correlation set.
Public property Value Gets the value of the correlation set property.
Top
Methods

  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

CorrelationProperty classes are defined as ActivityBind properties of Workflow Connection Service activities. By default, these properties are bound to variables declared at the root workflow activity. For dynamic activities such as ReplicatorActivity and ConditionedActivityGroup each of its children cannot share a universal CorrelationProperty object. Consider the scenario where each task inside a ReplicatorActivity has to manage its own conversation. The child activities inside the ReplicatorActivity requires a CorrelationProperty instance unique per execution context, or per task. In order to accomplish this, you have to define a custom activity that has a CorrelationProperty instance property and the Workflow Connection Services activities have to bind to this property.

Examples

The following example demonstrates creating a correlation property object, and accessing the Name and Value properties.

Visual Basic

' Create a new Correlation Property object
Dim correlationProperty As New CorrelationProperty("taskName", "reportBalance")
' Read the property name
Dim taskName As String = correlationProperty.Name
' Read the property value
Dim taskValue As Object = correlationProperty.Value


C#

// Create a new Correlation Property object
CorrelationProperty correlationProperty = new CorrelationProperty("taskName", "reportBalance");
// Read the property name
String taskName = correlationProperty.Name;
// Read the property value
Object taskValue = correlationProperty.Value;


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety

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

Reference