HandleExternalEventActivity 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.*

Defines a workflow communication activity that is used to handle an event that is raised by a local service.

public ref class HandleExternalEventActivity : System::Workflow::ComponentModel::Activity, System::Workflow::Activities::IEventActivity, System::Workflow::ComponentModel::IActivityEventListener<System::Workflow::ComponentModel::QueueEventArgs ^>, System::Workflow::ComponentModel::IDynamicPropertyTypeProvider

[System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.Activities.HandleExternalEventActivityValidator))]
public class HandleExternalEventActivity : System.Workflow.ComponentModel.Activity, System.Workflow.Activities.IEventActivity, System.Workflow.ComponentModel.IActivityEventListener<System.Workflow.ComponentModel.QueueEventArgs>, System.Workflow.ComponentModel.IDynamicPropertyTypeProvider

[System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.Activities.HandleExternalEventActivityValidator))]
[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public class HandleExternalEventActivity : System.Workflow.ComponentModel.Activity, System.Workflow.Activities.IEventActivity, System.Workflow.ComponentModel.IActivityEventListener<System.Workflow.ComponentModel.QueueEventArgs>, System.Workflow.ComponentModel.IDynamicPropertyTypeProvider

[<System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.Activities.HandleExternalEventActivityValidator))>]
type HandleExternalEventActivity = class
    inherit Activity
    interface IEventActivity
    interface IActivityEventListener<QueueEventArgs>
    interface IDynamicPropertyTypeProvider

