ServiceDescriptionFormatExtensionCollection Class

Reference

Definition

Namespace:: System.Web.Services.Description

Assembly:: System.Web.Services.dll

Assembly:: System.Web.Services.Description.dll

Package:: System.Web.Services.Description v8.1.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the collection of extensibility elements used by the XML Web service. This class cannot be inherited.

public ref class ServiceDescriptionFormatExtensionCollection sealed : System::Web::Services::Description::ServiceDescriptionBaseCollection

public sealed class ServiceDescriptionFormatExtensionCollection : System.Web.Services.Description.ServiceDescriptionBaseCollection

type ServiceDescriptionFormatExtensionCollection = class
    inherit ServiceDescriptionBaseCollection

Public NotInheritable Class ServiceDescriptionFormatExtensionCollection
Inherits ServiceDescriptionBaseCollection

Inheritance: Object

CollectionBase

ServiceDescriptionBaseCollection
ServiceDescriptionFormatExtensionCollection

Examples

#using <System.Web.Services.dll>
#using <System.Xml.dll>

using namespace System;
using namespace System::Web::Services::Description;
using namespace System::Collections;

ref class MyFormatExtension: public ServiceDescriptionFormatExtension
{
public:
   MyFormatExtension()
   {
      // Set the properties.
      this->Handled = true;
      this->Required = true;
   }
};

int main()
{
   try
   {
      ServiceDescription^ myServiceDescription = ServiceDescription::Read( "Sample_cpp.wsdl" );
      ServiceDescriptionFormatExtensionCollection^ myCollection = gcnew ServiceDescriptionFormatExtensionCollection( myServiceDescription );

      SoapBinding^ mySoapBinding1 = gcnew SoapBinding;
      SoapBinding^ mySoapBinding2 = gcnew SoapBinding;
      SoapAddressBinding^ mySoapAddressBinding = gcnew SoapAddressBinding;
      MyFormatExtension^ myFormatExtensionObject = gcnew MyFormatExtension;

      // Add elements to collection.
      myCollection->Add( mySoapBinding1 );
      myCollection->Add( mySoapAddressBinding );
      myCollection->Add( mySoapBinding2 );
      myCollection->Add( myFormatExtensionObject );

      Console::WriteLine( "Collection contains following types of elements: " );
      
      // Display the 'Type' of the elements in collection.
      for ( int i = 0; i < myCollection->Count; i++ )
         Console::WriteLine( myCollection[ i ]->GetType() );

      // Check element of type 'SoapAddressBinding' in collection.
      Object^ myObj = myCollection->Find( mySoapAddressBinding->GetType() );
      if ( myObj == nullptr )
            Console::WriteLine( "Element of type ' {0}' not found in collection.", mySoapAddressBinding->GetType() );
      else
            Console::WriteLine( "Element of type ' {0}' found in collection.", mySoapAddressBinding->GetType() );

      // Check all elements of type 'SoapBinding' in collection.
      array<Object^>^myObjectArray1 = gcnew array<Object^>(myCollection->Count);
      myObjectArray1 = myCollection->FindAll( mySoapBinding1->GetType() );
      int myNumberOfElements = 0;
      IEnumerator^ myIEnumerator = myObjectArray1->GetEnumerator();

      // Calculate number of elements of type 'SoapBinding'.
      while ( myIEnumerator->MoveNext() )
            if ( mySoapBinding1->GetType() == myIEnumerator->Current->GetType() )
            myNumberOfElements++;
      Console::WriteLine( "Collection contains {0} objects of type ' {1}'.", myNumberOfElements, mySoapBinding1->GetType() );

      // Check 'IsHandled' status for 'myFormatExtensionObject' object in collection.
      Console::WriteLine( "'IsHandled' status for {0} object is {1}.", myFormatExtensionObject, myCollection->IsHandled( myFormatExtensionObject ) );

      // Check 'IsRequired' status for 'myFormatExtensionObject' object in collection.
      Console::WriteLine( "'IsRequired' status for {0} object is {1}.", myFormatExtensionObject, myCollection->IsRequired( myFormatExtensionObject ) );

      // Copy elements of collection to an Object array.
      array<Object^>^myObjectArray2 = gcnew array<Object^>(myCollection->Count);
      myCollection->CopyTo( myObjectArray2, 0 );
      Console::WriteLine( "Collection elements are copied to an object array." );

      // Check for 'myFormatExtension' object in collection.
      if ( myCollection->Contains( myFormatExtensionObject ) )
      {
         // Get index of a 'myFormatExtension' object in collection.
         Console::WriteLine( "Index of 'myFormatExtensionObject' is {0} in collection.", myCollection->IndexOf( myFormatExtensionObject ) );

         // Remove 'myFormatExtensionObject' element from collection.
         myCollection->Remove( myFormatExtensionObject );
         Console::WriteLine( "'myFormatExtensionObject' is removed  from collection." );
      }

      // Insert 'MyFormatExtension' object.
      myCollection->Insert( 0, myFormatExtensionObject );
      Console::WriteLine( "'myFormatExtensionObject' is inserted to collection." );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "The following exception was raised: {0}", e->Message );
   }
}

