ContractReference Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Represents a reference in a discovery document to a service description.

Namespace:   System.Web.Services.Discovery
Assembly:  System.Web.Services (in System.Web.Services.dll)


public class ContractReference : DiscoveryReference


Initializes a new instance of the ContractReference class using default values.


Initializes a new instance of the ContractReference class using the supplied reference to a Service Description.

System_CAPS_pubmethodContractReference(String, String)

Initializes a new instance of the ContractReference class using the supplied references to a service description and a XML Web service implementing the service description.


Gets or sets the instance of DiscoveryClientProtocol used in a discovery process.(Inherited from DiscoveryReference.)


Gets a System.Web.Services.Description.ServiceDescription object representing the service description.


Gets the name of the file to use by default when saving the referenced service description.(Overrides DiscoveryReference.DefaultFilename.)


Gets and sets the URL for a XML Web service implementing the service description referenced in the Ref property.


Gets or sets the URL to the referenced service description.


Gets or sets the URL for the referenced Service Description.(Overrides DiscoveryReference.Url.)


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


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


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


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


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


Reads the service description from the passed Stream and returns the service description.(Overrides DiscoveryReference.ReadDocument(Stream).)


Downloads the referenced document at Url to resolve whether the referenced document is valid.(Inherited from DiscoveryReference.)

System_CAPS_protmethodResolve(String, Stream)

Resolves whether the the referenced document is valid.(Overrides DiscoveryReference.Resolve(String, Stream).)


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

System_CAPS_pubmethodWriteDocument(Object, Stream)

Writes the passed-in service description into the passed-in Stream.(Overrides DiscoveryReference.WriteDocument(Object, Stream).)


XML namespace for service description references in discovery documents.

XML Web services discovery involves discovering the available Web Services given an URL. The URL usually points to a discovery document, which typically has a.disco file name extension. Within a discovery document are references to information about the existance of XML Web services. These references can refer to service descriptions, XML Schema Definition language (XSD) schemas or other discovery documents. This class represents a reference to a Service Description.

Within a discovery document, a reference to a Service Description is contained within a contractRef XML element. The contractRef XML element has two attributes: ref and docRef. The contractRef element must have an XML namespace matching the Namespace constant, whereas the ref and docRef attributes are placed in the Ref and DocRef properties.

using System;
using System.Xml;
using System.IO;
using System.Web.Services.Discovery;

public class MyContractReference
   static void Main()
         // Get a DiscoveryDocument.
         DiscoveryDocument myDiscoveryDocument = new  DiscoveryDocument();

         // Get a ContractReference.
         ContractReference myContractReference = new ContractReference();

         // Set the URL to the referenced service description.
         myContractReference.Ref = "http://localhost/service1.asmx?wsdl";

         // Set the URL for an XML Web service implementing the service
         // description.
         myContractReference.DocRef = "http://localhost/service1.asmx";
         SoapBinding myBinding = new SoapBinding();
         myBinding.Binding = new XmlQualifiedName("q1:Service1Soap");
         myBinding.Address = "http://localhost/service1.asmx";

         // Add myContractReference to the list of references contained 
         // in the discovery document.

         // Add Binding to the references collection.

         // Open or create a file for writing.
         FileStream myFileStream = new FileStream("Service1.disco",
             FileMode.OpenOrCreate, FileAccess.Write );
         StreamWriter myStreamWriter = new StreamWriter( myFileStream );

         // Write myDiscoveryDocument into the passed stream.
         myDiscoveryDocument.Write( myStreamWriter );
         Console.WriteLine("The Service1.disco is generated.");
      catch(Exception e)
         Console.WriteLine("Error is "+ e.Message);

.NET Framework
Available since 1.1

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