CorrelationScope Class

Provides implicit CorrelationHandle management for child messaging activities.

System.Object
  System.Activities.Activity
    System.Activities.NativeActivity
      System.ServiceModel.Activities.CorrelationScope

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

public class CorrelationScope : NativeActivity

The CorrelationScope type exposes the following members.

  NameDescription
Public methodCorrelationScopeInitializes a new instance of the CorrelationScope class.
Top

  NameDescription
Public propertyBodyGets or sets the activity’s execution logic.
Protected propertyCacheIdGets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
Protected propertyCanInduceIdleGets or sets a value that indicates whether the activity can cause the workflow to become idle. (Inherited from NativeActivity.)
Protected propertyConstraintsGets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity.)
Public propertyCorrelatesWithGets or sets the CorrelationHandle used by the child messaging activities.
Public propertyDisplayNameGets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
Public propertyIdGets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
Protected propertyImplementationThe execution logic of the activity. (Inherited from NativeActivity.)
Protected propertyImplementationVersionGets or sets the implementation version of the activity. (Inherited from NativeActivity.)
Top

  NameDescription
Protected methodAbortWhen implemented in a derived class, takes actions in response to the activity being aborted. (Inherited from NativeActivity.)
Protected methodCacheMetadata(ActivityMetadata)Not implemented. Use the CacheMetadata method instead. (Inherited from NativeActivity.)
Protected methodCacheMetadata(NativeActivityMetadata)Builds and validates a description of the activity’s arguments, variables, child activities, and activity delegates. (Overrides NativeActivity.CacheMetadata(NativeActivityMetadata).)
Protected methodCancelWhen implemented in a derived class, runs logic to cause graceful early completion of the activity. (Inherited from NativeActivity.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodExecuteCalled by the workflow runtime to execute the CorrelationScope activity. (Overrides NativeActivity.Execute(NativeActivityContext).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnCreateDynamicUpdateMap(NativeActivityUpdateMapMetadata, Activity)Raises an event when creating a map for the dynamic update. (Inherited from NativeActivity.)
Protected methodOnCreateDynamicUpdateMap(UpdateMapMetadata, Activity)Raises an event when creating a map for the dynamic update. (Inherited from NativeActivity.)
Public methodShouldSerializeCorrelatesWithIndicates whether the CorrelatesWith property should be serialized.
Public methodShouldSerializeDisplayNameIndicates whether the DisplayName property should be serialized. (Inherited from Activity.)
Public methodToStringReturns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)
Protected methodUpdateInstanceUpdates the instance of NativeActivity. (Inherited from NativeActivity.)
Top

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 Sequence and adds a CorrelationScope (among other activites). The CorrelationScope contains a 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 = 
                {
                    submitPO,
                    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

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft