ExternalDataEventArgs Class

Definition

Caution

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

Represents the data sent when an event is raised using the HandleExternalEventActivity activity.

C#
[System.Serializable]
public class ExternalDataEventArgs : EventArgs
C#
[System.Serializable]
[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public class ExternalDataEventArgs : EventArgs
Inheritance
ExternalDataEventArgs
Attributes

Examples

An event class that inherits from ExternalDataEventArgs must implement a constructor that uses the :base(instanceId) constructor. In addition, the new event class must be marked as Serializable as shown in the following code.

C#
[Serializable]  
public class TaskEventArgs : ExternalDataEventArgs  
{  
    private string orderName;  

    public TaskEventArgs(Guid instanceId, string id)  
        :base(instanceId)  
    {  
        orderName = id;  
    }  

    public string Id  
    {  
        get { return orderName; }  
        set { orderName = value; }  
    }  
}  

Remarks

Note

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

A local communication interface marked with ExternalDataExchangeAttribute must declare a type that derives from ExternalDataEventArgs in the interface definition for the corresponding event to be handled in a workflow with a HandleExternalEventActivity activity.

Constructors

ExternalDataEventArgs()

Initializes a new instance of the ExternalDataEventArgs class.

ExternalDataEventArgs(Guid, IPendingWork, Object, Boolean)

Initializes a new instance of the ExternalDataEventArgs class.

ExternalDataEventArgs(Guid, IPendingWork, Object)

Initializes a new instance of the ExternalDataEventArgs class.

ExternalDataEventArgs(Guid)

Initializes a new instance of the ExternalDataEventArgs class using the instance identifier of the workflow.

Properties

Identity

Gets or sets the identity of the user that raised the event.

InstanceId

Gets or sets the workflow instance identifier for the workflow instance that contains the HandleExternalEventActivity that is expected to handle the event.

WaitForIdle

Gets or sets a value that indicates whether the event should be raised immediately, or if the workflow should go idle before raising the event.

WorkHandler

Gets or sets the IPendingWork to allow the external code, raising the event, to participate in the batch.

WorkItem

Gets or sets the object that contains the external code that raises the event.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

Product Versions (Obsolete)
.NET Framework 3.0, 3.5, 4.0 (4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1)