ServiceContractGenerationContext Class
TOC
Collapse the table of content
Expand the table of content

ServiceContractGenerationContext Class

 

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

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

System.Object
  System.ServiceModel.Description.ServiceContractGenerationContext

public class ServiceContractGenerationContext

NameDescription
System_CAPS_pubmethodServiceContractGenerationContext(ServiceContractGenerator, ContractDescription, CodeTypeDeclaration)

Initializes a new instance of the ServiceContractGenerationContext class using the specified contract generator, contract description, and contract code type declaration.

System_CAPS_pubmethodServiceContractGenerationContext(ServiceContractGenerator, ContractDescription, CodeTypeDeclaration, CodeTypeDeclaration)

Initializes a new instance of the ServiceContractGenerationContext class using the specified contract generator, contract description, and contract code type declaration.

NameDescription
System_CAPS_pubpropertyContract

Gets the System.ServiceModel.Description.ContractDescription for the current contract.

System_CAPS_pubpropertyContractType

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

System_CAPS_pubpropertyDuplexCallbackType

Gets the System.CodeDom.CodeTypeDeclaration for the duplex callback contract on the service contract.

System_CAPS_pubpropertyOperations

Gets a collection of System.ServiceModel.Description.OperationContractGenerationContext objects that represent the contract operations.

System_CAPS_pubpropertyServiceContractGenerator

Gets the System.ServiceModel.Description.ServiceContractGenerator that is to generate the contract.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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

.NET Framework
Available since 3.0

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

Return to top
Show:
© 2016 Microsoft