OperationContractGenerationContext Class

Reference

Definition

Namespace:: System.ServiceModel.Description

Assembly:: System.ServiceModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class OperationContractGenerationContext

public class OperationContractGenerationContext

type OperationContractGenerationContext = class

Public Class OperationContractGenerationContext

Inheritance: Object
OperationContractGenerationContext

Examples

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

Remarks

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.

Constructors

OperationContractGenerationContext(ServiceContractGenerator, ServiceContractGenerationContext, OperationDescription, CodeTypeDeclaration, CodeMemberMethod, CodeMemberMethod, CodeMemberMethod, CodeMemberMethod)	Initializes a new instance of the OperationContractGenerationContext class using the specified contract generator, contract context, operation description, code type declaration, synchronization method, begin method, end method, and task method.
OperationContractGenerationContext(ServiceContractGenerator, ServiceContractGenerationContext, OperationDescription, CodeTypeDeclaration, CodeMemberMethod, CodeMemberMethod, CodeMemberMethod)	Initializes a new instance of the OperationContractGenerationContext class.
OperationContractGenerationContext(ServiceContractGenerator, ServiceContractGenerationContext, OperationDescription, CodeTypeDeclaration, CodeMemberMethod, CodeMemberMethod)	Initializes a new instance of the OperationContractGenerationContext class using the specified contract generator, contract context, operation description, code type declaration, and method.
OperationContractGenerationContext(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, synchronization method and task method.

Properties

BeginMethod	Gets the CodeMemberMethod for the asynchronous begin operation.
Contract	Gets the code generation context for the service contract.
DeclaringType	Gets the declaring type for the current operation.
EndMethod	Gets the asynchronous end operation declaration.
IsAsync	Gets a value that indicates whether asynchronous methods are generated for the current operation.
IsTask	Gets a value that indicates whether a task is generated for the current operation.
Operation	Gets the OperationDescription for the current operation.
ServiceContractGenerator	Gets the ServiceContractGenerator that generates the current operation.
SyncMethod	Gets the CodeMemberMethod for the synchronous operation.
TaskMethod	Gets the CodeMemberMethod for the task operation.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Partajați prin