CorrelationParameterAttribute Class (System.Workflow.Activities)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
CorrelationParameterAttribute Class

Indicates the name of the parameter used for correlation in the methods and events defined on an ExternalDataExchange interface. This class cannot be inherited.

Inheritance Hierarchy
System.Object
  System.Attribute
    System.Workflow.Activities.CorrelationParameterAttribute

Namespace:  System.Workflow.Activities
Assembly:  System.Workflow.Activities (in System.Workflow.Activities.dll)
Syntax
Visual Basic
<AttributeUsageAttribute(AttributeTargets.Interface, AllowMultiple := True)> _
Public NotInheritable Class CorrelationParameterAttribute _
	Inherits Attribute
C#
[AttributeUsageAttribute(AttributeTargets.Interface, AllowMultiple = true)]
public sealed class CorrelationParameterAttribute : Attribute
Visual C++
[AttributeUsageAttribute(AttributeTargets::Interface, AllowMultiple = true)]
public ref class CorrelationParameterAttribute sealed : public Attribute
F#
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Interface, AllowMultiple = true)>]
type CorrelationParameterAttribute =  
    class
        inherit Attribute
    end

The CorrelationParameterAttribute type exposes the following members.

Constructors
  Name Description
Public method CorrelationParameterAttribute Initializes a new instance of the CorrelationParameterAttribute where the name of the parameter is used for correlation.
Top
Properties
  Name Description
Public property Name Gets the name of the parameter used for correlation.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
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 Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
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
Explicit Interface Implementations
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

Default setting; can be overridden by the CorrelationAliasAttribute.

Examples

The following code example demonstrates how to use a CorrelationParameterAttribute for an EnternalDataExchange interface. This code example is from the CorrelatedLocalService SDK sample. For more information, see Correlated Local Service Sample.

C#

[ExternalDataExchange]
[CorrelationParameter("taskId")]
public interface ITaskService
{
    [CorrelationInitializer]
    void CreateTask(string taskId, string assignee, string text);

    [CorrelationAlias("taskId", "e.Id")]
    event EventHandler<TaskEventArgs> TaskCompleted;
}
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

System.Workflow.Activities Namespace