WorkflowControlClient Class

WorkflowControlClient Class

.NET Framework (current version)
 

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

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

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

public class WorkflowControlClient : ClientBase<IWorkflowInstanceManagement>

NameDescription
System_CAPS_pubmethodWorkflowControlClient()

Initializes a new instance of the WorkflowControlClient class.

System_CAPS_pubmethodWorkflowControlClient(Binding, EndpointAddress)

Initializes a new instance of the WorkflowControlClient class with the specified binding, and T:System.ServiecModel.Activities.WorkflowControlEndpoint.

System_CAPS_pubmethodWorkflowControlClient(String)

Initializes a new instance of the WorkflowControlClient class with the specified endpoint configuration.

System_CAPS_pubmethodWorkflowControlClient(String, EndpointAddress)

Initializes a new instance of the WorkflowControlClient class with the specified endpoint configuration and EndpointAddress.

System_CAPS_pubmethodWorkflowControlClient(String, String)

Initializes a new instance of the WorkflowControlClient class with the specified endpoint configuration and endpoint address.

System_CAPS_pubmethodWorkflowControlClient(WorkflowControlEndpoint)

Initializes a new instance of the WorkflowControlClient class with the specified T:System.ServiecModel.Activities.WorkflowControlEndpoint.

NameDescription
System_CAPS_protpropertyChannel

Gets the inner channel used to send messages to variously configured service endpoints.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubpropertyChannelFactory

Gets the underlying ChannelFactory<TChannel> object.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubpropertyClientCredentials

Gets the client credentials used to call an operation.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubpropertyEndpoint

Gets the target endpoint for the service to which the WCF client can connect.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubpropertyInnerChannel

Gets the underlying IClientChannel implementation.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubpropertyState

Gets the current state of the ClientBase<TChannel> object.(Inherited from ClientBase<TChannel>.)

NameDescription
System_CAPS_pubmethodAbandon(Guid)

Abandons the specified workflow instance.

System_CAPS_pubmethodAbandon(Guid, String)

Abandons the specified workflow instance.

System_CAPS_pubmethodAbandonAsync(Guid)

Begins an asynchronous operation that abandons the specified workflow instance.

System_CAPS_pubmethodAbandonAsync(Guid, Object)

Begins an asynchronous operation that abandons the specified workflow instance with the specified user-defined data.

System_CAPS_pubmethodAbandonAsync(Guid, String)

Begins an asynchronous operation that abandons the specified workflow instance with the specified reason.

System_CAPS_pubmethodAbandonAsync(Guid, String, Object)

Begins an asynchronous operation that abandons the specified workflow instance with the specified reason and user-defined data.

System_CAPS_pubmethodAbort()

Causes the ClientBase<TChannel> object to transition immediately from its current state into the closed state.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubmethodBeginAbandon(Guid, AsyncCallback, Object)

Begins an asynchronous operation that abandons the specified workflow instance.

System_CAPS_pubmethodBeginAbandon(Guid, String, AsyncCallback, Object)

Begins an asynchronous operation that abandons the specified workflow instance.

System_CAPS_pubmethodBeginCancel(Guid, AsyncCallback, Object)

Begins an asynchronous operation that cancels the specified workflow instance.

System_CAPS_pubmethodBeginRun(Guid, AsyncCallback, Object)

Begins an asynchronous operation that runs the specified workflow instance.

System_CAPS_pubmethodBeginSuspend(Guid, AsyncCallback, Object)

Begins an asynchronous operation that suspends the specified operation.

System_CAPS_pubmethodBeginSuspend(Guid, String, AsyncCallback, Object)

Begins an asynchronous operation that suspends the specified operation.

System_CAPS_pubmethodBeginTerminate(Guid, AsyncCallback, Object)

Begins an asynchronous operation that terminates a workflow instance.

System_CAPS_pubmethodBeginTerminate(Guid, String, AsyncCallback, Object)

Begins an asynchronous operation that terminates a workflow instance.

System_CAPS_pubmethodBeginUnsuspend(Guid, AsyncCallback, Object)

Begins an asynchronous operation that unsuspends a workflow instance.

System_CAPS_pubmethodCancel(Guid)

Cancels the specified workflow instance.

System_CAPS_pubmethodCancelAsync(Guid)

Begins an asynchronous operation that cancels the specified workflow instance.

System_CAPS_pubmethodCancelAsync(Guid, Object)

Begins an asynchronous operation that cancels the specified workflow instance with the specified user-defined data.

System_CAPS_pubmethodClose()

Causes the ClientBase<TChannel> object to transition from its current state into the closed state.(Inherited from ClientBase<TChannel>.)

System_CAPS_protmethodCreateChannel()

Returns a new channel to the service.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubmethodDisplayInitializationUI()

Instructs the inner channel to display a user interface if one is required to initialize the channel prior to using it.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubmethodEndAbandon(IAsyncResult)

Completes an asynchronous abandon operation.

System_CAPS_pubmethodEndCancel(IAsyncResult)

Completes an asynchronous cancel operation.

System_CAPS_pubmethodEndRun(IAsyncResult)

