1 out of 1 rated this helpful - Rate this topic

Activity Class

Represents the fundamental building block of workflows. Activity is the base class for all activities.

System.Object
  System.Workflow.ComponentModel.DependencyObject
    System.Workflow.ComponentModel.Activity
      More...

Namespace:  System.Workflow.ComponentModel
Assembly:  System.Workflow.ComponentModel (in System.Workflow.ComponentModel.dll)
[RuntimeNamePropertyAttribute("Name")]
[ActivityValidatorAttribute(typeof(ActivityValidator))]
[ToolboxBitmapAttribute(typeof(Activity), "Design.Resources.Activity.png")]
[ActivityCodeGeneratorAttribute(typeof(ActivityCodeGenerator))]
public class Activity : DependencyObject

The Activity type exposes the following members.

  Name Description
Public method Activity() Initializes a new instance of the Activity class.
Public method Activity(String) Initializes a new instance of the Activity class, while initializing the Name.
Top
  Name Description
Public property Description Gets or sets the user-defined description of the Activity.
Protected property DesignMode Gets the value that indicates whether this instance is in design or run-time mode. (Inherited from DependencyObject.)
Public property Enabled Gets or sets a value that indicates whether this instance is enabled for execution and validation.
Public property ExecutionResult Gets the ActivityExecutionResult of the last attempt to run this instance.
Public property ExecutionStatus Gets the current ActivityExecutionStatus of this instance.
Public property IsDynamicActivity Gets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance.
Public property 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.
Public property Parent Gets the CompositeActivity that contains this Activity.
Protected property ParentDependencyObject Gets the parent DependencyObject in the DependencyObject graph. (Inherited from DependencyObject.)
Public property QualifiedName Gets the qualified name of the activity. Qualified activity names are always unique in a workflow instance.
Public property Site Gets or sets a reference to the Site component of the DependencyObject. (Inherited from DependencyObject.)
Public property UserData Gets an IDictionary that associates custom data with this class instance. (Inherited from DependencyObject.)
Protected property WorkflowInstanceId Gets the Guid associated with the instance.
Top
  Name Description
