CorrelationAliasAttribute Class

Definition

Namespace:

System.Workflow.Activities

Assembly:

System.Workflow.Activities.dll

Caution

The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*

Overrides the correlation parameter value when the correlation value must be obtained from a parameter other than that indicated by the CorrelationParameterAttribute. This class cannot be inherited.

public ref class CorrelationAliasAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Delegate | System.AttributeTargets.Event | System.AttributeTargets.Method, AllowMultiple=true)]
[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public sealed class CorrelationAliasAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Delegate | System.AttributeTargets.Event | System.AttributeTargets.Method, AllowMultiple=true)>]
[<System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type CorrelationAliasAttribute = class
    inherit Attribute

Public NotInheritable Class CorrelationAliasAttribute
Inherits Attribute

Inheritance

Object

Attribute

CorrelationAliasAttribute

Attributes

AttributeUsageAttribute ObsoleteAttribute

Examples

The following code example shows how to use a CorrelationAliasAttribute to override a CorrelationParameterAttribute. This code example is from the CorrelatedLocalService SDK sample. For more information, see Correlated Local Service Sample.

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

    [CorrelationAlias("taskId", "e.Id")]
    event EventHandler<TaskEventArgs> TaskCompleted;
}

Remarks

Note

This material discusses types and namespaces that are obsolete. For more information, see Deprecated Types in Windows Workflow Foundation 4.5.

To match an incoming message with the appropriate workflow instance, the message and the workflow instance must share a key. This key is called a correlation set. Typically, the key can be a single-valued correlation set. This means that an ID field in the message can be matched against an ID of the same type that is held by schedule instances.

The CorrelationAliasAttribute is applied to a method or an event on an interface on a data exchange interface.

Constructors

CorrelationAliasAttribute(String, String)

Initializes a new instance of the CorrelationAliasAttribute with the name of the correlation that is being aliased and the path to where the value can be found.

Properties

Name	Gets the name of the correlation parameter that is being aliased.
Path	Gets the path within the parameter that specifies the location of the correlation value.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
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)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)