Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IContractBehavior.ApplyClientBehavior Method

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

Namespace:  System.ServiceModel.Description
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
void ApplyClientBehavior(
	ContractDescription contractDescription,
	ServiceEndpoint endpoint,
	ClientRuntime clientRuntime


Type: System.ServiceModel.Description.ContractDescription

The contract description for which the extension is intended.

Type: System.ServiceModel.Description.ServiceEndpoint

The endpoint.

Type: System.ServiceModel.Dispatcher.ClientRuntime

The client runtime.

Implement the ApplyClientBehavior method to view, modify, or add custom extensions to the client runtime across all messages or for one specific operation. For details about what customizations you can do with a client run-time object, see ClientRuntime and ClientOperation.

The ApplyClientBehavior method can throw a NotImplementedException exception if the behavior is only intended for use in a service 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 ClientRuntime and that returned by the CallbackDispatchRuntime property.

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 the description as there are ClientOperation 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.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Store apps

Supported in: Windows 8

Windows Phone 8.1, Windows Phone 8, 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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft. All rights reserved.