Export (0) Print
Expand All

Activity Class

Note: This API is now obsolete.

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)

[ToolboxBitmapAttribute(typeof(Activity), "Design.Resources.Activity.png")]
[ActivityCodeGeneratorAttribute(typeof(ActivityCodeGenerator))]
[ActivityValidatorAttribute(typeof(ActivityValidator))]
[RuntimeNamePropertyAttribute("Name")]
[ObsoleteAttribute("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public class Activity : DependencyObject

The Activity type exposes the following members.

  NameDescription
Public methodActivity()Initializes a new instance of the Activity class.
Public methodActivity(String)Initializes a new instance of the Activity class, while initializing the Name.
Top

  NameDescription
Public propertyDescriptionGets or sets the user-defined description of the 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.
Public propertyExecutionResultGets the ActivityExecutionResult of the last attempt to run this instance.
Public propertyExecutionStatusGets the current ActivityExecutionStatus of this instance.
Public propertyIsDynamicActivityGets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance.
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.
Public propertyParentGets the CompositeActivity that contains this 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.
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.
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.
Public methodCloneCreates a deep copy of the 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 methodExecuteCalled by the workflow runtime to execute an activity.
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.
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.
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 the default hash function. (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.
Protected methodInitializeCalled 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 methodInitializePropertiesPerforms initialization on dependency properties when overridden in a derived class. (Inherited from DependencyObject.)
Protected methodInvoke<T>(EventHandler<T>, T)Subscribes an EventHandler and invokes that delegate.
Protected methodInvoke<T>(IActivityEventListener<T>, T)Subscribes an IActivityEventListener<T> and invokes that delegate.
Public methodIsBindingSetIndicates whether the value of a DependencyProperty is set as a binding. See SetBinding. (Inherited from DependencyObject.)
Public methodStatic memberLoad(Stream, Activity)Loads an instance of an Activity from a Stream.
Public methodStatic memberLoad(Stream, Activity, IFormatter)Loads an instance of an Activity from a Stream using the custom IFormatter for deserialization.
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.
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.
Protected methodOnClosedCalled by the workflow runtime as part of the activity's transition to the closed state.
Protected methodRaiseEventRaises an Event associated with the specified dependency property.
Protected methodRaiseGenericEvent<T>Raises the event associated with the referenced DependencyProperty.
Public methodRegisterForStatusChangeRegisters the specified DependencyProperty for the status change event.
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.
Public methodSave(Stream, IFormatter)Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization.
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. (Overrides Object.ToString().)
Protected methodTrackData(Object)Informs the run-time tracking infrastructure of pending tracking information.
Protected methodTrackData(String, Object)Informs the run-time tracking infrastructure of pending tracking information.
Protected methodUninitializeWhen overridden in a derived class, provides un-initialization by a service provider for the activity.
Public methodUnregisterForStatusChangeUn-registers the specified DependencyProperty for the status change event.
Top

  NameDescription
Public eventCancelingOccurs when the activity execution is canceled.
Public eventClosedOccurs when an Activity has completed execution.
Public eventCompensatingOccurs when running a compensation method on the Activity.
Public eventExecutingOccurs when the Activity is run.
Public eventFaultingOccurs when an exception is raised during the running of the instance.
Public eventStatusChangedOccurs when the ActivityExecutionStatus of a running Activity changes.
Top

  NameDescription
Public fieldStatic memberActivityContextGuidPropertyThe DependencyProperty that represents the Guid of the ActivityExecutionContext that is associated with the Activity.
Public fieldStatic memberCancelingEventRepresents the DependencyProperty that targets the Canceling event.
Public fieldStatic memberClosedEventRepresents the DependencyProperty that targets the Closed event.
Public fieldStatic memberCompensatingEventRepresents the DependencyProperty that targets the Compensating event.
Public fieldStatic memberExecutingEventRepresents the DependencyProperty that targets the Executing event, which occurs when the activity is executed.
Public fieldStatic memberFaultingEventThe DependencyProperty that represents the Faulting event.
Public fieldStatic memberStatusChangedEventRepresents the DependencyProperty that targets the StatusChanged event.
Top

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

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
Obsolete (compiler warning) in 4.5
Obsolete (compiler warning) in 4.5.1
Obsolete (compiler warning) in 4.5.2

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