MessagePartCollection Class

Definition

Namespace:

System.Web.Services.Description

Assembly:

System.Web.Services.Description.dll

Package:

System.Web.Services.Description v6.2.0

Source:

ServiceDescription.cs

Represents a collection of instances of the MessagePart class. This class cannot be inherited.

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

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

type MessagePartCollection = class
    inherit ServiceDescriptionBaseCollection

Public NotInheritable Class MessagePartCollection
Inherits ServiceDescriptionBaseCollection

Inheritance

Object

CollectionBase

ServiceDescriptionBaseCollection

MessagePartCollection

Examples

The following example demonstrates the use of the methods and properties exposed by the MessagePartCollection class.

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

using namespace System;
using namespace System::Web::Services::Description;
using namespace System::Collections;
using namespace System::Xml;
int main()
{
   Console::WriteLine( "" );
   Console::WriteLine( "MessagePartCollection Sample" );
   Console::WriteLine( "============================" );
   Console::WriteLine( "" );
   ServiceDescription^ myServiceDescription = ServiceDescription::Read( "MathService.wsdl" );

   // Get the message collection.
   MessageCollection^ myMessageCollection = myServiceDescription->Messages;
   Console::WriteLine( "Total Messages in the document = {0}", myServiceDescription->Messages->Count );
   Console::WriteLine( "" );
   Console::WriteLine( "Enumerating PartCollection for each message..." );
   Console::WriteLine( "" );

   // Get the message part collection for each message.
   for ( int i = 0; i < myMessageCollection->Count; ++i )
   {
      Console::WriteLine( "Message      : {0}", myMessageCollection[ i ]->Name );

      // Get the message part collection.
      MessagePartCollection^ myMessagePartCollection = myMessageCollection[ i ]->Parts;

      // Display the part collection.
      for ( int k = 0; k < myMessagePartCollection->Count; k++ )
      {
         Console::WriteLine( "\t       Part Name     : {0}", myMessagePartCollection[ k ]->Name );
         Console::WriteLine( "\t       Message Name  : {0}", myMessagePartCollection[ k ]->Message->Name );
      }
      Console::WriteLine( "" );
   }

   Console::WriteLine( "MessagePartCollection for the message AddHttpGetIn." );
   Message^ myLocalMessage = myServiceDescription->Messages[ "AddHttpPostOut" ];
   if ( myMessageCollection->Contains( myLocalMessage ) )
   {
      Console::WriteLine( "Message      : {0}", myLocalMessage->Name );

      // Get the message part collection.
      MessagePartCollection^ myMessagePartCollection = myLocalMessage->Parts;
      array<MessagePart^>^myMessagePart = gcnew array<MessagePart^>(myMessagePartCollection->Count);
      
      // Copy the MessagePartCollection to an array.
      myMessagePartCollection->CopyTo( myMessagePart, 0 );
      for ( int k = 0; k < myMessagePart->Length; k++ )
         Console::WriteLine( "\t       Part Name : {0}", myMessagePartCollection[ k ]->Name );
      Console::WriteLine( "" );
   }

   Console::WriteLine( "Checking if message is AddHttpPostOut..." );
   Message^ myMessage = myServiceDescription->Messages[ "AddHttpPostOut" ];
   if ( myMessageCollection->Contains( myMessage ) )
   {
      // Get the mssage part collection.
      MessagePartCollection^ myMessagePartCollection = myMessage->Parts;

      // Get the part named Body.
      MessagePart^ myMessagePart = myMessage->Parts[ "Body" ];
      if ( myMessagePartCollection->Contains( myMessagePart ) )
      {
         // Get the part named Body.
         Console::WriteLine( "Index of Body in MessagePart collection = {0}", myMessagePartCollection->IndexOf( myMessagePart ) );
         Console::WriteLine( "Deleting Body from MessagePart collection..." );
         myMessagePartCollection->Remove( myMessagePart );
         if ( myMessagePartCollection->IndexOf( myMessagePart ) == -1 )
                  Console::WriteLine( "from the message AddHttpPostOut." );
      }
   }
}

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

