CodeActivity Class (System.Activities)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
CodeActivity Class

An abstract class for creating a custom activity with imperative behavior defined with the Execute(CodeActivityContext) method, which gives access to variable and argument resolution and extensions.

Inheritance Hierarchy
System.Object
  System.Activities.Activity
    System.Activities.CodeActivity
      System.Activities.Statements.AddToCollection<T>
      System.Activities.Statements.Assign
      System.Activities.Statements.Assign<T>
      System.Activities.Statements.ClearCollection<T>
      System.Activities.Statements.Throw
      System.Activities.Statements.WriteLine

Namespace:  System.Activities
Assembly:  System.Activities (in System.Activities.dll)
Syntax
Visual Basic
Public MustInherit Class CodeActivity _
	Inherits Activity
C#
public abstract class CodeActivity : Activity
Visual C++
public ref class CodeActivity abstract : public Activity
F#
[<AbstractClass>]
type CodeActivity =  
    class
        inherit Activity
    end

The CodeActivity type exposes the following members.

Constructors
  Name Description
Protected method CodeActivity When implemented in a derived class, creates an instance of the derived class.
Top
Properties
  Name Description
Protected property CacheId Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
Protected property Constraints Gets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity.)
Public property DisplayName Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
Public property Id Gets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
Protected property Implementation Not supported. (Overrides Activity.Implementation.)
Top
Methods
  Name Description
Protected method CacheMetadata(ActivityMetadata) Not implemented. Use CacheMetadata(CodeActivityMetadata) instead. (Overrides Activity.CacheMetadata(ActivityMetadata).)
Protected method CacheMetadata(CodeActivityMetadata) Creates and validates a description of the activity’s arguments, variables, child activities, and activity delegates.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Execute When implemented in a derived class, performs the execution of the activity.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ShouldSerializeDisplayName Indicates whether the DisplayName property should be serialized. (Inherited from Activity.)
Public method ToString Returns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)
Top
Examples

The following example shows how to implement a CodeActivity-derived activity.

C#

public sealed class MessageBox : CodeActivity
{
    public InArgument<string> Text{ get; set; }

    protected override void Execute(CodeActivityContext context)
    {
        System.Windows.Forms.MessageBox.Show(this.Text.Get(context));
    }
}
Version Information

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4
Platforms

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.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.Activities Namespace
Community Content

RahulMisra2000
Sample Code Activity
I have created a Code Activity but have not been able to locate one sample of where the Code Activity is being called from code or from the designer.