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

OperationContractGenerationContext Class

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

System.Object
  System.ServiceModel.Description.OperationContractGenerationContext

Namespace:  System.ServiceModel.Description
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public class OperationContractGenerationContext

The OperationContractGenerationContext type exposes the following members.

  NameDescription
Public methodOperationContractGenerationContext(ServiceContractGenerator, ServiceContractGenerationContext, OperationDescription, CodeTypeDeclaration, CodeMemberMethod)Initializes a new instance of the OperationContractGenerationContext class using the specified contract generator, contract context, operation description, code type declaration, and method.
Public methodOperationContractGenerationContext(ServiceContractGenerator, ServiceContractGenerationContext, OperationDescription, CodeTypeDeclaration, CodeMemberMethod, CodeMemberMethod, CodeMemberMethod)Initializes a new instance of the OperationContractGenerationContext class.
Top
  NameDescription
Public propertyBeginMethodGets the System.CodeDom.CodeMemberMethod for the asynchronous begin operation.
Public propertyContractGets the code generation context for the service contract.
Public propertyDeclaringTypeGets the declaring type for the current operation.
Public propertyEndMethodGets the asynchronous end operation declaration.
Public propertyIsAsyncGets a value that indicates whether asynchronous methods are generated for the current operation.
Public propertyOperationGets the System.ServiceModel.Description.OperationDescription for the current operation.
Public propertyServiceContractGeneratorGets the System.ServiceModel.Description.ServiceContractGenerator that generates the current operation.
Public propertySyncMethodGets the System.CodeDom.CodeMemberMethod for the synchronous operation.
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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);
}




'''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")>  _
    Function Compute(ByVal num As Integer) As Integer

    '''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")>  _
    Function GetPerson(ByVal FirstParameter As Integer, ByVal SecondParameter As Integer) As Microsoft.WCF.Documentation.Person
End Interface


.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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.