class MyClass1
{
   public static void Main()
   {
      Console.WriteLine("");
      Console.WriteLine("MessagePartCollection Sample");
      Console.WriteLine("============================");
      Console.WriteLine("");

      ServiceDescription myServiceDescription =
         ServiceDescription.Read("MathService.wsdl");

      // Get the message collection.
      MessageCollection myMessageCollection = myServiceDescription.Messages;
      Console.WriteLine("Total Messages in the document = " +
         myServiceDescription.Messages.Count);
      Console.WriteLine("");
      Console.WriteLine("Enumerating PartCollection for each message...");
      Console.WriteLine("");
      // Get the message part collection for each message.
      for(int i =0; i < myMessageCollection.Count; ++i)
      {
         Console.WriteLine("Message      : " + myMessageCollection[i].Name);

         // Get the message part collection.
         MessagePartCollection myMessagePartCollection =
            myMessageCollection[i].Parts;

         // Display the part collection.
         for(int k = 0; k < myMessagePartCollection.Count;k++)
         {
            Console.WriteLine("\t       Part Name     : " +
               myMessagePartCollection[k].Name);
            Console.WriteLine("\t       Message Name  : " +
               myMessagePartCollection[k].Message.Name);
         }
         Console.WriteLine("");
      }
      Console.WriteLine("Displaying the array copied from the " +
         "MessagePartCollection for the message AddHttpGetIn.");
      Message myLocalMessage = myServiceDescription.Messages["AddHttpPostOut"];
      if (myMessageCollection.Contains(myLocalMessage))
      {
         Console.WriteLine("Message      : " + myLocalMessage.Name);

         // Get the message part collection.
         MessagePartCollection myMessagePartCollection = myLocalMessage.Parts;
         MessagePart[] myMessagePart  =
            new MessagePart[myMessagePartCollection.Count];

         // Copy the MessagePartCollection to an array.
         myMessagePartCollection.CopyTo(myMessagePart,0);
         for(int k = 0; k < myMessagePart.Length; k++)
         {
            Console.WriteLine("\t       Part Name : " +
               myMessagePartCollection[k].Name);
         }
         Console.WriteLine("");
      }

      Console.WriteLine("Checking if message is AddHttpPostOut...");
      Message myMessage = myServiceDescription.Messages["AddHttpPostOut"];
      if (myMessageCollection.Contains(myMessage))
      {
         // Get the message part collection.
         MessagePartCollection myMessagePartCollection = myMessage.Parts;

         // Get the part named Body.
         MessagePart myMessagePart = myMessage.Parts["Body"];
         if (myMessagePartCollection.Contains(myMessagePart))
         {
            // Get the index of the part named Body.
            Console.WriteLine("Index of Body in MessagePart collection = " +
               myMessagePartCollection.IndexOf(myMessagePart));
            Console.WriteLine("Deleting Body from MessagePart collection...");
            myMessagePartCollection.Remove(myMessagePart);
            if(myMessagePartCollection.IndexOf(myMessagePart)== -1)
            {
               Console.WriteLine("MessagePart Body successfully deleted " +
                  "from the message AddHttpPostOut.");
            }
         }
      }
   }
}

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

