WsdlContractConversionContext Class

Definition

Namespace:

System.ServiceModel.Description

Assembly:

System.ServiceModel.dll

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

public ref class WsdlContractConversionContext

public class WsdlContractConversionContext

type WsdlContractConversionContext = class

Public Class WsdlContractConversionContext

Inheritance

Object

WsdlContractConversionContext

Examples

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

Remarks

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.

Properties

Contract	Gets the ContractDescription being exported or imported.
WsdlPortType	Gets the PortType that represents the contract.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetFaultDescription(OperationFault)	Returns the fault description for the specified fault.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetMessageDescription(OperationMessage)	Returns the message description for the specified message.
GetOperation(OperationDescription)	Returns the operation for the specified operation description.
GetOperationDescription(Operation)	Returns the operation description associated with the operation.
GetOperationFault(FaultDescription)	Returns the OperationFault for the requested FaultDescription.
GetOperationMessage(MessageDescription)	Gets a OperationMessage object for the specified message that represents a message type passed by the action of an XML Web service.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)