[<System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.Activities.HandleExternalEventActivityValidator))>]
[<System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type HandleExternalEventActivity = class
    inherit Activity
    interface IEventActivity
    interface IActivityEventListener<QueueEventArgs>
    interface IDynamicPropertyTypeProvider

Public Class HandleExternalEventActivity
Inherits Activity
Implements IActivityEventListener(Of QueueEventArgs), IDynamicPropertyTypeProvider, IEventActivity

Inheritance: Object

DependencyObject

Activity
HandleExternalEventActivity

Attributes: ActivityValidatorAttribute ObsoleteAttribute

Implements: IEventActivity IActivityEventListener<QueueEventArgs> IDynamicPropertyTypeProvider

Examples

The following code example shows how to create and set values for the HandleExternalEventActivity class. This code example is part of the RaiseEventToLoadWorkflow SDK sample from the DocumentApprovalWorkflow.cs file. For more information, see Raise Event To Load Workflow.

this.Car.Name = "Car";
this.Car.ExecuteCode += new System.EventHandler(this.Car_ExecuteCode);
this.Car.SetValue(System.Workflow.Activities.ConditionedActivityGroup.WhenConditionProperty, codecondition1);
codecondition2.Condition += new System.EventHandler<System.Workflow.Activities.ConditionalEventArgs>(this.AirlineCondition);

Me.Car.Name = "Car"
AddHandler Car.ExecuteCode, AddressOf Me.Car_ExecuteCode
Me.Car.SetValue(System.Workflow.Activities.ConditionedActivityGroup.WhenConditionProperty, codecondition1)
AddHandler codecondition2.Condition, AddressOf Me.AirlineCondition

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 service is a class that implements a local service interface (an interface that is marked with ExternalDataExchangeAttribute) and is added to the ExternalDataExchangeService.

The HandleExternalEventActivity receives data when the ExternalDataExchangeService service raises an event with event data derived from ExternalDataEventArgs.

The HandleExternalEventActivity is a blocking activity.

Classes that derive from HandleExternalEventActivity should not implement the IActivityEventListener<T> interface because the derived class does not execute correctly.

Constructors

HandleExternalEventActivity()	Initializes a new instance of the HandleExternalEventActivity class.
HandleExternalEventActivity(String)	Initializes a new instance of the HandleExternalEventActivity class using the name of the activity.

Fields

CorrelationTokenProperty	Represents the DependencyProperty that targets the CorrelationToken property.
EventNameProperty	Corresponds to the name of an event that is defined in an interface that was marked with the ExternalDataExchangeAttribute.
InterfaceTypeProperty	Corresponds to the name of the interface that was marked with the ExternalDataExchangeAttribute.
InvokedEvent	Defines an event delegate that is executed after the activity receives the expected event from the local service.
ParameterBindingsProperty	Represents the DependencyProperty that targets the ParameterBindings property.
RolesProperty	Identifies the valid user roles that are allowed to send messages from the host to this activity. The two types of supported roles are Active Directory and ASP.NET.

Properties

CorrelationToken	Gets or sets the binding to a CorrelationToken.
Description	Gets or sets the user-defined description of the Activity. (Inherited from Activity)
DesignMode	Gets the value that indicates whether this instance is in design or run-time mode. (Inherited from DependencyObject)
Enabled	Gets or sets a value that indicates whether this instance is enabled for execution and validation. (Inherited from Activity)
EventName	Gets the name of the raised event. This property must be set before local communication can occur.
ExecutionResult	Gets the ActivityExecutionResult of the last attempt to run this instance. (Inherited from Activity)
ExecutionStatus	Gets the current ActivityExecutionStatus of this instance. (Inherited from Activity)
InterfaceType	Gets or sets the ExternalDataExchangeAttribute attributed interface type of the local service whose event is handled. This property must be set before local communication can occur.
IsDynamicActivity	Gets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance. (Inherited from Activity)
Name	Gets or sets the name of this instance. This name must conform to the variable naming convention of the programming language that is being used in the Workflow project. (Inherited from Activity)
ParameterBindings	Gets the collection of parameter bindings.
Parent	Gets the CompositeActivity that contains this Activity. (Inherited from Activity)
ParentDependencyObject	Gets the parent DependencyObject in the DependencyObject graph. (Inherited from DependencyObject)
QualifiedName	Gets the qualified name of the activity. Qualified activity names are always unique in a workflow instance. (Inherited from Activity)
Roles	Gets or sets a reference to a workflow role collection.
Site	Gets or sets a reference to the Site component of the DependencyObject. (Inherited from DependencyObject)
UserData	Gets an IDictionary that associates custom data with this class instance. (Inherited from DependencyObject)
WorkflowInstanceId	Gets the Guid associated with the instance. (Inherited from Activity)

Methods

AddHandler(DependencyProperty, Object)	Adds a handler for an event of a DependencyObject. (Inherited from DependencyObject)
Cancel(ActivityExecutionContext)	Cancels the handling of the event.
Clone()	Creates a deep copy of the Activity. (Inherited from Activity)
Dispose()	Releases all the resources used by the DependencyObject. (Inherited from DependencyObject)
Dispose(Boolean)	Releases the unmanaged resources and optionally releases the managed resources used by DependencyObject. (Inherited from DependencyObject)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Execute(ActivityExecutionContext)	Tries to run the HandleExternalEventActivity associated with the ActivityExecutionContext.
GetActivityByName(String, Boolean)	Returns the instance of the Activity whose name is requested from the set of all activities under the root the Activity of this instance if the second parameter is `false` and under the current Activity if the second parameter is `true`. (Inherited from Activity)
GetActivityByName(String)	Returns the instance of the Activity whose name is requested from the set of all activities running under the root activity of this instance, which is within the workflow. (Inherited from Activity)
GetBinding(DependencyProperty)	Provides access to the ActivityBind associated with the specific DependencyProperty. (Inherited from DependencyObject)
GetBoundValue(ActivityBind, Type)	Retrieves the Object that is the subject of an ActivityBind. (Inherited from DependencyObject)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetInvocationList<T>(DependencyProperty)	Gets an array that contains the delegates for the specified DependencyProperty. (Inherited from DependencyObject)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(DependencyProperty)	Provides access to the value of the designated DependencyProperty. (Inherited from DependencyObject)
GetValueBase(DependencyProperty)	Provides access to the bound object of a DependencyProperty and bypasses the GetValue(DependencyProperty) override. (Inherited from DependencyObject)
HandleFault(ActivityExecutionContext, Exception)	Called when an exception is raised within the context of the execution of this instance.
Initialize(IServiceProvider)	Initializes the event with the service provider.
InitializeProperties()	Performs initialization on dependency properties.
Invoke<T>(EventHandler<T>, T)	Subscribes an EventHandler and invokes that delegate. (Inherited from Activity)
Invoke<T>(IActivityEventListener<T>, T)	Subscribes an IActivityEventListener<T> and invokes that delegate. (Inherited from Activity)
IsBindingSet(DependencyProperty)	Indicates whether the value of a DependencyProperty is set as a binding. See SetBinding(DependencyProperty, ActivityBind). (Inherited from DependencyObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MetaEquals(DependencyObject)	Determines whether the `metaproperties` of this DependencyObject equals the `metaproperties` of the parameterized DependencyObject. (Inherited from DependencyObject)
OnActivityExecutionContextLoad(IServiceProvider)	Called by the workflow runtime whenever an ActivityExecutionContext is loaded. For example, this method is called during the creation of an ActivityExecutionContext as well as every time the ActivityExecutionContext is reincarnated when a workflow instance is loaded from persistent storage. (Inherited from Activity)
OnActivityExecutionContextUnload(IServiceProvider)	Called by the workflow runtime whenever an ActivityExecutionContext is unloaded. For example, this method is called during completion of an ActivityExecutionContext as well as every time the ActivityExecutionContext is unloaded when a workflow instance is persisted. (Inherited from Activity)
OnClosed(IServiceProvider)	Called by the workflow runtime as part of the activity's transition to the `Closed` state.
OnInvoked(EventArgs)	Called just after the external event is received to allow derived classes to process the inbound EventArgs before the activity closes.
RaiseEvent(DependencyProperty, Object, EventArgs)	Raises an Event associated with the specified dependency property. (Inherited from Activity)
RaiseGenericEvent<T>(DependencyProperty, Object, T)	Raises the event associated with the referenced DependencyProperty. (Inherited from Activity)
RegisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)	Registers the specified DependencyProperty for the status change event. (Inherited from Activity)
RemoveHandler(DependencyProperty, Object)	Removes an EventHandler from an associated DependencyProperty. (Inherited from DependencyObject)
RemoveProperty(DependencyProperty)	Removes a DependencyProperty from the DependencyObject. (Inherited from DependencyObject)
Save(Stream, IFormatter)	Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization. (Inherited from Activity)
Save(Stream)	Writes the Activity to a Stream for persistence. (Inherited from Activity)
SetBinding(DependencyProperty, ActivityBind)	Sets the ActivityBind for the specified DependencyProperty. (Inherited from DependencyObject)
SetBoundValue(ActivityBind, Object)	Sets the value of the target ActivityBind. (Inherited from DependencyObject)
SetReadOnlyPropertyValue(DependencyProperty, Object)	Sets the value of a DependencyProperty, which is read-only. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the value of the DependencyProperty to the object. (Inherited from DependencyObject)
SetValueBase(DependencyProperty, Object)	Sets the value of the DependencyProperty to the specified Object, bypassing the SetValue(DependencyProperty, Object). (Inherited from DependencyObject)
ToString()	Provides a string that represents this instance. (Inherited from Activity)
TrackData(Object)	Informs the run-time tracking infrastructure of pending tracking information. (Inherited from Activity)
TrackData(String, Object)	Informs the run-time tracking infrastructure of pending tracking information. (Inherited from Activity)
Uninitialize(IServiceProvider)	When overridden in a derived class, provides un-initialization by a service provider for the activity. (Inherited from Activity)
UnregisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)	Un-registers the specified DependencyProperty for the status change event. (Inherited from Activity)