using System;
using System.Web.Services.Description;
using System.Collections;

class MyFormatExtension : ServiceDescriptionFormatExtension
{
   public MyFormatExtension()
   {
      // Set the properties.
      this.Handled  = true;
      this.Required = true;
   }
}
class myCollectionSample
{
   static void Main()
   {
      try
      {
         ServiceDescription myServiceDescription =
            ServiceDescription.Read("Sample_CS.wsdl");
         ServiceDescriptionFormatExtensionCollection  myCollection =
            new ServiceDescriptionFormatExtensionCollection(myServiceDescription);
         SoapBinding mySoapBinding1 = new SoapBinding();
         SoapBinding mySoapBinding2 = new SoapBinding();
         SoapAddressBinding mySoapAddressBinding = new SoapAddressBinding();
         MyFormatExtension  myFormatExtensionObject = new MyFormatExtension();
         // Add elements to collection.
         myCollection.Add(mySoapBinding1);
         myCollection.Add(mySoapAddressBinding);
         myCollection.Add(mySoapBinding2);
         myCollection.Add(myFormatExtensionObject);
         Console.WriteLine("Collection contains following types of elements: ");
         // Display the 'Type' of the elements in collection.
         for(int i = 0;i< myCollection.Count;i++)
         {
            Console.WriteLine(myCollection[i].GetType().ToString());
         }
         // Check element of type 'SoapAddressBinding' in collection.
         Object   myObj = myCollection.Find(mySoapAddressBinding.GetType());
         if(myObj == null)
         {
            Console.WriteLine("Element of type '{0}' not found in collection.",
               mySoapAddressBinding.GetType().ToString());
         }
         else
         {
            Console.WriteLine("Element of type '{0}' found in collection.",
               mySoapAddressBinding.GetType().ToString());
         }
         // Check all elements of type 'SoapBinding' in collection.
         Object[] myObjectArray1 = new Object[myCollection.Count];
         myObjectArray1 = myCollection.FindAll(mySoapBinding1.GetType());
         int myNumberOfElements = 0;
         IEnumerator myIEnumerator  = myObjectArray1.GetEnumerator();

         // Calculate number of elements of type 'SoapBinding'.
         while(myIEnumerator.MoveNext())
         {
            if(mySoapBinding1.GetType() == myIEnumerator.Current.GetType())
               myNumberOfElements++;
         }
         Console.WriteLine("Collection contains {0} objects of type '{1}'.",
                           myNumberOfElements.ToString(),
                           mySoapBinding1.GetType().ToString());
         // Check 'IsHandled' status for 'myFormatExtensionObject' object in collection.
         Console.WriteLine("'IsHandled' status for {0} object is {1}.",
                  myFormatExtensionObject.ToString(),
                  myCollection.IsHandled(myFormatExtensionObject).ToString());
         // Check 'IsRequired' status for 'myFormatExtensionObject' object in collection.
         Console.WriteLine("'IsRequired' status for {0} object is {1}.",
                  myFormatExtensionObject.ToString(),
                  myCollection.IsRequired(myFormatExtensionObject).ToString());
         // Copy elements of collection to an Object array.
         Object[] myObjectArray2 = new Object[myCollection.Count];
         myCollection.CopyTo(myObjectArray2,0);
         Console.WriteLine("Collection elements are copied to an object array.");
         // Check for 'myFormatExtension' object in collection.
         if(myCollection.Contains(myFormatExtensionObject))
         {
            // Get index of a 'myFormatExtension' object in collection.
            Console.WriteLine("Index of 'myFormatExtensionObject' is "+
               "{0} in collection.",
               myCollection.IndexOf(myFormatExtensionObject).ToString());
            // Remove 'myFormatExtensionObject' element from collection.
            myCollection.Remove(myFormatExtensionObject);
            Console.WriteLine("'myFormatExtensionObject' is removed"+
                              " from collection.");
         }
         // Insert 'MyFormatExtension' object.
         myCollection.Insert(0,myFormatExtensionObject);
         Console.WriteLine("'myFormatExtensionObject' is inserted to collection.");
      }
      catch(Exception e)
      {
         Console.WriteLine("The following exception was raised: {0}", e.Message);
      }
   }
}

