.NET Framework Class Library
OperationBehaviorAttribute Class

Specifies the local execution behavior of a service method.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ServiceModelOperationBehaviorAttribute

Namespace:   System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
Syntax
<[%$TOPIC/ms576447_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/ms576447_en-us_VS_110_2_0_0_0_1%].Method)> _
Public NotInheritable Class OperationBehaviorAttribute _
	Inherits [%$TOPIC/ms576447_en-us_VS_110_2_0_0_0_2%] _
	Implements [%$TOPIC/ms576447_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/ms576447_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/ms576447_en-us_VS_110_2_0_1_0_1%].Method)]
public sealed class OperationBehaviorAttribute : [%$TOPIC/ms576447_en-us_VS_110_2_0_1_0_2%], 
	[%$TOPIC/ms576447_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/ms576447_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/ms576447_en-us_VS_110_2_0_2_0_1%]::Method)]
public ref class OperationBehaviorAttribute sealed : public [%$TOPIC/ms576447_en-us_VS_110_2_0_2_0_2%], 
	[%$TOPIC/ms576447_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/ms576447_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/ms576447_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/ms576447_en-us_VS_110_2_0_3_0_2%].Method)>]
type OperationBehaviorAttribute =  
    class 
        inherit [%$TOPIC/ms576447_en-us_VS_110_2_0_3_0_3%] 
        interface [%$TOPIC/ms576447_en-us_VS_110_2_0_3_0_4%] 
    end
public final class OperationBehaviorAttribute extends [%$TOPIC/ms576447_en-us_VS_110_2_0_4_0_0%] implements [%$TOPIC/ms576447_en-us_VS_110_2_0_4_0_1%]

The OperationBehaviorAttribute type exposes the following members.

Constructors
  NameDescription
Public method OperationBehaviorAttributeInitializes a new instance of the OperationBehaviorAttribute class.
Top
Properties
  NameDescription
Public property AutoDisposeParametersGets or sets whether parameters are to be automatically disposed.
Public property ImpersonationGets or sets a value that indicates the level of caller impersonation that the operation supports.
Public property ReleaseInstanceModeGets or sets a value that indicates when in the course of an operation invocation to recycle the service object.
Public property TransactionAutoCompleteGets or sets a value that indicates whether to automatically complete the current transaction scope if no unhandled exceptions occur.
Public property TransactionScopeRequiredGets or sets a value that indicates whether the method requires a transaction scope for its execution.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Explicit interface implemetation Private method IOperationBehaviorAddBindingParametersImplements the AddBindingParameters method.
Explicit interface implemetation Private method IOperationBehaviorApplyClientBehaviorImplements the client operation behavior.
Explicit interface implemetation Private method IOperationBehaviorApplyDispatchBehaviorImplements the service operation behavior.
Explicit interface implemetation Private method IOperationBehaviorValidateImplements the validation behavior.
Top
Remarks

Use the OperationBehaviorAttribute attribute to indicate what operation-specific execution behavior the operation has when executed. (To specify execution behavior at the service level, use the ServiceBehaviorAttribute attribute.)

NoteNote

You can also use OperationBehaviorAttribute to configure a callback contract operation in a duplex client application. When used on a callback operation, the ReleaseInstanceMode property must be None or an InvalidOperationException exception is thrown at runtime.

The OperationBehaviorAttribute attribute is a Windows Communication Foundation (WCF) programming model feature that enables common features that developers otherwise must implement themselves.

  • The AutoDisposeParameters property controls whether parameter objects passed to an operation are disposed when the operation completes.

  • The TransactionAutoComplete property specifies whether the transaction in which the method executes is automatically committed if no unhandled exceptions occur.

  • The TransactionScopeRequired property specifies whether a method must execute within a transaction.

  • The Impersonation property specifies whether the service operation can, must, or cannot impersonate the caller's identity.

  • The ReleaseInstanceMode property specifies when service objects are recycled during the method invocation process.

Examples

The following code example shows an operation that executes within a mandatory distributed transaction. The TransactionScopeRequired property indicates that the method executes under the caller's transaction and the TransactionAutoComplete property indicates that if no unhandled exceptions occur, the transaction commits automatically. If an unhandled exception does occur, the transaction is aborted.

Imports System.ServiceModel
Imports System.Transactions

