Message Class

.NET Framework (current version)

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)

Inheritance Hierarchy

System.Object
System.Web.Services.Description.DocumentableItem
System.Web.Services.Description.NamedItem
System.Web.Services.Description.Message

Syntax

C++

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

Constructors

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

Properties

	Name	Description
	Documentation	Gets or sets the text documentation for the instance of the DocumentableItem.(Inherited from DocumentableItem.)
	DocumentationElement	Gets or sets the documentation element for the DocumentableItem.(Inherited from DocumentableItem.)
	ExtensibleAttributes	Gets 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.)
	Extensions	Gets the ServiceDescriptionFormatExtensionCollection associated with this Message.(Overrides DocumentableItem.Extensions.)
	Name	Gets or sets the name of the item.(Inherited from NamedItem.)
	Namespaces	Gets 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.)
	Parts	Gets the collection of the MessagePart objects contained in the Message.
	ServiceDescription	Gets the ServiceDescription of which the current Message is a member.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	FindPartByName(String)	Searches the MessagePartCollection returned by the Parts property, and returns the named MessagePart.
	FindPartsByName(String[])	Searches the MessagePartCollection returned by the Parts property and returns an array of type MessagePart that contains the named instances.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Remarks

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/.

Examples

C++

// 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;
   MessagePart myMessagePart = new MessagePart();
   myMessagePart.Name = partName;
   myMessagePart.Element = new XmlQualifiedName(element,targetNamespace);
   myMessage.Parts.Add(myMessagePart);
   return myMessage;
}

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.