Imports System.Web.Services.Description
Imports System.Collections


Class MyFormatExtension
   Inherits ServiceDescriptionFormatExtension
   
   Public Sub New()
      ' Set the properties.
      Me.Handled = True
      Me.Required = True
   End Sub
End Class

Class myCollectionSample
   
   Shared Sub Main()
      Try
         Dim myServiceDescription As ServiceDescription = _
                 ServiceDescription.Read("Sample_VB.wsdl")
         Dim myCollection As New ServiceDescriptionFormatExtensionCollection(myServiceDescription)
         Dim mySoapBinding1 As New SoapBinding()
         Dim mySoapBinding2 As New SoapBinding()
         Dim mySoapAddressBinding As New SoapAddressBinding()
         Dim myFormatExtensionObject As New MyFormatExtension()
         ' Add elements to collection.
         myCollection.Add(mySoapBinding1)
         myCollection.Add(mySoapAddressBinding)
         myCollection.Add(mySoapBinding2)
         myCollection.Add(myFormatExtensionObject)
         Console.WriteLine("Collection contains following types of elements: ")
         ' Display the 'Type' of the elements in collection.
         Dim i As Integer
         For i = 0 To myCollection.Count - 1
            Console.WriteLine(myCollection(i).GetType().ToString())
         Next i
         ' Check element of type 'SoapAddressBinding' in collection.
         Dim myObj As Object = myCollection.Find(mySoapAddressBinding.GetType())
         If myObj Is Nothing Then
            Console.WriteLine("Element of type '{0}' not found in collection.", _
                 mySoapAddressBinding.GetType().ToString())
         Else
            Console.WriteLine("Element of type '{0}' found in collection.", _
                 mySoapAddressBinding.GetType().ToString())
         End If
         ' Check all elements of type 'SoapBinding' in collection.
         Dim myObjectArray1(myCollection.Count -1 ) As Object
         myObjectArray1 = myCollection.FindAll(mySoapBinding1.GetType())
         Dim myNumberOfElements As Integer = 0
         Dim myIEnumerator As IEnumerator = myObjectArray1.GetEnumerator()
         
         ' Calculate number of elements of type 'SoapBinding'.
         While myIEnumerator.MoveNext()
            If mySoapBinding1.GetType() Is  myIEnumerator.Current.GetType() Then
               myNumberOfElements += 1
            End If
         End While
         Console.WriteLine("Collection contains {0} objects of type '{1}'.", _
                 myNumberOfElements.ToString(), mySoapBinding1.GetType().ToString())
         ' Check 'IsHandled' status for 'myFormatExtensionObject' object in collection.
         Console.WriteLine("'IsHandled' status for {0} object is {1}.", _
                 myFormatExtensionObject.ToString(), _
                 myCollection.IsHandled(myFormatExtensionObject).ToString())
         ' Check 'IsRequired' status for 'myFormatExtensionObject' object in collection.
         Console.WriteLine("'IsRequired' status for {0} object is {1}.", _
                 myFormatExtensionObject.ToString(), _
                 myCollection.IsRequired(myFormatExtensionObject).ToString())
         ' Copy elements of collection to an Object array.
         Dim myObjectArray2(myCollection.Count -1 ) As Object
         myCollection.CopyTo(myObjectArray2, 0)
         Console.WriteLine("Collection elements are copied to an object array.")
         ' Check for 'myFormatExtension' object in collection.
         If myCollection.Contains(myFormatExtensionObject) Then
            ' Get index of a 'myFormatExtension' object in collection.
            Console.WriteLine("Index of 'myFormatExtensionObject' is " + _
                 "{0} in collection.", myCollection.IndexOf(myFormatExtensionObject).ToString())
            ' Remove 'myFormatExtensionObject' element from collection.
            myCollection.Remove(myFormatExtensionObject)
            Console.WriteLine("'myFormatExtensionObject' is removed" + _
                 " from collection.")
         End If
         ' Insert 'MyFormatExtension' object.
         myCollection.Insert(0, myFormatExtensionObject)
         Console.WriteLine("'myFormatExtensionObject' is inserted to collection.")
      Catch e As Exception
         Console.WriteLine("The following exception was raised: {0}", e.Message.ToString())
      End Try
   End Sub
