HandleExternalEventActivity Class
TOC
Collapse the table of content
Expand the table of content

HandleExternalEventActivity Class

 
Note: This API is now obsolete.

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

Namespace:   System.Workflow.Activities
Assembly:  System.Workflow.Activities (in System.Workflow.Activities.dll)

System.Object
  System.Workflow.ComponentModel.DependencyObject
    System.Workflow.ComponentModel.Activity
      System.Workflow.Activities.HandleExternalEventActivity

<ActivityValidatorAttribute(GetType(HandleExternalEventActivityValidator))>
<ObsoleteAttribute("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>
Public Class HandleExternalEventActivity
	Inherits Activity
	Implements IEventActivity, IActivityEventListener(Of QueueEventArgs),
	IDynamicPropertyTypeProvider

NameDescription
System_CAPS_pubmethodHandleExternalEventActivity()

Initializes a new instance of the HandleExternalEventActivity class.

System_CAPS_pubmethodHandleExternalEventActivity(String)

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

NameDescription
System_CAPS_pubpropertyCorrelationToken

Gets or sets the binding to a CorrelationToken.

System_CAPS_pubpropertyDescription

Gets or sets the user-defined description of the Activity.(Inherited from Activity.)

System_CAPS_protpropertyDesignMode

Gets the value that indicates whether this instance is in design or run-time mode.(Inherited from DependencyObject.)

System_CAPS_pubpropertyEnabled

Gets or sets a value that indicates whether this instance is enabled for execution and validation.(Inherited from Activity.)

System_CAPS_pubpropertyEventName

Gets the name of the raised event. This property must be set before local communication can occur.

System_CAPS_pubpropertyExecutionResult

Gets the ActivityExecutionResult of the last attempt to run this instance.(Inherited from Activity.)

System_CAPS_pubpropertyExecutionStatus

Gets the current ActivityExecutionStatus of this instance.(Inherited from Activity.)

System_CAPS_pubpropertyInterfaceType

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.

System_CAPS_pubpropertyIsDynamicActivity

Gets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance.(Inherited from Activity.)

System_CAPS_pubpropertyName

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.)

System_CAPS_pubpropertyParameterBindings

Gets the collection of parameter bindings.

System_CAPS_pubpropertyParent

Gets the CompositeActivity that contains this Activity.(Inherited from Activity.)

System_CAPS_protpropertyParentDependencyObject

Gets the parent DependencyObject in the DependencyObject graph.(Inherited from DependencyObject.)

System_CAPS_pubpropertyQualifiedName

Gets the qualified name of the activity. Qualified activity names are always unique in a workflow instance.(Inherited from Activity.)

System_CAPS_pubpropertyRoles

Gets or sets a reference to a workflow role collection.

System_CAPS_pubpropertySite

Gets or sets a reference to the Site component of the DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubpropertyUserData

Gets an IDictionary that associates custom data with this class instance.(Inherited from DependencyObject.)

System_CAPS_protpropertyWorkflowInstanceId

Gets the Guid associated with the instance.(Inherited from Activity.)

NameDescription
System_CAPS_pubmethodAddHandler(DependencyProperty, Object)

Adds a handler for an event of a DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodCancel(ActivityExecutionContext)

Cancels the handling of the event.(Overrides Activity.Cancel(ActivityExecutionContext).)

System_CAPS_pubmethodClone()

Creates a deep copy of the Activity.(Inherited from Activity.)

System_CAPS_pubmethodDispose()

Releases all the resources used by the DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources and optionally releases the managed resources used by DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodExecute(ActivityExecutionContext)

Tries to run the HandleExternalEventActivity associated with the ActivityExecutionContext.(Overrides Activity.Execute(ActivityExecutionContext).)

System_CAPS_protmethodFinalize()

Provided as an override to Object.Finalize to clean up any unmanaged resources deterministically.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetActivityByName(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.)

System_CAPS_pubmethodGetActivityByName(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.)

