CorrelationScope Class

.NET Framework (current version)

The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Provides implicit CorrelationHandle management for child messaging activities.

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


public class CorrelationScope : NativeActivity


Initializes a new instance of the CorrelationScope class.


Gets or sets the activity’s execution logic.


Gets the identifier of the cache that is unique within the scope of the workflow definition.(Inherited from Activity.)


Gets or sets a value that indicates whether the activity can cause the workflow to become idle.(Inherited from NativeActivity.)


Gets a collection of Constraint activities that can be configured to provide validation for the Activity.(Inherited from Activity.)


Gets or sets the CorrelationHandle used by the child messaging activities.


Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking.(Inherited from Activity.)


Gets an identifier that is unique in the scope of the workflow definition.(Inherited from Activity.)


The execution logic of the activity.(Inherited from NativeActivity.)


Gets or sets the implementation version of the activity.(Inherited from NativeActivity.)


When implemented in a derived class, takes actions in response to the activity being aborted.(Inherited from NativeActivity.)


Not implemented. Use the CacheMetadata method instead.(Inherited from NativeActivity.)


Builds and validates a description of the activity’s arguments, variables, child activities, and activity delegates.(Overrides NativeActivity.CacheMetadata(NativeActivityMetadata).)


When implemented in a derived class, runs logic to cause graceful early completion of the activity.(Inherited from NativeActivity.)


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


Called by the workflow runtime to execute the CorrelationScope activity.(Overrides NativeActivity.Execute(NativeActivityContext).)


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


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


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

System_CAPS_protmethodOnCreateDynamicUpdateMap(NativeActivityUpdateMapMetadata, Activity)

Raises an event when creating a map for the dynamic update.(Inherited from NativeActivity.)

System_CAPS_protmethodOnCreateDynamicUpdateMap(UpdateMapMetadata, Activity)

Raises an event when creating a map for the dynamic update.(Inherited from NativeActivity.)


Indicates whether the CorrelatesWith property should be serialized.


Indicates whether the DisplayName property should be serialized.(Inherited from Activity.)


Returns a String that contains the Id and DisplayName of the Activity.(Inherited from Activity.)


Updates the instance of NativeActivity.(Inherited from NativeActivity.)

The CorrelationScope activity maintains an implicit CorrelationHandle that is only visible to child activities. When the CorrelatesWith property is set by the user, it will be used as the CorrelationScope implicit handle. In the case of nested CorrelationScope, children of the inner scope cannot access implicit handle of the outer scope.

The following example shows how to create a CorrelationScope. This example creates a T:System.ServiceModel.Activities.Sequence and adds a CorrelationScope (among other activites). The CorrelationScope contains a T:System.ServiceModel.Activities.Sequence that is composed of a Send and ReceiveReply activity.

return new Sequence
    Variables = { po, customer },
    Activities =
        new Assign<PurchaseOrder> 
            To = po,
            Value = new InArgument<PurchaseOrder>( (e) => new PurchaseOrder() { PartName = "Widget", Quantity = 150 } )
        new Assign<Customer>
            To = customer,
            Value = new InArgument<Customer>( (e) => new Customer() { Id = 12345678, Name = "John Smith" } )
        new WriteLine { Text = new InArgument<string>( (e) => string.Format("Submitting new PurchaseOrder for {0} {1}s", po.Get(e).Quantity, po.Get(e).PartName) ) },
        new CorrelationScope
            Body = new Sequence
                Activities = 
                    new ReceiveReply
                        Request = submitPO,
                        Content = ReceiveContent.Create(new OutArgument<int>( (e) => po.Get(e).Id ))
        new WriteLine { Text = new InArgument<string>( (e) => string.Format("Received ID for new PO: {0}", po.Get(e).Id) ) },
        new Assign<int> { To = new OutArgument<int>( (e) => po.Get(e).Quantity ), Value = 250 },
        new WriteLine { Text = "Updated PO with new quantity: 250.  Resubmitting updated PurchaseOrder based on POId." },
        new Send
            Endpoint = clientEndpoint,
            ServiceContractName = Constants.POContractName,
            OperationName = Constants.UpdatePOName,
            Content = SendContent.Create(new InArgument<PurchaseOrder>(po))
        new Assign<int> 
            To = new OutArgument<int>( (e) => po.Get(e).CustomerId ), 
            Value = new InArgument<int>( (e) => customer.Get(e).Id )
        new WriteLine { Text = "Updating customer data based on CustomerId." },
        new Send
            Endpoint = clientEndpoint,
            ServiceContractName = Constants.POContractName,
            OperationName = Constants.AddCustomerInfoName,
            Content = SendContent.Create(new InArgument<PurchaseOrder>(po))
        new Send
            Endpoint = clientEndpoint,
            ServiceContractName = Constants.POContractName,
            OperationName = Constants.UpdateCustomerName,
            Content = SendContent.Create(new InArgument<Customer>(customer))
        new WriteLine { Text = "Client completed." }

.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