NativeActivity.Cancel(NativeActivityContext) NativeActivity.Cancel(NativeActivityContext) NativeActivity.Cancel(NativeActivityContext) NativeActivity.Cancel(NativeActivityContext) Method

Definition

Namespace:
System.Activities System.Activities System.Activities System.Activities
Assembly:
System.Activities.dll

When implemented in a derived class, runs logic to cause graceful early completion of the activity.

protected:
 virtual void Cancel(System::Activities::NativeActivityContext ^ context);
protected virtual void Cancel (System.Activities.NativeActivityContext context);
abstract member Cancel : System.Activities.NativeActivityContext -> unit
override this.Cancel : System.Activities.NativeActivityContext -> unit
Protected Overridable Sub Cancel (context As NativeActivityContext)

Parameters

context
NativeActivityContext NativeActivityContext NativeActivityContext NativeActivityContext

The execution context in which the activity executes.

Examples

The following code sample demonstrates using Cancel in a class that inherits from NativeActivity<TResult>. This example is from the Non-Generic ParallelForEach sample. 

protected override void Cancel(NativeActivityContext context)
{
    // If we don't have a completion condition then we can just
    // use default logic.
    if (this.CompletionCondition == null)
    {
        base.Cancel(context);
    }
    else
    {
        context.CancelChildren();
    }
}

Applies to