Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

HandleExternalEventActivity Class

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)
[ActivityValidatorAttribute(typeof(HandleExternalEventActivityValidator))]
public class HandleExternalEventActivity : Activity, 
	IEventActivity, IActivityEventListener<QueueEventArgs>, IDynamicPropertyTypeProvider

The HandleExternalEventActivity type exposes the following members.

  NameDescription
Public methodHandleExternalEventActivity()Initializes a new instance of the HandleExternalEventActivity class.
Public methodHandleExternalEventActivity(String)Initializes a new instance of the HandleExternalEventActivity class using the name of the activity.
Top
  NameDescription
Public propertyCorrelationTokenGets or sets the binding to a CorrelationToken.
Public propertyDescriptionGets or sets the user-defined description of the Activity. (Inherited from Activity.)
Protected propertyDesignModeGets the value that indicates whether this instance is in design or run-time mode. (Inherited from DependencyObject.)
Public propertyEnabledGets or sets a value that indicates whether this instance is enabled for execution and validation. (Inherited from Activity.)
Public propertyEventNameGets the name of the raised event. This property must be set before local communication can occur.
Public propertyExecutionResultGets the ActivityExecutionResult of the last attempt to run this instance. (Inherited from Activity.)
Public propertyExecutionStatusGets the current ActivityExecutionStatus of this instance. (Inherited from Activity.)
Public propertyInterfaceTypeGets 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.
Public propertyIsDynamicActivityGets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance. (Inherited from Activity.)
Public propertyNameGets 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.)
Public propertyParameterBindingsGets the collection of parameter bindings.
Public propertyParentGets the CompositeActivity that contains this Activity. (Inherited from Activity.)
Protected propertyParentDependencyObjectGets the parent DependencyObject in the DependencyObject graph. (Inherited from DependencyObject.)
Public propertyQualifiedNameGets the qualified name of the activity. Qualified activity names are always unique in a workflow instance. (Inherited from Activity.)
Public propertyRolesGets or sets a reference to a workflow role collection.
Public propertySiteGets or sets a reference to the Site component of the DependencyObject. (Inherited from DependencyObject.)
Public propertyUserDataGets an IDictionary that associates custom data with this class instance. (Inherited from DependencyObject.)
Protected propertyWorkflowInstanceIdGets the Guid associated with the instance. (Inherited from Activity.)
Top
  NameDescription
