Export (0) Print
Expand All

WorkflowControlClient Class

Allows a client to send control operations to a workflow service hosted with WorkflowServiceHost.

System.Object
  System.ServiceModel.ClientBase<IWorkflowInstanceManagement>
    System.ServiceModel.Activities.WorkflowControlClient

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

public class WorkflowControlClient : ClientBase<IWorkflowInstanceManagement>

The WorkflowControlClient type exposes the following members.

  NameDescription
Public methodWorkflowControlClient()Initializes a new instance of the WorkflowControlClient class.
Public methodWorkflowControlClient(String)Initializes a new instance of the WorkflowControlClient class with the specified endpoint configuration.
Public methodWorkflowControlClient(WorkflowControlEndpoint)Initializes a new instance of the WorkflowControlClient class with the specified WorkflowControlEndpoint.
Public methodWorkflowControlClient(Binding, EndpointAddress)Initializes a new instance of the WorkflowControlClient class with the specified binding, and WorkflowControlEndpoint.
Public methodWorkflowControlClient(String, EndpointAddress)Initializes a new instance of the WorkflowControlClient class with the specified endpoint configuration and EndpointAddress.
Public methodWorkflowControlClient(String, String)Initializes a new instance of the WorkflowControlClient class with the specified endpoint configuration and endpoint address.
Top

  NameDescription
Protected propertyChannelGets the inner channel used to send messages to variously configured service endpoints. (Inherited from ClientBase<TChannel>.)
Public propertyChannelFactoryGets the underlying ChannelFactory<TChannel> object. (Inherited from ClientBase<TChannel>.)
Public propertyClientCredentialsGets the client credentials used to call an operation. (Inherited from ClientBase<TChannel>.)
Public propertyEndpointGets the target endpoint for the service to which the WCF client can connect. (Inherited from ClientBase<TChannel>.)
Public propertyInnerChannelGets the underlying IClientChannel implementation. (Inherited from ClientBase<TChannel>.)
Public propertyStateGets the current state of the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>.)
Top

  NameDescription
Public methodAbandon(Guid)Abandons the specified workflow instance.
Public methodAbandon(Guid, String)Abandons the specified workflow instance.
Public methodAbandonAsync(Guid)Begins an asynchronous operation that abandons the specified workflow instance.
Public methodAbandonAsync(Guid, Object)Begins an asynchronous operation that abandons the specified workflow instance with the specified user-defined data.
Public methodAbandonAsync(Guid, String)Begins an asynchronous operation that abandons the specified workflow instance with the specified reason.
Public methodAbandonAsync(Guid, String, Object)Begins an asynchronous operation that abandons the specified workflow instance with the specified reason and user-defined data.
Public methodAbortCauses the ClientBase<TChannel> object to transition immediately from its current state into the closed state. (Inherited from ClientBase<TChannel>.)
Public methodBeginAbandon(Guid, AsyncCallback, Object)Begins an asynchronous operation that abandons the specified workflow instance.
Public methodBeginAbandon(Guid, String, AsyncCallback, Object)Begins an asynchronous operation that abandons the specified workflow instance.
Public methodBeginCancelBegins an asynchronous operation that cancels the specified workflow instance.
Public methodBeginRunBegins an asynchronous operation that runs the specified workflow instance.
Public methodBeginSuspend(Guid, AsyncCallback, Object)Begins an asynchronous operation that suspends the specified operation.
Public methodBeginSuspend(Guid, String, AsyncCallback, Object)Begins an asynchronous operation that suspends the specified operation.
Public methodBeginTerminate(Guid, AsyncCallback, Object)Begins an asynchronous operation that terminates a workflow instance.
Public methodBeginTerminate(Guid, String, AsyncCallback, Object)Begins an asynchronous operation that terminates a workflow instance.
Public methodBeginUnsuspendBegins an asynchronous operation that unsuspends a workflow instance.
Public methodCancelCancels the specified workflow instance.
Public methodCancelAsync(Guid)Begins an asynchronous operation that cancels the specified workflow instance.
Public methodCancelAsync(Guid, Object)Begins an asynchronous operation that cancels the specified workflow instance with the specified user-defined data.
Public methodCloseCauses the ClientBase<TChannel> object to transition from its current state into the closed state. (Inherited from ClientBase<TChannel>.)
Protected methodCreateChannelReturns a new channel to the service. (Inherited from ClientBase<TChannel>.)
Public methodDisplayInitializationUIInstructs the inner channel to display a user interface if one is required to initialize the channel prior to using it. (Inherited from ClientBase<TChannel>.)
Public methodEndAbandonCompletes an asynchronous abandon operation.
Public methodEndCancelCompletes an asynchronous cancel operation.
Public methodEndRunCompletes an asynchronous run operation.
Public methodEndSuspendCompletes an asynchronous suspend operation.
Public methodEndTerminateCompletes an asynchronous terminate operation.
Public methodEndUnsuspendCompletes an asynchronous unsuspend operation.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGetDefaultValueForInitialization<T>Replicates the behavior of the default keyword in C#. (Inherited from ClientBase<TChannel>.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInvokeAsyncProvides support for implementing the event-based asynchronous pattern. For more information about this pattern, see Event-based Asynchronous Pattern Overview. (Inherited from ClientBase<TChannel>.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOpenCauses the ClientBase<TChannel> object to transition from the created state into the opened state. (Inherited from ClientBase<TChannel>.)
Public methodRunRuns the specified workflow instance.
Public methodRunAsync(Guid)Begins an asynchronous operation that runs the specified workflow instance.
Public methodRunAsync(Guid, Object)Begins an asynchronous operation that runs the specified workflow instance with the user-defined state data.
Public methodSuspend(Guid)Suspends the specified workflow instance.
Public methodSuspend(Guid, String)Suspends the specified workflow instance.
Public methodSuspendAsync(Guid)Begins an asynchronous suspend operation
Public methodSuspendAsync(Guid, Object)Begins an asynchronous suspend operation with the specified workflow instance ID and user-defined state data.
Public methodSuspendAsync(Guid, String)Begins an asynchronous suspend operation with the specified workflow instance ID and reason.
Public methodSuspendAsync(Guid, String, Object)Begins an asynchronous suspend operation with the specified workflow instance ID, reason, and user-defined state data.
Public methodTerminate(Guid)Terminates the specified workflow instance.
Public methodTerminate(Guid, String)Terminates the specified workflow instance with the specified reason.
Public methodTerminateAsync(Guid)Begins an asynchronous operation that terminates the specified workflow instance.
Public methodTerminateAsync(Guid, Object)Begins an asynchronous operation that terminates the specified workflow instance with the specified user-defined data.
Public methodTerminateAsync(Guid, String)Begins an asynchronous operation that terminates the specified workflow instance with the specified reason.
Public methodTerminateAsync(Guid, String, Object)Begins an asynchronous operation that terminates the specified workflow instance with the specified reason and user-defined data.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUnsuspendUnsuspends the specified workflow instance.
Public methodUnsuspendAsync(Guid)Begins an asynchronous unsuspend operation.
Public methodUnsuspendAsync(Guid, Object)Begins an asynchronous unsuspend operation with the specified user-defined state data.
Top

  NameDescription
Public eventAbandonCompletedOccurs when an asynchronous abandon operation completes.
Public eventCancelCompletedOccurs when an asynchronous cancel operation completes.
Public eventRunCompletedOccurs when an asynchronous run operation completes.
Public eventSuspendCompletedOccurs when an asynchronous suspend operation completes.
Public eventTerminateCompletedOccurs when an asynchronous terminate operation completes.
Public eventUnsuspendCompletedOccurs when an asynchronous unsuspend operation completes.
Top

  NameDescription
Explicit interface implemetationPrivate methodICommunicationObject.BeginClose(AsyncCallback, Object)Begins an asynchronous operation to close the ClientBase<TChannel>. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close the ClientBase<TChannel> with a specified timeout. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.BeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to open the ClientBase<TChannel> object within a specified interval of time. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.Close(TimeSpan)Causes the ClientBase<TChannel> object to transition from its current state into the closed state. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate eventICommunicationObject.ClosedThe event handler that is invoked when the ClientBase<TChannel> object has transitioned from its current state to the closed state. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate eventICommunicationObject.ClosingThe event handler that is invoked when the ClientBase<TChannel> object transitions from its current state to the closed state. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.EndCloseCompletes an asynchronous operation to close the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.EndOpenCompletes an asynchronous operation to open the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate eventICommunicationObject.FaultedThe event handler that is invoked when a fault occurs while performing an operation on the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.Open(TimeSpan)Causes the ClientBase<TChannel> object to transition from the created state into the opened state within a specified interval of time. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate eventICommunicationObject.OpenedThe event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate eventICommunicationObject.OpeningThe event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodIDisposable.DisposeExplicit implementation of the Dispose method. (Inherited from ClientBase<TChannel>.)
Top

Use this class to control a workflow instance.

The following example shows how to create a suspended workflow instance and use the WorkflowControlClient class to resume the workflow.

.NET Framework

Supported in: 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