ServiceContractGenerationContext Класс

Определение

Пространство имен:

System.ServiceModel.Description

Сборка:

System.ServiceModel.dll

Передается в метод GenerateContract(ServiceContractGenerationContext) для разрешения изменения контракта службы и его контекста до создания кода.

public ref class ServiceContractGenerationContext

public class ServiceContractGenerationContext

type ServiceContractGenerationContext = class

Public Class ServiceContractGenerationContext

Наследование

Object

ServiceContractGenerationContext

Примеры

В следующем примере кода показано использование объекта ServiceContractGenerationContext, передаваемого в метод IServiceContractGenerationExtension.GenerateContract для добавления комментариев к коду, извлеченных из настраиваемых элементов языка WSDL.

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

В следующем примере показан результат добавления комментариев к коду.

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

Комментарии

Объект ServiceContractGenerationContext, передаваемый в метод IServiceContractGenerationExtension.GenerateContract, используется для изменения Code Document Object Model до создания кода. Обычно интерфейс System.ServiceModel.Description.IServiceContractGenerationExtension реализуется в пользовательской реализации System.ServiceModel.Description.IWsdlImportExtension, которая используется для импорта настраиваемых элементов языка WSDL либо для изменения кода на уровне службы или операции. Изменение кода на уровне операции см. в разделе System.ServiceModel.Description.IOperationContractGenerationExtension.

Конструкторы

ServiceContractGenerationContext(ServiceContractGenerator, ContractDescription, CodeTypeDeclaration)	Инициализирует новый экземпляр класса ServiceContractGenerationContext, используя заданные генератор контракта, описание контракта и объявление типа кода контракта.
ServiceContractGenerationContext(ServiceContractGenerator, ContractDescription, CodeTypeDeclaration, CodeTypeDeclaration)	Инициализирует новый экземпляр класса ServiceContractGenerationContext, используя заданные генератор контракта, описание контракта и объявление типа кода контракта.

Свойства

Contract	Возвращает контекст ContractDescription для текущего действия.
ContractType	Возвращает контекст CodeTypeDeclaration для текущего действия.
DuplexCallbackType	Возвращает CodeTypeDeclaration для дуплексного контракта обратного вызова в контракте службы.
Operations	Возвращает коллекцию объектов OperationContractGenerationContext, представляющих операции контракта.
ServiceContractGenerator	Возвращает объект ServiceContractGenerator, предназначенный для создания контракта.

Методы

Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)