WebReferenceCollection Class
.NET Framework 4.5
Describes a collection of WebReference objects.
System.Object
System.Collections.CollectionBase
System.Web.Services.Description.WebReferenceCollection
System.Collections.CollectionBase
System.Web.Services.Description.WebReferenceCollection
Assembly: System.Web.Services (in System.Web.Services.dll)
The WebReferenceCollection type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | WebReferenceCollection | Initializes a new instance of the WebReferenceCollection class. |
| Name | Description | |
|---|---|---|
![]() | Capacity | Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.) |
![]() | Count | Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.) |
![]() | Item | Gets or sets the WebReference instance at the specified index. |
| Name | Description | |
|---|---|---|
![]() | Add | Appends a WebReference instance to the collection. |
![]() | Clear | Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.) |
![]() | Contains | Determines whether the collection contains a given WebReference instance. |
![]() | CopyTo | Copies members of the collection to a specified array, starting at the specified array index. |
![]() | Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetEnumerator | Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IndexOf | Determines the index of the specified WebReference instance. |
![]() | Insert | Inserts the specified WebReference instance at the specified index. |
![]() | Remove | Removes the specified WebReference instance from the collection. |
![]() | RemoveAt | Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | ICollection.CopyTo | Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase.) |
![]() ![]() | ICollection.IsSynchronized | Gets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.) |
![]() ![]() | ICollection.SyncRoot | Gets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase.) |
![]() ![]() | IList.Add | Adds an object to the end of the CollectionBase. (Inherited from CollectionBase.) |
![]() ![]() | IList.Contains | Determines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.) |
![]() ![]() | IList.IndexOf | Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase.) |
![]() ![]() | IList.Insert | Inserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.) |
![]() ![]() | IList.IsFixedSize | Gets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.) |
![]() ![]() | IList.IsReadOnly | Gets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.) |
![]() ![]() | IList.Item | Gets or sets the element at the specified index. (Inherited from CollectionBase.) |
![]() ![]() | IList.Remove | Removes the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.) |
Use this class to pass a collection of WebReference objects when invoking the static GenerateWebReferences method of the ServiceDescriptionImporter class.
The following code example illustrates the use of this class.
using System; using System.CodeDom; using System.CodeDom.Compiler; using System.Security.Permissions; using System.Web.Services; using System.Web.Services.Description; using System.Web.Services.Discovery; using System.Xml; using System.Xml.Serialization; class Test { [SecurityPermissionAttribute(SecurityAction.Demand, Unrestricted=true)] static void Run(){ // Get a WSDL file describing a service. ServiceDescription description = ServiceDescription.Read("DataTypes_CS.wsdl"); // Initialize a service description importer. ServiceDescriptionImporter importer = new ServiceDescriptionImporter(); importer.ProtocolName = "Soap12"; // Use SOAP 1.2. importer.AddServiceDescription(description,null,null); // Report on the service descriptions. Console.WriteLine("Importing {0} service descriptions with {1} associated schemas.", importer.ServiceDescriptions.Count, importer.Schemas.Count); // Generate a proxy client. importer.Style = ServiceDescriptionImportStyle.Client; // Generate properties to represent primitive values. importer.CodeGenerationOptions = System.Xml.Serialization.CodeGenerationOptions.GenerateProperties; // Initialize a Code-DOM tree into which we will import the service. CodeNamespace nmspace = new CodeNamespace(); CodeCompileUnit unit1 = new CodeCompileUnit(); unit1.Namespaces.Add(nmspace); // Import the service into the Code-DOM tree. This creates proxy code // that uses the service. ServiceDescriptionImportWarnings warning = importer.Import(nmspace, unit1); if (warning == 0) { // Generate and print the proxy code in C#. CodeDomProvider provider1 = CodeDomProvider.CreateProvider("CSharp"); provider1.GenerateCodeFromCompileUnit(unit1, Console.Out, new CodeGeneratorOptions()); } else { // Print an error message. Console.WriteLine("Warning: " + warning); } string url = "AddNumbers.wsdl"; // Read in a WSDL service description. 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 and a unit for compilation. CodeNamespace space = new CodeNamespace(); CodeCompileUnit unit = new CodeCompileUnit(); unit.Namespaces.Add(space); // Create a web referernce using the WSDL collection. WebReference reference = new WebReference(wsdlCollection, space); reference.ProtocolName = "Soap12"; // Print some information about the web reference. Console.WriteLine("Base Url = {0}", reference.AppSettingBaseUrl); Console.WriteLine("Url Key = {0}", reference.AppSettingUrlKey); Console.WriteLine("Documents = {0}", reference.Documents.Count); // Create a web reference collection. WebReferenceCollection references = new WebReferenceCollection(); references.Add(reference); // Compile a proxy client and print out the code. CodeDomProvider provider = CodeDomProvider.CreateProvider("CSharp"); WebReferenceOptions options = new WebReferenceOptions(); options.Style = ServiceDescriptionImportStyle.Client; options.CodeGenerationOptions = CodeGenerationOptions.GenerateNewAsync; ServiceDescriptionImporter.GenerateWebReferences( references, provider, unit, options ); provider.GenerateCodeFromCompileUnit(unit, Console.Out, new CodeGeneratorOptions() ); } static void Main () { Test.Run(); } }
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

