Export (0) Print
Expand All

WorkflowInstance.WorkflowInstanceControl Structure

Provides methods for WorkflowInstance derived classes to access the functionality of the workflow runtime.

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

'Declaration
Protected Structure WorkflowInstanceControl

The WorkflowInstance.WorkflowInstanceControl type exposes the following members.

  NameDescription
Public propertyHasPendingTrackingRecordsCalled by the workflow runtime to determine whether this workflow instance has pending tracking records and a tracking participant.
Public propertyIsPersistableGets a value that indicates whether the WorkflowInstance is in a state where it can be persisted.
Public propertyStateGets the state of the WorkflowInstance.
Public propertyTrackingEnabledCalled by the workflow runtime to determine whether tracking is enabled in this workflow instance.
Top

  NameDescription
Public methodAbortAborts the WorkflowInstance.
Public methodAbort(Exception)Aborts the WorkflowInstance using the specified exception.
Public methodBeginFlushTrackingRecordsCalled by the workflow runtime to begin sending pending tracking records to tracking participants asynchronously.
Public methodEndFlushTrackingRecordsCalled by the workflow runtime to end the track operation.
Public methodEqualsReturns a value that indicates whether the current WorkflowInstance.WorkflowInstanceControl is equal to the specified object. (Overrides ValueType.Equals(Object).)
Public methodFlushTrackingRecordsCalled by the workflow runtime to send pending tracking records to tracking participants.
Public methodGetAbortReasonReturns the exception that causes the WorkflowInstance to abort.
Public methodGetBookmarksReturns the collection of available bookmarks for the WorkflowInstance.
Public methodGetBookmarks(BookmarkScope)Returns the collection of available bookmarks for the WorkflowInstance created in the specified BookmarkScope.
Public methodGetCompletionStateReturns the final ActivityInstanceState of the WorkflowInstance.
Public methodGetCompletionState(Exception)Returns the final ActivityInstanceState of the WorkflowInstance, including termination exception.
Public methodGetCompletionState(IDictionary(Of String, Object), Exception)Returns the final ActivityInstanceState of the WorkflowInstance, including workflow outputs and termination exception.
Public methodGetHashCodeReturns the hash code for this WorkflowInstance.WorkflowInstanceControl. (Overrides ValueType.GetHashCode.)
Public methodGetMappedVariablesReturns a dictionary of variables in the current scope that have been specified with Mapped.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodPauseWhenPersistableRequests that the workflow runtime pause the WorkflowInstance at the next point of execution where it is possible to persist. Note that the scheduler queue may not be empty at this point.
Public methodPrepareForSerializationPrepares the WorkflowInstance state for serialization.
Public methodRequestPauseRequests that the scheduler stops.
Public methodRunInstructs the WorkflowInstance to begin execution.
Public methodScheduleBookmarkResumption(Bookmark, Object)Schedules a bookmark resumption with the specified value.
Public methodScheduleBookmarkResumption(Bookmark, Object, BookmarkScope)Schedules a Bookmark resumption from the specified BookmarkScope.
Public methodScheduleCancelSchedules the cancellation of the WorkflowInstance.
Public methodTerminateTransitions the WorkflowInstance into the terminal Faulted state using the specified exception.
Public methodToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)
Public methodTrackCalled by the workflow runtime to add the specified pending record to the list of pending records.
Top

  NameDescription
Public operatorStatic memberEqualityReturns a value that indicates whether two WorkflowInstance.WorkflowInstanceControl instances are equal.
Public operatorStatic memberInequalityReturns a value that indicates whether two WorkflowInstance.WorkflowInstanceControl instances are not equal.
Top

.NET Framework

Supported in: 4.6, 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.
Show:
© 2014 Microsoft