Public methodAddHandlerAdds a handler for an event of a DependencyObject. (Inherited from DependencyObject.)
Protected methodCancelCancels the handling of the event. (Overrides Activity.Cancel(ActivityExecutionContext).)
Public methodCloneCreates a deep copy of the Activity. (Inherited from Activity.)
Public methodDispose()Releases all the resources used by the DependencyObject. (Inherited from DependencyObject.)
Protected methodDispose(Boolean)Releases the unmanaged resources and optionally releases the managed resources used by DependencyObject. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodExecuteTries to run the HandleExternalEventActivity associated with the ActivityExecutionContext. (Overrides Activity.Execute(ActivityExecutionContext).)
Protected methodFinalizeProvided as an override to Object.Finalize to clean up any unmanaged resources deterministically. (Inherited from DependencyObject.)
Public methodGetActivityByName(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.)
Public methodGetActivityByName(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.)
Public methodGetBindingProvides access to the ActivityBind associated with the specific DependencyProperty. (Inherited from DependencyObject.)
Protected methodGetBoundValueRetrieves the Object that is the subject of an ActivityBind. (Inherited from DependencyObject.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetInvocationList<T>Gets an array that contains the delegates for the specified DependencyProperty. (Inherited from DependencyObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueProvides access to the value of the designated DependencyProperty. (Inherited from DependencyObject.)
Public methodGetValueBaseProvides access to the bound object of a DependencyProperty and bypasses the GetValue override. (Inherited from DependencyObject.)
Protected methodHandleFaultCalled when an exception is raised within the context of the execution of this instance. (Overrides Activity.HandleFault(ActivityExecutionContext, Exception).)
Protected methodInitializeInitializes the event with the service provider. (Overrides Activity.Initialize(IServiceProvider).)
Protected methodInitializePropertiesPerforms initialization on dependency properties. (Overrides DependencyObject.InitializeProperties().)
Protected methodInvoke<T>(EventHandler<T>, T)Subscribes an EventHandler and invokes that delegate. (Inherited from Activity.)
Protected methodInvoke<T>(IActivityEventListener<T>, T)Subscribes an IActivityEventListener<T> and invokes that delegate. (Inherited from Activity.)
Public methodIsBindingSetIndicates whether the value of a DependencyProperty is set as a binding. See SetBinding. (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMetaEqualsDetermines whether the metaproperties of this DependencyObject equals the metaproperties of the parameterized DependencyObject. (Inherited from DependencyObject.)
Protected methodOnActivityExecutionContextLoadCalled 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.)
Protected methodOnActivityExecutionContextUnloadCalled 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.)
Protected methodOnClosedCalled by the workflow runtime as part of the activity's transition to the Closed state. (Overrides Activity.OnClosed(IServiceProvider).)
Protected methodOnInvokedCalled just after the external event is received to allow derived classes to process the inbound EventArgs before the activity closes.
Protected methodRaiseEventRaises an Event associated with the specified dependency property. (Inherited from Activity.)
Protected methodRaiseGenericEvent<T>Raises the event associated with the referenced DependencyProperty. (Inherited from Activity.)
Public methodRegisterForStatusChangeRegisters the specified DependencyProperty for the status change event. (Inherited from Activity.)
Public methodRemoveHandlerRemoves an EventHandler from an associated DependencyProperty. (Inherited from DependencyObject.)
Public methodRemovePropertyRemoves a DependencyProperty from the DependencyObject. (Inherited from DependencyObject.)
Public methodSave(Stream)Writes the Activity to a Stream for persistence. (Inherited from Activity.)
Public methodSave(Stream, IFormatter)Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization. (Inherited from Activity.)
Public methodSetBindingSets the ActivityBind for the specified DependencyProperty. (Inherited from DependencyObject.)
Protected methodSetBoundValueSets the value of the target ActivityBind. (Inherited from DependencyObject.)
Protected methodSetReadOnlyPropertyValueSets the value of a DependencyProperty, which is read-only. (Inherited from DependencyObject.)
Public methodSetValueSets the value of the DependencyProperty to the object. (Inherited from DependencyObject.)
Public methodSetValueBaseSets the value of the DependencyProperty to the specified Object, bypassing the SetValue. (Inherited from DependencyObject.)
Public methodToStringProvides a string that represents this instance. (Inherited from Activity.)
Protected methodTrackData(Object)Informs the run-time tracking infrastructure of pending tracking information. (Inherited from Activity.)
Protected methodTrackData(String, Object)Informs the run-time tracking infrastructure of pending tracking information. (Inherited from Activity.)
Protected methodUninitializeWhen overridden in a derived class, provides un-initialization by a service provider for the activity. (Inherited from Activity.)
Public methodUnregisterForStatusChangeUn-registers the specified DependencyProperty for the status change event. (Inherited from Activity.)
Top
  NameDescription
Public eventCancelingOccurs when the activity execution is canceled. (Inherited from Activity.)
Public eventClosedOccurs when an Activity has completed execution. (Inherited from Activity.)
Public eventCompensatingOccurs when running a compensation method on the Activity. (Inherited from Activity.)
Public eventExecutingOccurs when the Activity is run. (Inherited from Activity.)
Public eventFaultingOccurs when an exception is raised during the running of the instance. (Inherited from Activity.)
Public eventInvokedOccurs when the external event is received.
Public eventStatusChangedOccurs when the ActivityExecutionStatus of a running Activity changes. (Inherited from Activity.)
Top
  NameDescription
Public fieldStatic memberCorrelationTokenPropertyRepresents the DependencyProperty that targets the CorrelationToken property.
Public fieldStatic memberEventNamePropertyCorresponds to the name of an event that is defined in an interface that was marked with the ExternalDataExchangeAttribute.
Public fieldStatic memberInterfaceTypePropertyCorresponds to the name of the interface that was marked with the ExternalDataExchangeAttribute.
Public fieldStatic memberInvokedEventDefines an event delegate that is executed after the activity receives the expected event from the local service.
Public fieldStatic memberParameterBindingsPropertyRepresents the DependencyProperty that targets the ParameterBindings property.
Public fieldStatic memberRolesPropertyIdentifies 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.
Top
  NameDescription
Explicit interface implemetationPrivate methodIActivityEventListener<QueueEventArgs>.OnEventDefines the processing procedure when the subscribed-to event occurs.
Explicit interface implemetationPrivate eventIComponent.DisposedRepresents the method that handles the Disposed event of a component. (Inherited from DependencyObject.)
Explicit interface implemetationPrivate methodIDynamicPropertyTypeProvider.GetAccessTypeReturns the access type for the specified property.
Explicit interface implemetationPrivate methodIDynamicPropertyTypeProvider.GetPropertyTypeReturns the Type of the specified property.
Explicit interface implemetationPrivate propertyIEventActivity.QueueNameGets the name of the WorkflowQueue on which the activity is waiting for data to arrive.
Explicit interface implemetationPrivate methodIEventActivity.SubscribeCreates the subscription of the HandleExternalEventActivity activity to an event.
Explicit interface implemetationPrivate methodIEventActivity.UnsubscribeCancels the subscription of the HandleExternalEventActivity activity to an event.
Top

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.

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.


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


.NET Framework

Supported in: 4, 3.5, 3.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.