End Class

Remarks

This collection can either contain instances of classes deriving from ServiceDescriptionFormatExtension, or instances of the XmlElement class. In a derived class, ServiceDescriptionFormatExtension class allows users to define extensibility elements in addition to those defined in the Web Services Description Language (WSDL) specification. Use these in your ServiceDescriptionFormatExtensionCollection if you know in advance the type of extensibility element you want to make. Use an XmlElement when you do not know the format of an element in advance.

Constructors

ServiceDescriptionFormatExtensionCollection(Object)

Initializes a new instance of the ServiceDescriptionFormatExtensionCollection class.

Properties

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)
InnerList	Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase)
Item[Int32]	Gets or sets the value of a member of the ServiceDescriptionFormatExtensionCollection.
List	Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase)
Table	Gets an interface that implements the association of the keys and values in the ServiceDescriptionBaseCollection. (Inherited from ServiceDescriptionBaseCollection)

Methods

Add(Object)	Adds the specified ServiceDescriptionFormatExtension to the end of the ServiceDescriptionFormatExtensionCollection.
Clear()	Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase)
Contains(Object)	Returns a value indicating whether the specified ServiceDescriptionFormatExtension is a member of the ServiceDescriptionFormatExtensionCollection.
CopyTo(Object[], Int32)	Copies the entire ServiceDescriptionFormatExtensionCollection into a one-dimensional array of type ServiceDescriptionFormatExtension, starting at the specified zero-based index of the target array.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Find(String, String)	Searches the ServiceDescriptionFormatExtensionCollection for a member with the specified name and namespace URI.
Find(Type)	Searches the ServiceDescriptionFormatExtensionCollection and returns the first element of the specified derived Type.
FindAll(String, String)	Searches the ServiceDescriptionFormatExtensionCollection and returns an array of all members with the specified name and namespace URI.
FindAll(Type)	Searches the ServiceDescriptionFormatExtensionCollection and returns an array of all elements of the specified Type.
GetEnumerator()	Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetKey(Object)	Returns the name of the key associated with the value passed by reference. (Inherited from ServiceDescriptionBaseCollection)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IndexOf(Object)	Searches for the specified ServiceDescriptionFormatExtension and returns the zero-based index of the first instance with the collection.
Insert(Int32, Object)	Adds the specified ServiceDescriptionFormatExtension to the ServiceDescriptionFormatExtensionCollection at the specified zero-based index.
IsHandled(Object)	Returns a value indicating whether the specified object is used by the import process when the extensibility element is imported into the XML Web service.
IsRequired(Object)	Returns a value indicating whether the specified object is necessary for the operation of the XML Web service.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnClear()	Clears the contents of the ServiceDescriptionBaseCollection instance. (Inherited from ServiceDescriptionBaseCollection)
OnClearComplete()	Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase)
OnInsert(Int32, Object)	Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase)
OnInsertComplete(Int32, Object)	Performs additional custom processes after inserting a new element into the ServiceDescriptionBaseCollection. (Inherited from ServiceDescriptionBaseCollection)
OnRemove(Int32, Object)	Removes an element from the ServiceDescriptionBaseCollection. (Inherited from ServiceDescriptionBaseCollection)
OnRemoveComplete(Int32, Object)	Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase)
OnSet(Int32, Object, Object)	Replaces one value with another within the ServiceDescriptionBaseCollection. (Inherited from ServiceDescriptionBaseCollection)
OnSetComplete(Int32, Object, Object)	Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase)
OnValidate(Object)	Performs additional custom processes when validating a value. (Inherited from CollectionBase)
Remove(Object)	Removes the first occurrence of the specified ServiceDescriptionFormatExtension from the ServiceDescriptionFormatExtensionCollection.
RemoveAt(Int32)	Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase)
SetParent(Object, Object)	Sets the parent object of the ServiceDescriptionBaseCollection instance. (Inherited from ServiceDescriptionBaseCollection)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)	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(Object)	Adds an object to the end of the CollectionBase. (Inherited from CollectionBase)
IList.Contains(Object)	Determines whether the CollectionBase contains a specific element. (Inherited from CollectionBase)
IList.IndexOf(Object)	Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase)
IList.Insert(Int32, Object)	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[Int32]	Gets or sets the element at the specified index. (Inherited from CollectionBase)
IList.Remove(Object)	Removes the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

Applies to

Jaa