Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

DiscoveryClientDocumentCollection Class

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

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

Namespace:  System.Web.Services.Discovery
Assembly:  System.Web.Services (in System.Web.Services.dll)
public sealed class DiscoveryClientDocumentCollection : DictionaryBase

The DiscoveryClientDocumentCollection type exposes the following members.

  NameDescription
Public methodDiscoveryClientDocumentCollectionInitializes a new instance of the DiscoveryClientDocumentCollection class.
Top
  NameDescription
Public propertyCountGets the number of elements contained in the DictionaryBase instance. (Inherited from DictionaryBase.)
Public propertyItemGets or sets a client discovery document object from the DiscoveryClientDocumentCollection with the specified URL.
Public propertyKeysGets an System.Collections.ICollection object with all the keys in the DiscoveryClientDocumentCollection.
Public propertyValuesGets an System.Collections.ICollection object with all the values in the DiscoveryClientDocumentCollection.
Top
  NameDescription
Public methodAddAdds an object with the specified URL to the DiscoveryClientDocumentCollection.
Public methodClearClears the contents of the DictionaryBase instance. (Inherited from DictionaryBase.)
Public methodContainsDetermines if the DiscoveryClientDocumentCollection contains an object with the specified URL.
Public methodCopyToCopies the DictionaryBase elements to a one-dimensional Array at the specified index. (Inherited from DictionaryBase.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetEnumeratorReturns an IDictionaryEnumerator that iterates through the DictionaryBase instance. (Inherited from DictionaryBase.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodRemoveRemoves an object with the specified URL from the DiscoveryClientDocumentCollection.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedGets a value indicating whether access to a DictionaryBase object is synchronized (thread safe). (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyICollection.SyncRootGets an object that can be used to synchronize access to a DictionaryBase object. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate methodIDictionary.AddAdds an element with the specified key and value into the DictionaryBase. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate methodIDictionary.ContainsDetermines whether the DictionaryBase contains a specific key. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyIDictionary.IsFixedSizeGets a value indicating whether a DictionaryBase object has a fixed size. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyIDictionary.IsReadOnlyGets a value indicating whether a DictionaryBase object is read-only. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyIDictionary.ItemGets or sets the value associated with the specified key. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyIDictionary.KeysGets an ICollection object containing the keys in the DictionaryBase object. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate methodIDictionary.RemoveRemoves the element with the specified key from the DictionaryBase. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyIDictionary.ValuesGets an ICollection object containing the values in the DictionaryBase object. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorReturns an IEnumerator that iterates through the DictionaryBase. (Inherited from DictionaryBase.)
Top

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.

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

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft. All rights reserved.