NativeActivity<TResult> Class

Abstract base class for custom activities that implement execution logic using the Execute method, that has full access to the runtime’s features.

System.Object
  System.Activities.Activity
    System.Activities.ActivityWithResult
      System.Activities.Activity<TResult>
        System.Activities.NativeActivity<TResult>
          More...

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

public abstract class NativeActivity<TResult> : Activity<TResult>

Type Parameters

TResult

The result returned by the activity.

The NativeActivity<TResult> type exposes the following members.

  NameDescription
Protected methodNativeActivity<TResult>When implemented in a derived class, creates a new 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 propertyCanInduceIdleGets or sets a value that indicates whether the activity can cause the workflow to become idle.
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 propertyImplementationThe execution logic of the activity. (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<TResult>. (Inherited from Activity<TResult>.)
Public propertyResultTypeWhen implemented in a derived class, gets the type of an activity OutArgument. (Inherited from ActivityWithResult.)
Top

  NameDescription
Protected methodAbortWhen implemented in a derived class, takes actions in response to the activity being aborted.
Protected methodCacheMetadata(ActivityMetadata)Not implemented. Use CacheMetadata instead. (Overrides Activity.CacheMetadata(ActivityMetadata).)
Protected methodCacheMetadata(NativeActivityMetadata)Creates and validates a description of the activity’s arguments, variables, child activities, and activity delegates.
Protected methodCancelWhen implemented in a derived class, runs logic to cause graceful early completion of the activity.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodExecuteWhen implemented in a derived class, runs the activity’s execution logic.
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 methodOnCreateDynamicUpdateMap(NativeActivityUpdateMapMetadata, Activity)Raises an event when creating a map for the dynamic update.
Protected methodOnCreateDynamicUpdateMap(UpdateMapMetadata, Activity)Raises 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.)
Protected methodUpdateInstanceUpdates the instance of NativeActivity<TResult>.
Top

The following code sample demonstrates creating a class that inherits from NativeActivity<TResult>. This example is from the How To: Create an Activity step of the Getting Started Tutorial.

public sealed class ReadInt : NativeActivity<int>
{
    [RequiredArgument]
    public InArgument<string> BookmarkName { get; set; }

    protected override void Execute(NativeActivityContext context)
    {
        string name = BookmarkName.Get(context);

        if (name == string.Empty)
        {
            throw new ArgumentException("BookmarkName cannot be an Empty string.",
                "BookmarkName");
        }

        context.CreateBookmark(name, new BookmarkCallback(OnReadComplete));
    }

    // NativeActivity derived activities that do asynchronous operations by calling  
    // one of the CreateBookmark overloads defined on System.Activities.NativeActivityContext  
    // must override the CanInduceIdle property and return true. 
    protected override bool CanInduceIdle
    {
        get { return true; }
    }

    void OnReadComplete(NativeActivityContext context, Bookmark bookmark, object state)
    {
        this.Result.Set(context, Convert.ToInt32(state));
    }
}

.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<TResult>
        System.Activities.NativeActivity<TResult>
          System.Activities.Expressions.InvokeFunc<TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, T7, T8, T9, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, TResult>
          System.Activities.Expressions.InvokeFunc<T, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, T7, TResult>
          System.Activities.Expressions.InvokeFunc<T1, T2, T3, T4, T5, T6, T7, T8, TResult>
          System.Activities.Statements.CompensableActivity
          System.Activities.Statements.CreateBookmarkScope
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft