This topic has not yet been rated - Rate this topic

CodeActivity Class

.NET Framework 4.5

.NET Framework 4

An abstract class for creating a custom activity with imperative behavior defined with the Execute 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

C++

public abstract class CodeActivity : Activity

The CodeActivity type exposes the following members.

Constructors

	Name	Description
	CodeActivity	When implemented in a derived class, creates an instance of the derived class.

Top

Properties

	Name	Description
	CacheId	Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
	Constraints	Gets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity.)
	DisplayName	Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
	Id	Gets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
	Implementation	Not supported. (Overrides Activity.Implementation.)
	ImplementationVersion	Gets or sets the implementation version of the activity. (Overrides Activity.ImplementationVersion.)

Top

Methods

	Name	Description
	CacheMetadata(ActivityMetadata)	Not implemented. Use CacheMetadata instead. (Overrides Activity.CacheMetadata(ActivityMetadata).)
	CacheMetadata(CodeActivityMetadata)	Creates and validates a description of the activity’s arguments, variables, child activities, and activity delegates.
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Execute	When implemented in a derived class, performs the execution of the activity.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnCreateDynamicUpdateMap	Raises an event when creating a map for the dynamic update. (Overrides Activity.OnCreateDynamicUpdateMap(UpdateMapMetadata, Activity).)
	ShouldSerializeDisplayName	Indicates whether the DisplayName property should be serialized. (Inherited from Activity.)
	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.

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.5, 4

.NET Framework Client Profile

Supported in: 4

Platforms

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.

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.

Reference

System.Activities Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)