Edit

Share via


WebReference Constructors

Definition

Initializes a new instance of the WebReference class.

Overloads

WebReference(DiscoveryClientDocumentCollection, CodeNamespace)

Initializes a new instance of the WebReference class with the given description document collection and proxy code namespace.

WebReference(DiscoveryClientDocumentCollection, CodeNamespace, String, String)

Initializes a new instance of the WebReference class with the given data.

WebReference(DiscoveryClientDocumentCollection, CodeNamespace, String, String, String)

Initializes a new instance of the WebReference class with the given data.

WebReference(DiscoveryClientDocumentCollection, CodeNamespace)

Initializes a new instance of the WebReference class with the given description document collection and proxy code namespace.

public:
 WebReference(System::Web::Services::Discovery::DiscoveryClientDocumentCollection ^ documents, System::CodeDom::CodeNamespace ^ proxyCode);
public WebReference (System.Web.Services.Discovery.DiscoveryClientDocumentCollection documents, System.CodeDom.CodeNamespace proxyCode);
new System.Web.Services.Description.WebReference : System.Web.Services.Discovery.DiscoveryClientDocumentCollection * System.CodeDom.CodeNamespace -> System.Web.Services.Description.WebReference
Public Sub New (documents As DiscoveryClientDocumentCollection, proxyCode As CodeNamespace)

Parameters

documents
DiscoveryClientDocumentCollection

A DiscoveryClientDocumentCollection that specifies a collection of description documents.

proxyCode
CodeNamespace

A CodeNamespace that specifies a namespace for code compilation.

Examples

The following code example illustrates the use of this constructor. This code example is part of a larger example provided for the WebReference class.

// Create a web referernce using the WSDL collection.
WebReference reference = new WebReference(wsdlCollection, space);
reference.ProtocolName = "Soap12";

Remarks

The documents collection should contain only ServiceDescription and XmlSchema objects; the GenerateWebReferences method is unable to interpret DiscoveryDocument objects.

Applies to

WebReference(DiscoveryClientDocumentCollection, CodeNamespace, String, String)

Initializes a new instance of the WebReference class with the given data.

public:
 WebReference(System::Web::Services::Discovery::DiscoveryClientDocumentCollection ^ documents, System::CodeDom::CodeNamespace ^ proxyCode, System::String ^ appSettingUrlKey, System::String ^ appSettingBaseUrl);
public WebReference (System.Web.Services.Discovery.DiscoveryClientDocumentCollection documents, System.CodeDom.CodeNamespace proxyCode, string appSettingUrlKey, string appSettingBaseUrl);
new System.Web.Services.Description.WebReference : System.Web.Services.Discovery.DiscoveryClientDocumentCollection * System.CodeDom.CodeNamespace * string * string -> System.Web.Services.Description.WebReference
Public Sub New (documents As DiscoveryClientDocumentCollection, proxyCode As CodeNamespace, appSettingUrlKey As String, appSettingBaseUrl As String)

Parameters

documents
DiscoveryClientDocumentCollection

A DiscoveryClientDocumentCollection that specifies a collection of description documents.

proxyCode
CodeNamespace

A CodeNamespace that specifies a namespace for code compilation.

appSettingUrlKey
String

The URL key of the Web reference.

appSettingBaseUrl
String

The base URL of the Web reference.

Remarks

The documents collection should contain only ServiceDescription and XmlSchema objects; the GenerateWebReferences method is unable to interpret DiscoveryDocument objects.

Applies to

WebReference(DiscoveryClientDocumentCollection, CodeNamespace, String, String, String)

Initializes a new instance of the WebReference class with the given data.

public:
 WebReference(System::Web::Services::Discovery::DiscoveryClientDocumentCollection ^ documents, System::CodeDom::CodeNamespace ^ proxyCode, System::String ^ protocolName, System::String ^ appSettingUrlKey, System::String ^ appSettingBaseUrl);
public WebReference (System.Web.Services.Discovery.DiscoveryClientDocumentCollection documents, System.CodeDom.CodeNamespace proxyCode, string protocolName, string appSettingUrlKey, string appSettingBaseUrl);
new System.Web.Services.Description.WebReference : System.Web.Services.Discovery.DiscoveryClientDocumentCollection * System.CodeDom.CodeNamespace * string * string * string -> System.Web.Services.Description.WebReference
Public Sub New (documents As DiscoveryClientDocumentCollection, proxyCode As CodeNamespace, protocolName As String, appSettingUrlKey As String, appSettingBaseUrl As String)

Parameters

documents
DiscoveryClientDocumentCollection

A DiscoveryClientDocumentCollection that specifies a collection of description documents.

proxyCode
CodeNamespace

A CodeNamespace that specifies a namespace for code compilation.

protocolName
String

The protocol used by the XML Web service.

appSettingUrlKey
String

The URL key of the Web reference.

appSettingBaseUrl
String

The base URL of the Web reference.

Examples

The following code example shows how to use this constructor.

// Read in a WSDL service description.
string url = "http://www.contoso.com/Example/WebService.asmx?WSDL";
XmlTextReader reader = new XmlTextReader(url);
ServiceDescription wsdl = ServiceDescription.Read(reader);

// Create a WSDL collection.
DiscoveryClientDocumentCollection wsdlCollection = 
    new DiscoveryClientDocumentCollection();
wsdlCollection.Add(url, wsdl);

// Create a namespace.
CodeNamespace proxyNamespace = new CodeNamespace("ExampleNamespace");

// Create a web reference using the WSDL collection.
string baseUrl = "http://www.contoso.com";
string urlKey = "ExampleUrlKey";
string protocolName = "Soap12";
WebReference reference = new WebReference(
    wsdlCollection, proxyNamespace, protocolName, urlKey, baseUrl);

// Print some information about the web reference.
Console.WriteLine("The WebReference object contains {0} document(s).", 
    reference.Documents.Count);
Console.WriteLine("The protocol name is {0}.", reference.ProtocolName);
Console.WriteLine("The base URL is {0}.", reference.AppSettingBaseUrl);
Console.WriteLine("The URL key is {0}.", reference.AppSettingUrlKey);

// Print some information about the proxy code namespace.
Console.WriteLine("The proxy code namespace is {0}.", 
    reference.ProxyCode.Name);

// Print some information about the validation warnings.
Console.WriteLine("There are {0} validation warnings.",
    reference.ValidationWarnings.Count);

// Print some information about the warnings.
if (reference.Warnings == 0)
{
    Console.WriteLine("There are no warnings.");
}
else
{
    Console.WriteLine("Warnings: " + reference.Warnings);
}

Remarks

The documents collection should contain only ServiceDescription and XmlSchema objects; the GenerateWebReferences method is unable to interpret DiscoveryDocument objects.

Applies to