Namespace Microsoft.WCF.Documentation
  <ServiceContract(Namespace:="http://microsoft.wcf.documentation", SessionMode:=SessionMode.Required)> _
  Public Interface IBehaviorService
	<OperationContract> _
	Function TxWork(ByVal message As String) As String 
  End Interface 

    ' Note: To use the TransactionIsolationLevel property, you  
    ' must add a reference to the System.Transactions.dll assembly. 
    ' The following service implementation: 
    '   *   -- Processes messages on one thread at a time 
    '   *   -- Creates one service object per session 
    '   *   -- Releases the service object when the transaction commits

    <ServiceBehavior(ConcurrencyMode:=ConcurrencyMode.Single, InstanceContextMode:=InstanceContextMode.PerSession, _
                     ReleaseServiceInstanceOnTransactionComplete:=True)> _
    Public Class BehaviorService
        Implements IBehaviorService, IDisposable
        Private myID As Guid

        Public Sub New()
            myID = Guid.NewGuid()
            Console.WriteLine("Object " & myID.ToString() & " created.")
        End Sub 

        '     
        '     * The following operation-level behaviors are specified: 
        '     *   -- Always executes under a transaction scope. 
        '     *   -- The transaction scope is completed when the operation terminates  
        '     *       without an unhandled exception. 
        '     
        <OperationBehavior(TransactionAutoComplete:=True, TransactionScopeRequired:=True), _
        TransactionFlow(TransactionFlowOption.Mandatory)> _
        Public Function TxWork(ByVal message As String) As String Implements IBehaviorService.TxWork
            ' Do some transactable work.
            Console.WriteLine("TxWork called with: " & message)
            ' Display transaction information. 

            Dim info As TransactionInformation = Transaction.Current.TransactionInformation
            Console.WriteLine("The distributed tx ID: {0}.", info.DistributedIdentifier)
            Console.WriteLine("The tx status: {0}.", info.Status)
            Return String.Format("Hello. This was object {0}.", myID.ToString())
        End Function 

        Public Sub Dispose() Implements IDisposable.Dispose
            Console.WriteLine("Service " & myID.ToString() & " is being recycled.")
        End Sub 
    End Class 
End Namespace
using System;
using System.ServiceModel;
using System.Transactions;

namespace Microsoft.WCF.Documentation
{
  [ServiceContract(Namespace="http://microsoft.wcf.documentation", SessionMode=SessionMode.Required)]
  public interface IBehaviorService
  {
    [OperationContract]
    string TxWork(string message);
  }

  // Note: To use the TransactionIsolationLevel property, you  
  // must add a reference to the System.Transactions.dll assembly. 
  /* The following service implementation:
   *   -- Processes messages on one thread at a time
   *   -- Creates one service object per session
   *   -- Releases the service object when the transaction commits
   */
  [ServiceBehavior(
    ConcurrencyMode=ConcurrencyMode.Single,
    InstanceContextMode=InstanceContextMode.PerSession,
    ReleaseServiceInstanceOnTransactionComplete=true
  )]
  public class BehaviorService : IBehaviorService, IDisposable
  {
    Guid myID;

    public BehaviorService()
    {
      myID = Guid.NewGuid();
      Console.WriteLine(
        "Object "
        + myID.ToString()
        + " created.");
    }

    /*
     * The following operation-level behaviors are specified:
     *   -- Always executes under a transaction scope.
     *   -- The transaction scope is completed when the operation terminates 
     *       without an unhandled exception.
     */
    [OperationBehavior(
      TransactionAutoComplete = true,
      TransactionScopeRequired = true
    )]
    [TransactionFlow(TransactionFlowOption.Mandatory)]
    public string TxWork(string message)
    {
      // Do some transactable work.
      Console.WriteLine("TxWork called with: " + message);
      // Display transaction information.

      TransactionInformation info = Transaction.Current.TransactionInformation;
      Console.WriteLine("The distributed tx ID: {0}.", info.DistributedIdentifier);
      Console.WriteLine("The tx status: {0}.", info.Status);
      return String.Format("Hello. This was object {0}.",myID.ToString()) ;
    }

    public void Dispose()
    {
      Console.WriteLine(
        "Service "
        + myID.ToString()
        + " is being recycled."
      );
    }
  }
}
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.