System_CAPS_pubmethodGetBinding(DependencyProperty)

Provides access to the ActivityBind associated with the specific DependencyProperty.(Inherited from DependencyObject.)

System_CAPS_protmethodGetBoundValue(ActivityBind, Type)

Retrieves the Object that is the subject of an ActivityBind.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_protmethodGetInvocationList(Of T)(DependencyProperty)

Gets an array that contains the delegates for the specified DependencyProperty.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(DependencyProperty)

Provides access to the value of the designated DependencyProperty.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetValueBase(DependencyProperty)

Provides access to the bound object of a DependencyProperty and bypasses the GetValue override.(Inherited from DependencyObject.)

System_CAPS_protmethodHandleFault(ActivityExecutionContext, Exception)

Called when an exception is raised within the context of the execution of this instance.(Overrides Activity.HandleFault(ActivityExecutionContext, Exception).)

System_CAPS_protmethodInitialize(IServiceProvider)

Initializes the event with the service provider.(Overrides Activity.Initialize(IServiceProvider).)

System_CAPS_protmethodInitializeProperties()

Performs initialization on dependency properties.(Overrides DependencyObject.InitializeProperties().)

System_CAPS_protmethodInvoke(Of T)(EventHandler(Of T), T)

Subscribes an EventHandler and invokes that delegate.(Inherited from Activity.)

System_CAPS_protmethodInvoke(Of T)(IActivityEventListener(Of T), T)

Subscribes an IActivityEventListener(Of T) and invokes that delegate.(Inherited from Activity.)

System_CAPS_pubmethodIsBindingSet(DependencyProperty)

