CodeActivity(Of TResult) Class

An abstract class for creating a custom activity with imperative behavior defined in the Execute method, giving access to variable and argument resolution and extensions.

System.Object
  System.Activities.Activity
    System.Activities.ActivityWithResult
      System.Activities.Activity(Of TResult)
        System.Activities.CodeActivity(Of TResult)
          More...

Namespace:  System.Activities
Assembly:  System.Activities (in System.Activities.dll)

'Declaration
Public MustInherit Class CodeActivity(Of TResult) _
	Inherits Activity(Of TResult)

Type Parameters

TResult

The result returned by the activity.

The CodeActivity(Of TResult) type exposes the following members.

  NameDescription
Protected methodCodeActivity(Of TResult)When implemented in a derived class, creates an instance of the derived class.
Top

  NameDescription
Protected propertyCacheIdGets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
Protected propertyConstraintsGets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity.)
Public propertyDisplayNameGets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
Public propertyIdGets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
Protected propertyImplementationNot supported. (Overrides Activity.Implementation.)
Protected propertyImplementationVersionGets or sets the implementation version of the activity. (Overrides Activity.ImplementationVersion.)
Public propertyResultGets or sets the result argument for the Activity(Of TResult). (Inherited from Activity(Of TResult).)
Public propertyResultTypeWhen implemented in a derived class, gets the type of an activity OutArgument. (Inherited from ActivityWithResult.)
Top

  NameDescription
Protected methodCacheMetadata(ActivityMetadata)Not implemented. Use CacheMetadata instead. (Overrides Activity.CacheMetadata(ActivityMetadata).)
Protected methodCacheMetadata(CodeActivityMetadata)Creates and validates a description of the activity’s arguments, variables, child activities, and activity delegates.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodExecuteWhen implemented in a derived class, performs the execution of the activity.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnCreateDynamicUpdateMapRaises an event when creating a map for the dynamic update. (Overrides Activity.OnCreateDynamicUpdateMap(UpdateMapMetadata, Activity).)
Public methodShouldSerializeDisplayNameIndicates whether the DisplayName property should be serialized. (Inherited from Activity.)
Public methodToStringReturns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)
Top

Derived classes can define a result value of the type specified in the type specifier of the class.

The following example shows how to derive a class from CodeActivity(Of TResult).

public sealed class Add : CodeActivity<int>
{
    public InArgument<int> X { get; set; }
    public InArgument<int> Y { get; set; }

    protected override int Execute(CodeActivityContext context)
    {
        int x = X.Get(context);
        int y = Y.Get(context);

        return x + y;
    }
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

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.

System.Object
  System.Activities.Activity
    System.Activities.ActivityWithResult
      System.Activities.Activity(Of TResult)
        System.Activities.CodeActivity(Of TResult)
          Microsoft.CSharp.Activities.CSharpReference(Of TResult)
          Microsoft.CSharp.Activities.CSharpValue(Of TResult)
          Microsoft.VisualBasic.Activities.VisualBasicReference(Of TResult)
          Microsoft.VisualBasic.Activities.VisualBasicValue(Of TResult)
          System.Activities.Expressions.Add(Of TLeft, TRight, TResult)
          System.Activities.Expressions.And(Of TLeft, TRight, TResult)
          System.Activities.Expressions.ArrayItemReference(Of TItem)
          System.Activities.Expressions.ArrayItemValue(Of TItem)
          System.Activities.Expressions.As(Of TOperand, TResult)
          System.Activities.Expressions.Cast(Of TOperand, TResult)
          System.Activities.Expressions.Divide(Of TLeft, TRight, TResult)
          System.Activities.Expressions.EnvironmentLocationReference(Of T)
          System.Activities.Expressions.EnvironmentLocationValue(Of T)
          System.Activities.Expressions.Equal(Of TLeft, TRight, TResult)
          System.Activities.Expressions.FieldReference(Of TOperand, TResult)
          System.Activities.Expressions.FieldValue(Of TOperand, TResult)
          System.Activities.Expressions.GreaterThan(Of TLeft, TRight, TResult)
          System.Activities.Expressions.GreaterThanOrEqual(Of TLeft, TRight, TResult)
          System.Activities.Expressions.IndexerReference(Of TOperand, TItem)
          System.Activities.Expressions.LambdaReference(Of T)
          System.Activities.Expressions.LambdaValue(Of TResult)
          System.Activities.Expressions.LessThan(Of TLeft, TRight, TResult)
          System.Activities.Expressions.LessThanOrEqual(Of TLeft, TRight, TResult)
          System.Activities.Expressions.Literal(Of T)
          System.Activities.Expressions.MultidimensionalArrayItemReference(Of TItem)
          System.Activities.Expressions.Multiply(Of TLeft, TRight, TResult)
          System.Activities.Expressions.New(Of TResult)
          System.Activities.Expressions.NewArray(Of TResult)
          System.Activities.Expressions.Not(Of TOperand, TResult)
          System.Activities.Expressions.NotEqual(Of TLeft, TRight, TResult)
          System.Activities.Expressions.Or(Of TLeft, TRight, TResult)
          System.Activities.Expressions.PropertyReference(Of TOperand, TResult)
          System.Activities.Expressions.PropertyValue(Of TOperand, TResult)
          System.Activities.Expressions.Subtract(Of TLeft, TRight, TResult)
          System.Activities.Expressions.ValueTypeFieldReference(Of TOperand, TResult)
          System.Activities.Expressions.ValueTypeIndexerReference(Of TOperand, TItem)
          System.Activities.Expressions.ValueTypePropertyReference(Of TOperand, TResult)
          System.Activities.Statements.ExistsInCollection(Of T)
          System.Activities.Statements.RemoveFromCollection(Of T)
          System.Activities.Validation.GetChildSubtree
          System.Activities.Validation.GetParentChain
          System.Activities.Validation.GetWorkflowTree
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft