Export (0) Print
Expand All

ServiceContractGenerationContext Class

Passed to the IServiceContractGenerationExtension.GenerateContract method to enable the modification of a service contract and its context prior to generating code.

System.Object
  System.ServiceModel.Description.ServiceContractGenerationContext

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

'Declaration
Public Class ServiceContractGenerationContext

The ServiceContractGenerationContext type exposes the following members.

  NameDescription
Public methodServiceContractGenerationContext(ServiceContractGenerator, ContractDescription, CodeTypeDeclaration)Initializes a new instance of the ServiceContractGenerationContext class using the specified contract generator, contract description, and contract code type declaration.
Public methodServiceContractGenerationContext(ServiceContractGenerator, ContractDescription, CodeTypeDeclaration, CodeTypeDeclaration)Initializes a new instance of the ServiceContractGenerationContext class using the specified contract generator, contract description, and contract code type declaration.
Top

  NameDescription
Public propertyContractGets the System.ServiceModel.Description.ContractDescription for the current contract.
Public propertyContractTypeGets the System.CodeDom.CodeTypeDeclaration for the current contract.
Public propertyDuplexCallbackTypeGets the System.CodeDom.CodeTypeDeclaration for the duplex callback contract on the service contract.
Public propertyOperationsGets a collection of System.ServiceModel.Description.OperationContractGenerationContext objects that represent the contract operations.
Public propertyServiceContractGeneratorGets the System.ServiceModel.Description.ServiceContractGenerator that is to generate the contract.
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 the default hash function. (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 ServiceContractGenerationContext object passed to the IServiceContractGenerationExtension.GenerateContract method to modify the code document object model prior to the generation of code. Typically, the System.ServiceModel.Description.IServiceContractGenerationExtension 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 operation level, see System.ServiceModel.Description.IOperationContractGenerationExtension.

The following example shows the use of the ServiceContractGenerationContext object passed to the IServiceContractGenerationExtension.GenerateContract method to add code comments extracted from custom WSDL elements.

public void GenerateContract(ServiceContractGenerationContext context)
{
  Console.WriteLine("In generate contract.");
  context.ContractType.Comments.AddRange(Formatter.FormatComments(commentText));
}

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.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

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