Export (0) Print
Expand All

WsdlContractConversionContext Class

Passed to custom WSDL exporters and importers to enable customization of the metadata export and import processes for a contract.

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

public class WsdlContractConversionContext
public class WsdlContractConversionContext
public class WsdlContractConversionContext
Not applicable.

Use the WsdlContractConversionContext object to examine and modify items that are to be converted to or from WSDL.

When exporting metadata a WsdlContractConversionContext object is passed to the ExportContract and ExportEndpoint methods. Use the various methods and properties to obtain metadata objects that you can use to examine and modify to alter the published WSDL.

When importing metadata a WsdlContractConversionContext object is passed to the ImportContract and ImportEndpoint methods. Use the various methods and properties to obtain metadata objects that you can use to examine and modify the imported metadata.

The following code example shows the use of the WsdlContractConversionContext to add custom WSDL annotations to the exported metadata using the WsdlPortType and Contract properties.

public void ExportContract(WsdlExporter exporter, WsdlContractConversionContext context)
    {

...

  Console.WriteLine("Inside ExportContract");
        if (context.Contract != null)
        {
    // Inside this block it is the contract-level comment attribute.
    // This.Text returns the string for the contract attribute.
    // Set the doc element; if this isn't done first, there is no XmlElement in the 
    // DocumentElement property.
    context.WsdlPortType.Documentation = string.Empty; 
    // Contract comments.
    XmlDocument owner = context.WsdlPortType.DocumentationElement.OwnerDocument;
    XmlElement summaryElement = Formatter.CreateSummaryElement(owner, this.Text); 
    context.WsdlPortType.DocumentationElement.AppendChild(summaryElement);

    foreach (OperationDescription op in context.Contract.Operations)
    {
      Operation operation = context.GetOperation(op);
      object[] opAttrs = op.SyncMethod.GetCustomAttributes(typeof(WsdlDocumentationAttribute), false);
      if (opAttrs.Length == 1)
      {
        string opComment = ((WsdlDocumentationAttribute)opAttrs[0]).Text;

        // This.Text returns the string for the operation-level attributes.
        // Set the doc element; if this isn't done first, there is no XmlElement in the 
        // DocumentElement property.
        operation.Documentation = String.Empty;

        // Operation C# triple comments.
        XmlDocument opOwner = operation.DocumentationElement.OwnerDocument;
        XmlElement newSummaryElement = Formatter.CreateSummaryElement(opOwner, opComment);
        operation.DocumentationElement.AppendChild(newSummaryElement);

        // Get returns information
        ParameterInfo returnValue = op.SyncMethod.ReturnParameter;
        object[] returnAttrs = returnValue.GetCustomAttributes(typeof(WsdlParameterDocumentationAttribute), false);
        if (returnAttrs.Length == 1)
        {
          // <returns>text.</returns>
          XmlElement returnsElement = 
            Formatter.CreateReturnsElement(
              opOwner,
              ((WsdlParameterDocumentationAttribute)returnAttrs[0]).ParamComment
            );
          operation.DocumentationElement.AppendChild(returnsElement);
        }
        
        // Get parameter information.
        ParameterInfo[] args = op.SyncMethod.GetParameters();
        for (int i = 0; i < args.Length; i++)
        {
          object[] docAttrs 
            = args[i].GetCustomAttributes(typeof(WsdlParameterDocumentationAttribute), false);
          if (docAttrs.Length != 0)
          {
            // <param name="Int1">Text.</param>
            XmlElement newParamElement = opOwner.CreateElement("param");
            XmlAttribute paramName = opOwner.CreateAttribute("name");
            paramName.Value = args[i].Name;
            newParamElement.InnerText 
              = ((WsdlParameterDocumentationAttribute)docAttrs[0]).ParamComment;
            newParamElement.Attributes.Append(paramName);
            operation.DocumentationElement.AppendChild(newParamElement);
          }
        }
      }
    }
  }

System.Object
  System.ServiceModel.Description.WsdlContractConversionContext

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

ADD
Show:
© 2014 Microsoft