Class MyClass1
   Public Shared Sub Main()
      Console.WriteLine("")
      Console.WriteLine("MessagePartCollection Sample")
      Console.WriteLine("============================")
      Console.WriteLine("")

      Dim myServiceDescription As ServiceDescription = _
         ServiceDescription.Read("MathService.wsdl")
      ' Get the message collection.
      Dim myMessageCollection As MessageCollection = _
         myServiceDescription.Messages
      Console.WriteLine("Total Messages in the document = " & _
         myServiceDescription.Messages.Count.ToString)
      Console.WriteLine("")
      Console.WriteLine("Enumerating PartCollection for each message...")
      Console.WriteLine("")
      ' Get the message part collection for each message.
      Dim i As Integer
      For i =0 to myMessageCollection.Count-1
         Console.WriteLine("Message      : " & myMessageCollection(i).Name)

         ' Get the message part collection.
         Dim myMessagePartCollection As MessagePartCollection = _
            myMessageCollection(i).Parts

         ' Display the part collection.
         Dim k As Integer
         For k = 0 To myMessagePartCollection.Count - 1
            Console.WriteLine(ControlChars.Tab & "       Part Name     : " & _
               myMessagePartCollection(k).Name)
            Console.WriteLine(ControlChars.Tab & "       Message Name  : " & _
               myMessagePartCollection(k).Message.Name)
         Next k
         Console.WriteLine("")
      Next
      Console.WriteLine("Displaying the array copied from the " & _
         "MessagePartCollection for the message AddHttpGetIn.")
      Dim myLocalMessage As Message = _
         myServiceDescription.Messages("AddHttpPostOut")
      If myMessageCollection.Contains(myLocalMessage) Then
         Console.WriteLine("Message      : " & myLocalMessage.Name)

         ' Get the message part collection.
         Dim myMessagePartCollection As MessagePartCollection = _
            myLocalMessage.Parts
         Dim myMessagePart(myMessagePartCollection.Count) As MessagePart

         ' Copy the MessagePartCollection to an array.
         myMessagePartCollection.CopyTo(myMessagePart, 0)
         Dim k As Integer
         For k = 0 To myMessagePart.Length - 2
            Console.WriteLine(ControlChars.Tab & "       Part Name : " & _
               myMessagePartCollection(k).Name)
         Next k
         Console.WriteLine("")
      End If

      Console.WriteLine("Checking if message is AddHttpPostOut...")
      Dim myMessage As Message = myServiceDescription.Messages("AddHttpPostOut")
      If myMessageCollection.Contains(myMessage) Then

         ' Get the message part collection.
         Dim myMessagePartCollection As MessagePartCollection = myMessage.Parts

         ' Get the part named Body.
         Dim myMessagePart As MessagePart = myMessage.Parts("Body")
         If myMessagePartCollection.Contains(myMessagePart) Then

            ' Get the index of the part named Body.
            Console.WriteLine("Index of Body in MessagePart collection = " & _
               myMessagePartCollection.IndexOf(myMessagePart).ToString)
            Console.WriteLine("Deleting Body from MessagePart Collection...")
            myMessagePartCollection.Remove(myMessagePart)
            If myMessagePartCollection.IndexOf(myMessagePart) = -1 Then
               Console.WriteLine("MessagePart Body successfully deleted " & _
               "from the message AddHttpPostOut.")
            End If
         End If
      End If
   End Sub
End Class

Remarks

The MessagePart class corresponds to a Web Services Description Language (WSDL) <part> element enclosed by the <message> element, which is in turn enclosed by the <definitions> root element. For more information about WSDL, see the WSDL specification.

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 MessagePart at the specified zero-based index.
Item[String]	Gets a MessagePart specified by its name.
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(MessagePart)	Adds the specified MessagePart to the end of the MessagePartCollection.
Clear()	Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase)
Contains(MessagePart)	Returns a value indicating whether the specified MessagePart is a member of the MessagePartCollection.
CopyTo(MessagePart[], Int32)	Copies the entire MessagePartCollection to a compatible one-dimensional array of type MessagePart, 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)
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(MessagePart)	Searches for the specified MessagePart and returns the zero-based index of the first occurrence within the collection.
Insert(Int32, MessagePart)	Adds the specified MessagePart to the MessagePartCollection at the specified zero-based index.
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(MessagePart)	Removes the first occurrence of the specified MessagePart from the MessagePartCollection.
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)

Extension Methods

See also

• Message