DiscoveryClientDocumentCollection Class

.NET Framework (current version)

Represents a collection of documents discovered during XML Web services discovery that have been downloaded to the client. This class cannot be inherited.

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

Inheritance Hierarchy

System.Object
System.Collections.DictionaryBase
System.Web.Services.Discovery.DiscoveryClientDocumentCollection

Syntax

C++

public sealed class DiscoveryClientDocumentCollection : DictionaryBase

Constructors

	Name	Description
	DiscoveryClientDocumentCollection()	Initializes a new instance of the DiscoveryClientDocumentCollection class.

Properties

	Name	Description
	Count	Gets the number of elements contained in the DictionaryBase instance.(Inherited from DictionaryBase.)
	Item[String]	Gets or sets a client discovery document object from the DiscoveryClientDocumentCollection with the specified URL.
	Keys	Gets an System.Collections.ICollection object with all the keys in the DiscoveryClientDocumentCollection.
	Values	Gets an System.Collections.ICollection object with all the values in the DiscoveryClientDocumentCollection.

Methods

	Name	Description
	Add(String, Object)	Adds an object with the specified URL to the DiscoveryClientDocumentCollection.
	Clear()	Clears the contents of the DictionaryBase instance.(Inherited from DictionaryBase.)
	Contains(String)	Determines if the DiscoveryClientDocumentCollection contains an object with the specified URL.
	CopyTo(Array, Int32)	Copies the DictionaryBase elements to a one-dimensional Array at the specified index.(Inherited from DictionaryBase.)
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	GetEnumerator()	Returns an IDictionaryEnumerator that iterates through the DictionaryBase instance.(Inherited from DictionaryBase.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	Remove(String)	Removes an object with the specified URL from the DiscoveryClientDocumentCollection.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	IDictionary.Add(Object, Object)	Adds an element with the specified key and value into the DictionaryBase.(Inherited from DictionaryBase.)
	IDictionary.Contains(Object)	Determines whether the DictionaryBase contains a specific key.(Inherited from DictionaryBase.)
	IDictionary.Remove(Object)	Removes the element with the specified key from the DictionaryBase.(Inherited from DictionaryBase.)
	IEnumerable.GetEnumerator()	Returns an IEnumerator that iterates through the DictionaryBase.(Inherited from DictionaryBase.)
	ICollection.IsSynchronized	Gets a value indicating whether access to a DictionaryBase object is synchronized (thread safe).(Inherited from DictionaryBase.)
	ICollection.SyncRoot	Gets an object that can be used to synchronize access to a DictionaryBase object.(Inherited from DictionaryBase.)
	IDictionary.IsFixedSize	Gets a value indicating whether a DictionaryBase object has a fixed size.(Inherited from DictionaryBase.)
	IDictionary.IsReadOnly	Gets a value indicating whether a DictionaryBase object is read-only.(Inherited from DictionaryBase.)
	IDictionary.Item[Object]	Gets or sets the value associated with the specified key.(Inherited from DictionaryBase.)
	IDictionary.Keys	Gets an ICollection object containing the keys in the DictionaryBase object.(Inherited from DictionaryBase.)
	IDictionary.Values	Gets an ICollection object containing the values in the DictionaryBase object.(Inherited from DictionaryBase.)

Extension Methods

	Name	Description
	AsParallel()	Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)
	AsQueryable()	Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)
	Cast<TResult>()	Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)
	OfType<TResult>()	Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

Remarks

The Documents property of DiscoveryClientProtocol is of type DiscoveryClientDocumentCollection.

The following code example enacts XML Web service discovery and downloads the discovered documents to the client. The names of the discovery documents within the DiscoveryClientDocumentCollection are output to the console.

C++

using System;
using System.Net;
using System.IO;
using System.Collections;
using System.Security.Permissions;
using System.Web.Services.Discovery;

class DiscoveryClientDocumentCollectionSample
{
   static void Main()
   {
      Run();
   }

   [PermissionSetAttribute(SecurityAction.Demand, Name="FullTrust")]
   static void Run()
   {
      DiscoveryClientProtocol myDiscoveryClientProtocol =
         new DiscoveryClientProtocol();

      myDiscoveryClientProtocol.Credentials = CredentialCache.DefaultCredentials;

      // 'dataservice.disco' is a sample discovery document.
      string myStringUrl = "http://localhost/dataservice.disco";

      // 'Discover' method is called to populate the 'Documents' property.
      DiscoveryDocument myDiscoveryDocument = 
         myDiscoveryClientProtocol.Discover(myStringUrl);

      // An instance of the 'DiscoveryClientDocumentCollection' class is created.
      DiscoveryClientDocumentCollection myDiscoveryClientDocumentCollection = 
         myDiscoveryClientProtocol.Documents;

      // 'Keys' in the collection are retrieved.
      ICollection myCollection = myDiscoveryClientDocumentCollection.Keys;
      object[] myObjectCollection = 
         new object[myDiscoveryClientDocumentCollection.Count];
      myCollection.CopyTo(myObjectCollection, 0);

      Console.WriteLine("The discovery documents in the collection are :");
      for (int iIndex=0; iIndex < myObjectCollection.Length; iIndex++)
      {
         Console.WriteLine(myObjectCollection[iIndex]);
      }

      Console.WriteLine("");

      // 'Values' in the collection are retrieved.
      ICollection myCollection1 = myDiscoveryClientDocumentCollection.Values;
      object[] myObjectCollection1 = 
         new object[myDiscoveryClientDocumentCollection.Count];
      myCollection1.CopyTo(myObjectCollection1, 0);

      Console.WriteLine("The objects in the collection are :");
      for (int iIndex=0; iIndex < myObjectCollection1.Length; iIndex++)
      {
         Console.WriteLine(myObjectCollection1[iIndex]);
      }
   }
}

Version Information

.NET Framework
Available since 1.1

Thread Safety

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