Export (0) Print
Expand All

Message Class

Provides an abstract definition of data passed by an XML Web service. This class cannot be inherited.

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

[XmlFormatExtensionPointAttribute("Extensions")]
public sealed class Message : NamedItem

The Message type exposes the following members.

  NameDescription
Public methodMessageInitializes a new instance of the Message class.
Top

  NameDescription
Public propertyDocumentationGets or sets the text documentation for the instance of the DocumentableItem. (Inherited from DocumentableItem.)
Public propertyDocumentationElementGets or sets the documentation element for the DocumentableItem. (Inherited from DocumentableItem.)
Public propertyExtensibleAttributesGets or sets an array of type XmlAttribute that represents attribute extensions of WSDL to comply with Web Services Interoperability (WS-I) Basic Profile 1.1. (Inherited from DocumentableItem.)
Public propertyExtensionsGets the ServiceDescriptionFormatExtensionCollection associated with this Message. (Overrides DocumentableItem.Extensions.)
Public propertyNameGets or sets the name of the item. (Inherited from NamedItem.)
Public propertyNamespacesGets or sets the dictionary of namespace prefixes and namespaces used to preserve namespace prefixes and namespaces when a ServiceDescription object is constructed. (Inherited from DocumentableItem.)
Public propertyPartsGets the collection of the MessagePart objects contained in the Message.
Public propertyServiceDescriptionGets the ServiceDescription of which the current Message is a member.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodFindPartByNameSearches the MessagePartCollection returned by the Parts property, and returns the named MessagePart.
Public methodFindPartsByNameSearches the MessagePartCollection returned by the Parts property and returns an array of type MessagePart that contains the named instances.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

A Message can contain either document-oriented or procedure-oriented information. Procedure-oriented messages contain parameters and return values, while document-oriented messages contain documents.

The Message class corresponds to a Web Services Description Language (WSDL) message element enclosed by the definitions root element. For more information about WSDL, see the specification at http://www.w3.org/TR/wsdl/.

   // Creates a Message with name = messageName having one MessagePart  
   // with name = partName. 
   public static Message CreateMessage(string messageName,string partName,
      string element,string targetNamespace)
   {
      Message myMessage = new Message();
      myMessage.Name = messageName;
// <Snippet11>
      MessagePart myMessagePart = new MessagePart();
      myMessagePart.Name = partName;
      myMessagePart.Element = new XmlQualifiedName(element,targetNamespace);
      myMessage.Parts.Add(myMessagePart);
// </Snippet6> 
      return myMessage;
   }

.NET Framework

Supported in: 4.5.2, 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 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