ServiceContractGenerationContext.ContractType Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the System.CodeDom.CodeTypeDeclaration for the current contract.

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

public CodeTypeDeclaration ContractType { get; }

Property Value

Type: System.CodeDom.CodeTypeDeclaration

The System.CodeDom.CodeTypeDeclaration for the current contract.

Use the ContractType property to examine or modify the System.CodeDom.CodeTypeDeclaration for the current contract before the code is generated.

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

.NET Framework
Available since 3.0
Return to top
Show: