Export (0) Print
Expand All

OperationContractGenerationContext Class

Passed to the IOperationContractGenerationExtension.GenerateOperation method to enable the modification of an operation contract and its context prior to generating code.

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

public class OperationContractGenerationContext

Use the OperationContractGenerationContext object passed to the IOperationContractGenerationExtension.GenerateOperation method to modify the code document object model prior to the generation of code. Typically, the System.ServiceModel.Description.IOperationContractGenerationExtension interface is implemented on a custom System.ServiceModel.Description.IWsdlImportExtension implementation that is used to import custom WSDL elements or otherwise modify the code at the service or operation level. To modify the code at the service level, see System.ServiceModel.Description.IServiceContractGenerationExtension.

The following example shows the use of the OperationContractGenerationContext object passed to the IOperationContractGenerationExtension.GenerateOperation method to add code comments extracted from custom WSDL elements.

public void GenerateOperation(OperationContractGenerationContext context)
{
  context.SyncMethod.Comments.AddRange(Formatter.FormatComments(commentText));
  Console.WriteLine("In generate operation.");
}

The following code example shows the resulting code comments.

/// From WSDL Documentation: 
///  
/// <summary>This contract is a stateless contract that provides a mechanism for  
/// computing the nth Fibonacci term.</summary>  
/// 
[System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
[System.ServiceModel.ServiceContractAttribute(Namespace="http://microsoft.wcf.documentation", ConfigurationName="IFibonacci")]
public interface IFibonacci
{

    /// From WSDL Documentation: 
    ///  
    /// <summary>The Compute operation returns the nth Fibonacci number.  Because it  
    /// uses dual recursion it's very inefficient and therefore useful to demonstrate  
    /// caching.</summary><returns>The nth Fibonacci number.</returns><param  
    /// name="num">The value to use when computing the Fibonacci number.</param> 
    /// 
    [System.ServiceModel.OperationContractAttribute(Action="http://microsoft.wcf.documentation/IFibonacci/Compute", ReplyAction="http://microsoft.wcf.documentation/IFibonacci/ComputeResponse")]
    int Compute(int num);

    /// From WSDL Documentation: 
    ///  
    /// <summary>The GetPerson operation tests custom WSDL documentation  
    /// generation.</summary><returns>The Person object to be returned.</returns><param  
    /// name="FirstParameter">The value for the first parameter.</param><param 
    /// name="SecondParameter">The value for the second parameter.</param> 
    /// 
    [System.ServiceModel.OperationContractAttribute(Action="http://microsoft.wcf.documentation/IFibonacci/GetPerson", ReplyAction="http://microsoft.wcf.documentation/IFibonacci/GetPersonResponse")]
    Microsoft.WCF.Documentation.Person GetPerson(int FirstParameter, int SecondParameter);
}

System.Object
  System.ServiceModel.Description.OperationContractGenerationContext

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

.NET Framework

Supported in: 3.5, 3.0

Community Additions

ADD
Show:
© 2014 Microsoft