This documentation is archived and is not being maintained.

IContractBehavior.ApplyDispatchBehavior Method

Implements a modification or extension of the client across a contract.

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

void ApplyDispatchBehavior(
	ContractDescription contractDescription,
	ServiceEndpoint endpoint,
	DispatchRuntime dispatchRuntime


Type: System.ServiceModel.Description.ContractDescription
The contract description to be modified.
Type: System.ServiceModel.Description.ServiceEndpoint
The endpoint that exposes the contract.
Type: System.ServiceModel.Dispatcher.DispatchRuntime
The dispatch runtime that controls service execution.

Implement the ApplyDispatchBehavior to view, modify, or add custom extensions to the service runtime across all messages in a specific contract or for one specific operation in that contract. For details about what customizations you can perform in a service application, see DispatchRuntime and DispatchOperation.

The ApplyDispatchBehavior method can throw a NotImplementedException exception if the behavior is only intended for use in a client application.

This method is called once for each endpoint that uses the specified service contract.

Note that there can be two operations with the same name in the description (one in each direction), so if you must iterate through operations where the contract is a duplex contract, you must correlate the message direction between the endpoint DispatchRuntime and that returned by the CallbackClientRuntime property.

In addition, because other behaviors may have already added or removed some operations from the runtime, there is no guarantee that there are the same number of operations in description as there are DispatchOperation objects in the Operations property.

The following code example assumes a custom IInstanceProvider implementation called ObjectProviderBehavior that provides a "singleton" behavior; it always returns the same service instance and does not recycle it.

To insert the instance provider customization, the example shows how to implement a custom attribute (SingletonBehaviorAttribute) that implements IContractBehavior to insert the custom service instance provider. It also implements IContractBehaviorAttribute, which binds its use to the ISampleService contract.

public class SingletonBehaviorAttribute : Attribute, IContractBehaviorAttribute, IContractBehavior

  #region IContractBehaviorAttribute Members

  public Type TargetContract
    get { return typeof(ISampleService); }


  #region IContractBehavior Members

  public void AddBindingParameters(ContractDescription description, ServiceEndpoint endpoint, System.ServiceModel.Channels.BindingParameterCollection parameters)

  public void ApplyClientBehavior(ContractDescription description, ServiceEndpoint endpoint, ClientRuntime clientRuntime)

  public void ApplyDispatchBehavior(ContractDescription description, ServiceEndpoint endpoint, DispatchRuntime dispatch)
    dispatch.InstanceProvider = new ObjectProviderBehavior("Custom ObjectProviderBehavior constructor.");

  public void Validate(ContractDescription description, ServiceEndpoint endpoint)


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.