CodeActivity<'TResult> Class

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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.

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

System.Object
  System.Activities.Activity
    System.Activities.ActivityWithResult
      System.Activities.Activity<'TResult>
        System.Activities.CodeActivity<'TResult>
          Microsoft.CSharp.Activities.CSharpReference<'TResult>
          Microsoft.CSharp.Activities.CSharpValue<'TResult>
          Microsoft.VisualBasic.Activities.VisualBasicReference<'TResult>
          Microsoft.VisualBasic.Activities.VisualBasicValue<'TResult>
          System.Activities.Expressions.Add<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.And<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.ArrayItemReference<'TItem>
          System.Activities.Expressions.ArrayItemValue<'TItem>
          System.Activities.Expressions.As<'TOperand, 'TResult>
          System.Activities.Expressions.Cast<'TOperand, 'TResult>
          System.Activities.Expressions.Divide<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.EnvironmentLocationReference<'T>
          System.Activities.Expressions.EnvironmentLocationValue<'T>
          System.Activities.Expressions.Equal<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.FieldReference<'TOperand, 'TResult>
          System.Activities.Expressions.FieldValue<'TOperand, 'TResult>
          System.Activities.Expressions.GreaterThan<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.GreaterThanOrEqual<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.IndexerReference<'TOperand, 'TItem>
          System.Activities.Expressions.LambdaReference<'T>
          System.Activities.Expressions.LambdaValue<'TResult>
          System.Activities.Expressions.LessThan<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.LessThanOrEqual<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.Literal<'T>
          System.Activities.Expressions.MultidimensionalArrayItemReference<'TItem>
          System.Activities.Expressions.Multiply<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.New<'TResult>
          System.Activities.Expressions.NewArray<'TResult>
          System.Activities.Expressions.Not<'TOperand, 'TResult>
          System.Activities.Expressions.NotEqual<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.Or<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.PropertyReference<'TOperand, 'TResult>
          System.Activities.Expressions.PropertyValue<'TOperand, 'TResult>
          System.Activities.Expressions.Subtract<'TLeft, 'TRight, 'TResult>
          System.Activities.Expressions.ValueTypeFieldReference<'TOperand, 'TResult>
          System.Activities.Expressions.ValueTypeIndexerReference<'TOperand, 'TItem>
          System.Activities.Expressions.ValueTypePropertyReference<'TOperand, 'TResult>
          System.Activities.Statements.ExistsInCollection<'T>
          System.Activities.Statements.RemoveFromCollection<'T>
          System.Activities.Validation.GetChildSubtree
          System.Activities.Validation.GetParentChain
          System.Activities.Validation.GetWorkflowTree

[<AbstractClass>]
type CodeActivity<'TResult> = 
    class
        inherit Activity<'TResult>
    end

Type Parameters

TResult

The result returned by the activity.

NameDescription
System_CAPS_protmethodCodeActivity<'TResult>()

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

NameDescription
System_CAPS_protpropertyCacheId

Gets the identifier of the cache that is unique within the scope of the workflow definition.(Inherited from Activity.)

System_CAPS_protpropertyConstraints

Gets a collection of Constraint activities that can be configured to provide validation for the Activity.(Inherited from Activity.)

System_CAPS_pubpropertyDisplayName

Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking.(Inherited from Activity.)

System_CAPS_pubpropertyId

Gets an identifier that is unique in the scope of the workflow definition.(Inherited from Activity.)

System_CAPS_protpropertyImplementation

Not supported.(Overrides Activity.Implementation.)

System_CAPS_protpropertyImplementationVersion

Gets or sets the implementation version of the activity.(Overrides Activity.ImplementationVersion.)

System_CAPS_pubpropertyResult

Gets or sets the result argument for the Activity<'TResult>.(Inherited from Activity<'TResult>.)

System_CAPS_pubpropertyResultType

When implemented in a derived class, gets the type of an activity OutArgument.(Inherited from ActivityWithResult.)

NameDescription
System_CAPS_protmethodCacheMetadata(ActivityMetadata)

Not implemented. Use CacheMetadata instead.(Overrides Activity.CacheMetadata(ActivityMetadata).)

System_CAPS_protmethodCacheMetadata(CodeActivityMetadata)

Creates and validates a description of the activity’s arguments, variables, child activities, and activity delegates.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodExecute(CodeActivityContext)

When implemented in a derived class, performs the execution of the activity.

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnCreateDynamicUpdateMap(UpdateMapMetadata, Activity)

Raises an event when creating a map for the dynamic update.(Overrides Activity.OnCreateDynamicUpdateMap(UpdateMapMetadata, Activity).)

System_CAPS_pubmethodShouldSerializeDisplayName()

Indicates whether the DisplayName property should be serialized.(Inherited from Activity.)

System_CAPS_pubmethodToString()

Returns a String that contains the Id and DisplayName of the Activity.(Inherited from Activity.)

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<'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
Available since 4.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: