Export (0) Print
Expand All

CompensationHandlerActivity Class

Note: This API is now obsolete.

Specifies workflow logic that undoes, or compensates for, the successful execution of the associated CompositeActivity. This class cannot be inherited.

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

[ObsoleteAttribute("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
[ToolboxBitmapAttribute(typeof(CompensationHandlerActivity), "Resources.Compensation.png")]
[AlternateFlowActivityAttribute]
public sealed class CompensationHandlerActivity : CompositeActivity, 
	IActivityEventListener<ActivityExecutionStatusChangedEventArgs>

The CompensationHandlerActivity type exposes the following members.

  NameDescription
Public methodCompensationHandlerActivity()Initializes a new instance of the CompensationHandlerActivity class.
Public methodCompensationHandlerActivity(String)Initializes a new instance of the CompensationHandlerActivity class using the name of the activity.
Top

  NameDescription
Public propertyActivitiesGets the object representing the collection, ActivityCollection, of all child activities. (Inherited from CompositeActivity.)
Protected propertyCanModifyActivitiesGets or sets a value which controls whether the individual activities within Activities can be modified. (Inherited from CompositeActivity.)
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 propertyEnabledActivitiesGets the read-only collection that represents the subset of Activities that are enabled. (Inherited from CompositeActivity.)
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 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 propertyParentGets the CompositeActivity that contains this Activity. (Inherited from Activity.)
Public propertyQualifiedNameGets the qualified name of the activity. Qualified activity names are always unique in a workflow instance. (Inherited from Activity.)
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.)
Top

  NameDescription
Public methodAddHandlerAdds a handler for an event of a DependencyObject. (Inherited from DependencyObject.)
Protected methodCancelCalled by the workflow runtime to cancel execution of an activity that is currently executing. (Inherited from Activity.)
Public methodCloneCreates a deep copy of the Activity. (Inherited from Activity.)
Public methodDispose()Releases all the resources used by the DependencyObject. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodExecuteCalled by the workflow runtime to execute an activity. (Inherited from Activity.)
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.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
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. (Inherited from CompositeActivity.)
Protected methodInitializeInitializes all appropriate child activities of this instance and the specified IServiceProvider. (Inherited from CompositeActivity.)
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.)
Public methodMetaEqualsDetermines whether the metaproperties of this DependencyObject equals the metaproperties of the parameterized DependencyObject. (Inherited from DependencyObject.)
Protected methodOnActivityChangeAddCalls when an activity is added. (Inherited from CompositeActivity.)
Protected methodOnActivityChangeRemoveCalled when an activity is removed. (Inherited from CompositeActivity.)
Protected methodOnActivityExecutionContextLoadCalled by the workflow runtime engine every time the ActivityExecutionContext for this activity is loaded. (Inherited from CompositeActivity.)
Protected methodOnActivityExecutionContextUnloadCalled by the workflow runtime engine every time the ActivityExecutionContext for this activity is unloaded. (Inherited from CompositeActivity.)
Protected methodOnWorkflowChangesCompletedCalled after changes have been made to the collection Activities of this instance. (Inherited from CompositeActivity.)
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 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 methodUninitializeCalled by the workflow runtime engine when an activity transitions into the Closed state from the Initialized state. (Inherited from CompositeActivity.)
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 eventStatusChangedOccurs when the ActivityExecutionStatus of a running Activity changes. (Inherited from Activity.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIActivityEventListener<ActivityExecutionStatusChangedEventArgs>.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.)
Top

NoteNote

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

Any Activity definition can implement ICompensatableActivity. The parent of a CompensationHandlerActivity must implement this interface.

.NET Framework

Supported in: 4, 3.5, 3.0
Obsolete (compiler warning) in 4.5.2
Obsolete (compiler warning) in 4.5.1
Obsolete (compiler warning) in 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft