ServiceContractGenerationContext Classe

Définition

Espace de noms:

System.ServiceModel.Description

Assembly:

System.ServiceModel.dll

Passé à la méthode GenerateContract(ServiceContractGenerationContext) pour activer la modification d'un contrat de service et de son contexte avant de générer du code.

public ref class ServiceContractGenerationContext

public class ServiceContractGenerationContext

type ServiceContractGenerationContext = class

Public Class ServiceContractGenerationContext

Héritage

Object

ServiceContractGenerationContext

Exemples

L'exemple suivant illustre l'objet ServiceContractGenerationContext passé à la méthode IServiceContractGenerationExtension.GenerateContract pour ajouter des commentaires de code extraits d'éléments WSDL personnalisés.

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

L'exemple de code suivant montre les commentaires de code obtenus.

/// 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

Remarques

Utilisez l'objet ServiceContractGenerationContext passé à la méthode IServiceContractGenerationExtension.GenerateContract pour modifier le modèle CodeDOM (Code Document Object Model) avant de générer du code. En général, l'interface System.ServiceModel.Description.IServiceContractGenerationExtension est implémentée sur une implémentation System.ServiceModel.Description.IWsdlImportExtension personnalisée qui permet d'importer des éléments WSDL personnalisés ou de modifier le code au niveau du service ou de l'opération. Pour modifier le code au niveau de l'opération, consultez System.ServiceModel.Description.IOperationContractGenerationExtension.

Constructeurs

ServiceContractGenerationContext(ServiceContractGenerator, ContractDescription, CodeTypeDeclaration)	Initialise une nouvelle instance de la classe ServiceContractGenerationContext à l'aide du générateur de contrats, de la description de contrats et de la déclaration de type de code de contrat spécifiés.
ServiceContractGenerationContext(ServiceContractGenerator, ContractDescription, CodeTypeDeclaration, CodeTypeDeclaration)	Initialise une nouvelle instance de la classe ServiceContractGenerationContext à l'aide du générateur de contrats, de la description de contrats et de la déclaration de type de code de contrat spécifiés.

Propriétés

Contract	Obtient la ContractDescription du contrat actuel.
ContractType	Obtient la CodeTypeDeclaration du contrat actuel.
DuplexCallbackType	Obtient la CodeTypeDeclaration du contrat de rappel duplex sur le contrat de service.
Operations	Obtient une collection d’objets OperationContractGenerationContext qui représentent les opérations de contrat.
ServiceContractGenerator	Obtient le ServiceContractGenerator qui doit générer le contrat.

Méthodes

Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)