Events

Canceling	Occurs when the activity execution is canceled. (Inherited from Activity)
Closed	Occurs when an Activity has completed execution. (Inherited from Activity)
Compensating	Occurs when running a compensation method on the Activity. (Inherited from Activity)
Executing	Occurs when the Activity is run. (Inherited from Activity)
Faulting	Occurs when an exception is raised during the running of the instance. (Inherited from Activity)
Invoked	Occurs when the external event is received.
StatusChanged	Occurs when the ActivityExecutionStatus of a running Activity changes. (Inherited from Activity)

Explicit Interface Implementations

IActivityEventListener<QueueEventArgs>.OnEvent(Object, QueueEventArgs)	Defines the processing procedure when the subscribed-to event occurs.
IComponent.Disposed	Represents the method that handles the Disposed event of a component. (Inherited from DependencyObject)
IDynamicPropertyTypeProvider.GetAccessType(IServiceProvider, String)	Returns the access type for the specified property.
IDynamicPropertyTypeProvider.GetPropertyType(IServiceProvider, String)	Returns the Type of the specified property.
IEventActivity.QueueName	Gets the name of the WorkflowQueue on which the activity is waiting for data to arrive.
IEventActivity.Subscribe(ActivityExecutionContext, IActivityEventListener<QueueEventArgs>)	Creates the subscription of the HandleExternalEventActivity activity to an event.
IEventActivity.Unsubscribe(ActivityExecutionContext, IActivityEventListener<QueueEventArgs>)	Cancels the subscription of the HandleExternalEventActivity activity to an event.

Applies to

Jaa