Public method AddHandler Adds a handler for an event of a DependencyObject. (Inherited from DependencyObject.)
Protected method Cancel Called by the workflow runtime to cancel execution of an activity that is currently executing.
Public method Clone Creates a deep copy of the Activity.
Public method Dispose() Releases all the resources used by the DependencyObject. (Inherited from DependencyObject.)
Protected method Dispose(Boolean) Releases the unmanaged resources and optionally releases the managed resources used by DependencyObject. (Inherited from DependencyObject.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Execute Called by the workflow runtime to execute an activity.
Protected method Finalize Provided as an override to Object.Finalize to clean up any unmanaged resources deterministically. (Inherited from DependencyObject.)
Public method 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.
Public method 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.
Public method GetBinding Provides access to the ActivityBind associated with the specific DependencyProperty. (Inherited from DependencyObject.)
Protected method GetBoundValue Retrieves the Object that is the subject of an ActivityBind. (Inherited from DependencyObject.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetInvocationList<T> Gets an array that contains the delegates for the specified DependencyProperty. (Inherited from DependencyObject.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Provides access to the value of the designated DependencyProperty. (Inherited from DependencyObject.)
Public method GetValueBase Provides access to the bound object of a DependencyProperty and bypasses the GetValue override. (Inherited from DependencyObject.)
Protected method HandleFault Called when an exception is raised within the context of the execution of this instance.
Protected method Initialize Called by the workflow runtime to initialize an activity during the construction of a new workflow instance. This method is called during the construction of a dynamic ActivityExecutionContext.
Protected method InitializeProperties Performs initialization on dependency properties when overridden in a derived class. (Inherited from DependencyObject.)
Protected method Invoke<T>(EventHandler<T>, T) Subscribes an EventHandler and invokes that delegate.
Protected method Invoke<T>(IActivityEventListener<T>, T) Subscribes an IActivityEventListener<T> and invokes that delegate.
Public method IsBindingSet Indicates whether the value of a DependencyProperty is set as a binding. See SetBinding. (Inherited from DependencyObject.)
Public method Static member Load(Stream, Activity) Loads an instance of an Activity from a Stream.
Public method Static member Load(Stream, Activity, IFormatter) Loads an instance of an Activity from a Stream using the custom IFormatter for deserialization.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MetaEquals Determines whether the metaproperties of this DependencyObject equals the metaproperties of the parameterized DependencyObject. (Inherited from DependencyObject.)
Protected method OnActivityExecutionContextLoad 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.
Protected method OnActivityExecutionContextUnload 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.
Protected method OnClosed Called by the workflow runtime as part of the activity's transition to the closed state.
Protected method RaiseEvent Raises an Event associated with the specified dependency property.
Protected method RaiseGenericEvent<T> Raises the event associated with the referenced DependencyProperty.
Public method RegisterForStatusChange Registers the specified DependencyProperty for the status change event.
Public method RemoveHandler Removes an EventHandler from an associated DependencyProperty. (Inherited from DependencyObject.)
Public method RemoveProperty Removes a DependencyProperty from the DependencyObject. (Inherited from DependencyObject.)
Public method Save(Stream) Writes the Activity to a Stream for persistence.
Public method Save(Stream, IFormatter) Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization.
Public method SetBinding Sets the ActivityBind for the specified DependencyProperty. (Inherited from DependencyObject.)
Protected method SetBoundValue Sets the value of the target ActivityBind. (Inherited from DependencyObject.)
Protected method SetReadOnlyPropertyValue Sets the value of a DependencyProperty, which is read-only. (Inherited from DependencyObject.)
Public method SetValue Sets the value of the DependencyProperty to the object. (Inherited from DependencyObject.)
Public method SetValueBase Sets the value of the DependencyProperty to the specified Object, bypassing the SetValue. (Inherited from DependencyObject.)
Public method ToString Provides a string that represents this instance. (Overrides Object.ToString().)
Protected method TrackData(Object) Informs the run-time tracking infrastructure of pending tracking information.
Protected method TrackData(String, Object) Informs the run-time tracking infrastructure of pending tracking information.
Protected method Uninitialize When overridden in a derived class, provides un-initialization by a service provider for the activity.
Public method UnregisterForStatusChange Un-registers the specified DependencyProperty for the status change event.
Top
  Name Description
Public event Canceling Occurs when the activity execution is canceled.
Public event Closed Occurs when an Activity has completed execution.
Public event Compensating Occurs when running a compensation method on the Activity.
Public event Executing Occurs when the Activity is run.
Public event Faulting Occurs when an exception is raised during the running of the instance.
Public event StatusChanged Occurs when the ActivityExecutionStatus of a running Activity changes.
Top
  Name Description
Public field Static member ActivityContextGuidProperty The DependencyProperty that represents the Guid of the ActivityExecutionContext that is associated with the Activity.
Public field Static member CancelingEvent Represents the DependencyProperty that targets the Canceling event.
Public field Static member ClosedEvent Represents the DependencyProperty that targets the Closed event.
Public field Static member CompensatingEvent Represents the DependencyProperty that targets the Compensating event.
Public field Static member ExecutingEvent Represents the DependencyProperty that targets the Executing event, which occurs when the activity is executed.
Public field Static member FaultingEvent The DependencyProperty that represents the Faulting event.
Public field Static member StatusChangedEvent Represents the DependencyProperty that targets the StatusChanged event.
Top
  Name Description
Explicit interface implemetation Private event IComponent.Disposed Represents the method that handles the Disposed event of a component. (Inherited from DependencyObject.)
Top

An Activity is the fundamental building block of workflows. An Activity defines a set of properties and events, such as any class, along with execution logic that defines the activity's run-time behavior. A set of additional components can be associated with an Activity. These include, but are not limited to a validator, a code generator, custom serializers, and a designer.

All activities share a common set of properties defined on the Activity base class. Each Activity can declare its own additional properties according to its requirements by extending this class. Because Activity derives from DependencyObject, properties can be defined as standard CLR properties and as dependency properties.

The execution logic of an Activity fulfills a contract that exists between any Activity and the workflow runtime. You must document the execution logic of any Activity in a functional sense, so that a workflow developer who uses the Activity knows how it behaves. The execution logic itself is hidden from the workflow developer who includes the activity in a workflow, because the execution logic is part of a contract that exists strictly between the workflow runtime and the Activity.

This example defines an activity whose purpose is to send an email. The activity defines one property, Subject, that uses a dependency property in its implementation. Other properties can be defined in a similar way. The Execute method is overridden to provide the logic for sending the email. For a complete example, see the Send E-mail Activity Sample.

public class SendEmail : Activity
{
    public static readonly DependencyProperty SubjectProperty =
        DependencyProperty.Register("Subject", typeof(string), typeof(SendEmail));

    public string Subject
    {
        get { return base.GetValue(SubjectProperty) as string; }
        set { base.SetValue(SubjectProperty, value); }
    }

    // Define other properties...

    protected override ActivityExecutionStatus Execute(ActivityExecutionContext executionContext)
    {
        // Logic to send the e-mail goes here...
        return ActivityExecutionStatus.Closed;
    }
}

.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)
Community Content Add
Annotations FAQ