Indicates whether the value of a DependencyProperty is set as a binding. See SetBinding.(Inherited from DependencyObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodMetaEquals(DependencyObject)

Determines whether the metaproperties of this DependencyObject equals the metaproperties of the parameterized DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodOnActivityExecutionContextLoad(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.)

System_CAPS_protmethodOnActivityExecutionContextUnload(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.)

System_CAPS_protmethodOnClosed(IServiceProvider)

Called by the workflow runtime as part of the activity's transition to the Closed state.(Overrides Activity.OnClosed(IServiceProvider).)

System_CAPS_protmethodOnInvoked(EventArgs)

Called just after the external event is received to allow derived classes to process the inbound EventArgs before the activity closes.

System_CAPS_protmethodRaiseEvent(DependencyProperty, Object, EventArgs)

Raises an Event associated with the specified dependency property.(Inherited from Activity.)

System_CAPS_protmethodRaiseGenericEvent(Of T)(DependencyProperty, Object, T)

Raises the event associated with the referenced DependencyProperty.(Inherited from Activity.)

System_CAPS_pubmethodRegisterForStatusChange(DependencyProperty, IActivityEventListener(Of ActivityExecutionStatusChangedEventArgs))

Registers the specified DependencyProperty for the status change event.(Inherited from Activity.)

System_CAPS_pubmethodRemoveHandler(DependencyProperty, Object)

Removes an EventHandler from an associated DependencyProperty.(Inherited from DependencyObject.)

System_CAPS_pubmethodRemoveProperty(DependencyProperty)

Removes a DependencyProperty from the DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodSave(Stream)

Writes the Activity to a Stream for persistence.(Inherited from Activity.)

System_CAPS_pubmethodSave(Stream, IFormatter)

Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization.(Inherited from Activity.)

System_CAPS_pubmethodSetBinding(DependencyProperty, ActivityBind)

Sets the ActivityBind for the specified DependencyProperty. (Inherited from DependencyObject.)

System_CAPS_protmethodSetBoundValue(ActivityBind, Object)

Sets the value of the target ActivityBind.(Inherited from DependencyObject.)

System_CAPS_protmethodSetReadOnlyPropertyValue(DependencyProperty, Object)

Sets the value of a DependencyProperty, which is read-only.(Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyProperty, Object)

Sets the value of the DependencyProperty to the object.(Inherited from DependencyObject.)

System_CAPS_pubmethodSetValueBase(DependencyProperty, Object)

Sets the value of the DependencyProperty to the specified Object, bypassing the SetValue.(Inherited from DependencyObject.)

System_CAPS_pubmethodToString()

Provides a string that represents this instance.(Inherited from Activity.)

System_CAPS_protmethodTrackData(Object)

Informs the run-time tracking infrastructure of pending tracking information.(Inherited from Activity.)

System_CAPS_protmethodTrackData(String, Object)

Informs the run-time tracking infrastructure of pending tracking information.(Inherited from Activity.)

System_CAPS_protmethodUninitialize(IServiceProvider)

When overridden in a derived class, provides un-initialization by a service provider for the activity. (Inherited from Activity.)

System_CAPS_pubmethodUnregisterForStatusChange(DependencyProperty, IActivityEventListener(Of ActivityExecutionStatusChangedEventArgs))

Un-registers the specified DependencyProperty for the status change event.(Inherited from Activity.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticCorrelationTokenProperty

Represents the DependencyProperty that targets the CorrelationToken property.

System_CAPS_pubfieldSystem_CAPS_staticEventNameProperty

Corresponds to the name of an event that is defined in an interface that was marked with the ExternalDataExchangeAttribute.

System_CAPS_pubfieldSystem_CAPS_staticInterfaceTypeProperty

Corresponds to the name of the interface that was marked with the ExternalDataExchangeAttribute.

System_CAPS_pubfieldSystem_CAPS_staticInvokedEvent

Defines an event delegate that is executed after the activity receives the expected event from the local service.

System_CAPS_pubfieldSystem_CAPS_staticParameterBindingsProperty

Represents the DependencyProperty that targets the ParameterBindings property.

System_CAPS_pubfieldSystem_CAPS_staticRolesProperty

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.

NameDescription
System_CAPS_pubeventCanceling

Occurs when the activity execution is canceled. (Inherited from Activity.)

System_CAPS_pubeventClosed

Occurs when an Activity has completed execution.(Inherited from Activity.)

System_CAPS_pubeventCompensating

Occurs when running a compensation method on the Activity.(Inherited from Activity.)

System_CAPS_pubeventExecuting

Occurs when the Activity is run.(Inherited from Activity.)

System_CAPS_pubeventFaulting

Occurs when an exception is raised during the running of the instance.(Inherited from Activity.)

System_CAPS_pubeventInvoked

Occurs when the external event is received.

System_CAPS_pubeventStatusChanged

Occurs when the ActivityExecutionStatus of a running Activity changes.(Inherited from Activity.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_priveventIComponent.Disposed

Represents the method that handles the Disposed event of a component.(Inherited from DependencyObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEventActivity.Subscribe(ActivityExecutionContext, IActivityEventListener(Of QueueEventArgs))

Creates the subscription of the HandleExternalEventActivity activity to an event.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEventActivity.Unsubscribe(ActivityExecutionContext, IActivityEventListener(Of QueueEventArgs))

Cancels the subscription of the HandleExternalEventActivity activity to an event.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIActivityEventListener(Of QueueEventArgs).OnEvent(Object, QueueEventArgs)

Defines the processing procedure when the subscribed-to event occurs.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDynamicPropertyTypeProvider.GetAccessType(IServiceProvider, String)

Returns the access type for the specified property.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDynamicPropertyTypeProvider.GetPropertyType(IServiceProvider, String)

Returns the Type of the specified property.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIEventActivity.QueueName

Gets the name of the WorkflowQueue on which the activity is waiting for data to arrive.

System_CAPS_noteNote

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(Of T) interface because the derived class does not execute correctly.

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, seeRaise Event To Load Workflow.

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

.NET Framework
Available since 3.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

System.Workflow.Activities Namespace
Using the HandleExternalEvent Activity

Return to top
Show:
© 2016 Microsoft