Completes an asynchronous run operation.

System_CAPS_pubmethodEndSuspend(IAsyncResult)

Completes an asynchronous suspend operation.

System_CAPS_pubmethodEndTerminate(IAsyncResult)

Completes an asynchronous terminate operation.

System_CAPS_pubmethodEndUnsuspend(IAsyncResult)

Completes an asynchronous unsuspend operation.

System_CAPS_pubmethodEquals(Object)

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

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_protmethodGetDefaultValueForInitialization<T>()

Replicates the behavior of the default keyword in C#.(Inherited from ClientBase<TChannel>.)

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_protmethodInvokeAsync(ClientBase<TChannel>.BeginOperationDelegate, Object[], ClientBase<TChannel>.EndOperationDelegate, SendOrPostCallback, Object)

Provides support for implementing the event-based asynchronous pattern. For more information about this pattern, see Event-based Asynchronous Pattern Overview.(Inherited from ClientBase<TChannel>.)

System_CAPS_protmethodMemberwiseClone()

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

System_CAPS_pubmethodOpen()

Causes the ClientBase<TChannel> object to transition from the created state into the opened state.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubmethodRun(Guid)

Runs the specified workflow instance.

System_CAPS_pubmethodRunAsync(Guid)

Begins an asynchronous operation that runs the specified workflow instance.

System_CAPS_pubmethodRunAsync(Guid, Object)

Begins an asynchronous operation that runs the specified workflow instance with the user-defined state data.

System_CAPS_pubmethodSuspend(Guid)

Suspends the specified workflow instance.

System_CAPS_pubmethodSuspend(Guid, String)

Suspends the specified workflow instance.

System_CAPS_pubmethodSuspendAsync(Guid)

Begins an asynchronous suspend operation

System_CAPS_pubmethodSuspendAsync(Guid, Object)

Begins an asynchronous suspend operation with the specified workflow instance ID and user-defined state data.

System_CAPS_pubmethodSuspendAsync(Guid, String)

Begins an asynchronous suspend operation with the specified workflow instance ID and reason.

System_CAPS_pubmethodSuspendAsync(Guid, String, Object)

Begins an asynchronous suspend operation with the specified workflow instance ID, reason, and user-defined state data.

System_CAPS_pubmethodTerminate(Guid)

Terminates the specified workflow instance.

System_CAPS_pubmethodTerminate(Guid, String)

Terminates the specified workflow instance with the specified reason.

System_CAPS_pubmethodTerminateAsync(Guid)

Begins an asynchronous operation that terminates the specified workflow instance.

System_CAPS_pubmethodTerminateAsync(Guid, Object)

Begins an asynchronous operation that terminates the specified workflow instance with the specified user-defined data.

System_CAPS_pubmethodTerminateAsync(Guid, String)

Begins an asynchronous operation that terminates the specified workflow instance with the specified reason.

System_CAPS_pubmethodTerminateAsync(Guid, String, Object)

Begins an asynchronous operation that terminates the specified workflow instance with the specified reason and user-defined data.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodUnsuspend(Guid)

Unsuspends the specified workflow instance.

System_CAPS_pubmethodUnsuspendAsync(Guid)

Begins an asynchronous unsuspend operation.

System_CAPS_pubmethodUnsuspendAsync(Guid, Object)

Begins an asynchronous unsuspend operation with the specified user-defined state data.

NameDescription
System_CAPS_pubeventAbandonCompleted

Occurs when an asynchronous abandon operation completes.

System_CAPS_pubeventCancelCompleted

Occurs when an asynchronous cancel operation completes.

System_CAPS_pubeventRunCompleted

Occurs when an asynchronous run operation completes.

System_CAPS_pubeventSuspendCompleted

Occurs when an asynchronous suspend operation completes.

System_CAPS_pubeventTerminateCompleted

Occurs when an asynchronous terminate operation completes.

System_CAPS_pubeventUnsuspendCompleted

Occurs when an asynchronous unsuspend operation completes.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_priveventICommunicationObject.Closed

The event handler that is invoked when the ClientBase<TChannel> object has transitioned from its current state to the closed state.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_priveventICommunicationObject.Closing

The event handler that is invoked when the ClientBase<TChannel> object transitions from its current state to the closed state.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_priveventICommunicationObject.Faulted

The event handler that is invoked when a fault occurs while performing an operation on the ClientBase<TChannel> object.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_priveventICommunicationObject.Opened

The event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_priveventICommunicationObject.Opening

The event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDisposable.Dispose()

Explicit implementation of the Dispose method.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.BeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close the ClientBase<TChannel>.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close the ClientBase<TChannel> with a specified timeout.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.BeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open the ClientBase<TChannel> object.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open the ClientBase<TChannel> object within a specified interval of time.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.Close(TimeSpan)

Causes the ClientBase<TChannel> object to transition from its current state into the closed state.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.EndClose(IAsyncResult)

Completes an asynchronous operation to close the ClientBase<TChannel> object.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.EndOpen(IAsyncResult)

Completes an asynchronous operation to open the ClientBase<TChannel> object.(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.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>.)

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
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:
© 2016 Microsoft