CorrelationParameterAttribute Class

Reference

Definition

Namespace:: System.Workflow.Activities

Assembly:: System.Workflow.Activities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

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

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

public ref class CorrelationParameterAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Interface, AllowMultiple=true)]
public sealed class CorrelationParameterAttribute : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Interface, AllowMultiple=true)>]
type CorrelationParameterAttribute = class
    inherit Attribute

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

Public NotInheritable Class CorrelationParameterAttribute
Inherits Attribute

Inheritance: Object

Attribute
CorrelationParameterAttribute

Attributes: AttributeUsageAttribute ObsoleteAttribute

Examples

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

[ExternalDataExchange]
[CorrelationParameter("taskId")]
public interface ITaskService
{
    [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.

Default setting; can be overridden by the CorrelationAliasAttribute.

Constructors

CorrelationParameterAttribute(String)

Initializes a new instance of the CorrelationParameterAttribute where the name of the parameter is used for correlation.

Properties

Name	Gets the name of the parameter used for correlation.
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)

Applies to

Jaa