MessageBodyMemberAttribute Class

Definition

public ref class MessageBodyMemberAttribute : System::ServiceModel::MessageContractMemberAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, Inherited=false)]
public class MessageBodyMemberAttribute : System.ServiceModel.MessageContractMemberAttribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, Inherited=false)>]
type MessageBodyMemberAttribute = class
 inherit MessageContractMemberAttribute

Public Class MessageBodyMemberAttribute
Inherits MessageContractMemberAttribute

Inheritance

Object

Attribute

MessageContractMemberAttribute

MessageBodyMemberAttribute

Attributes

AttributeUsageAttribute

Examples

The following code example shows the use of the MessageContractAttribute to control the SOAP envelope structure for both the request message and the response message, and the use of both the MessageHeaderAttribute (to create a SOAP header for the response message) and the MessageBodyMemberAttribute (to specify the bodies of both the request and response message). The code example contains an example of each message when sent.

using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.ServiceModel.Channels;

namespace Microsoft.WCF.Documentation
{
 [ServiceContract(Namespace = "Microsoft.WCF.Documentation")]
 interface IMessagingHello
 {
 [OperationContract(
 Action = "http://GreetingMessage/Action",
 ReplyAction = "http://HelloResponseMessage/Action"
 )]
 HelloResponseMessage Hello(HelloGreetingMessage msg);
 }

 [MessageContract]
 public class HelloResponseMessage
 {
 private string localResponse = String.Empty;
 private string extra = String.Empty;

 [MessageBodyMember(
 Name = "ResponseToGreeting",
 Namespace = "http://www.examples.com")]
 public string Response
 {
 get { return localResponse; }
 set { localResponse = value; }
 }

 [MessageHeader(
 Name = "OutOfBandData",
 Namespace = "http://www.examples.com",
 MustUnderstand=true
 )]
 public string ExtraValues
 {
 get { return extra; }
 set { this.extra = value; }
 }

 /*
 The following is the response message, edited for clarity.

 <s:Envelope>
 <s:Header>
 <a:Action s:mustUnderstand="1">http://HelloResponseMessage/Action</a:Action>
 <h:OutOfBandData s:mustUnderstand="1" xmlns:h="http://www.examples.com">Served by object 13804354.</h:OutOfBandData>
 </s:Header>
 <s:Body>
 <HelloResponseMessage xmlns="Microsoft.WCF.Documentation">
 <ResponseToGreeting xmlns="http://www.examples.com">Service received: Hello.</ResponseToGreeting>
 </HelloResponseMessage>
 </s:Body>
 </s:Envelope>
 */
 }
 [MessageContract]
 public class HelloGreetingMessage
 {
 private string localGreeting;

 [MessageBodyMember(
 Name = "Salutations",
 Namespace = "http://www.examples.com"
 )]
 public string Greeting
 {
 get { return localGreeting; }
 set { localGreeting = value; }
 }
 }

 /*
 The following is the request message, edited for clarity.

 <s:Envelope>
 <s:Header>
 <!-- Note: Some header content has been removed for clarity.
 <a:Action>http://GreetingMessage/Action</a:Action>
 <a:To s:mustUnderstand="1"></a:To>
 </s:Header>
 <s:Body u:Id="_0" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
 <HelloGreetingMessage xmlns="Microsoft.WCF.Documentation">
 <Salutations xmlns="http://www.examples.com">Hello.</Salutations>
 </HelloGreetingMessage>
 </s:Body>
 </s:Envelope>
 */

 class MessagingHello : IMessagingHello
 {
 public HelloResponseMessage Hello(HelloGreetingMessage msg)
 {
 Console.WriteLine("Caller sent: " + msg.Greeting);
 HelloResponseMessage responseMsg = new HelloResponseMessage();
 responseMsg.Response = "Service received: " + msg.Greeting;
 responseMsg.ExtraValues = String.Format("Served by object {0}.", this.GetHashCode().ToString());
 Console.WriteLine("Returned response message.");
 return responseMsg;
 }
 }
}

Imports System.Runtime.Serialization
Imports System.ServiceModel
Imports System.ServiceModel.Channels

Namespace Microsoft.WCF.Documentation
 <ServiceContract(Namespace := "Microsoft.WCF.Documentation")> _
 Friend Interface IMessagingHello
 <OperationContract(Action := "http://GreetingMessage/Action", ReplyAction := "http://HelloResponseMessage/Action")> _
 Function Hello(ByVal msg As HelloGreetingMessage) As HelloResponseMessage
 End Interface

 <MessageContract> _
 Public Class HelloResponseMessage
 Private localResponse As String = String.Empty
 Private extra As String = String.Empty

 <MessageBodyMember(Name := "ResponseToGreeting", Namespace := "http://www.examples.com")> _
 Public Property Response() As String
 Get
 Return localResponse
 End Get
 Set(ByVal value As String)
 localResponse = value
 End Set
 End Property

 <MessageHeader(Name := "OutOfBandData", Namespace := "http://www.examples.com", MustUnderstand:=True)> _
 Public Property ExtraValues() As String
 Get
 Return extra
 End Get
 Set(ByVal value As String)
 Me.extra = value
 End Set
 End Property

' 
' The following is the response message, edited for clarity.
' 
' <s:Envelope>
' <s:Header>
' <a:Action s:mustUnderstand="1">http://HelloResponseMessage/Action</a:Action>
' <h:OutOfBandData s:mustUnderstand="1" xmlns:h="http://www.examples.com">Served by object 13804354.</h:OutOfBandData>
' </s:Header>
' <s:Body>
' <HelloResponseMessage xmlns="Microsoft.WCF.Documentation">
' <ResponseToGreeting xmlns="http://www.examples.com">Service received: Hello.</ResponseToGreeting>
' </s:Body> 
' </s:Envelope>
' 
 End Class
 <MessageContract> _
 Public Class HelloGreetingMessage
 Private localGreeting As String

 <MessageBodyMember(Name := "Salutations", Namespace := "http://www.examples.com")> _
 Public Property Greeting() As String
 Get
 Return localGreeting
 End Get
 Set(ByVal value As String)
 localGreeting = value
 End Set
 End Property
 End Class

' 
' The following is the request message, edited for clarity.
' 
' <s:Envelope>
' <s:Header>
' <!-- Note: Some header content has been removed for clarity.
' <a:Action>http://GreetingMessage/Action</a:Action> 
' <a:To s:mustUnderstand="1"></a:To>
' </s:Header>
' <s:Body u:Id="_0" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
' <HelloGreetingMessage xmlns="Microsoft.WCF.Documentation">
' <Salutations xmlns="http://www.examples.com">Hello.</Salutations>
' </s:Body>
' </s:Envelope>
' 

 Friend Class MessagingHello
 Implements IMessagingHello
 Public Function Hello(ByVal msg As HelloGreetingMessage) As HelloResponseMessage Implements IMessagingHello.Hello
 Console.WriteLine("Caller sent: " & msg.Greeting)
 Dim responseMsg As New HelloResponseMessage()
 responseMsg.Response = "Service received: " & msg.Greeting
 responseMsg.ExtraValues = String.Format("Served by object {0}.", Me.GetHashCode().ToString())
 Console.WriteLine("Returned response message.")
 Return responseMsg
 End Function
 End Class
End Namespace

Remarks

Use the MessageBodyMemberAttribute attribute to specify that a data member is serialized into the SOAP body and to control some serialization items.

The Order property is used to specify the order of body parts in cases where the default alphabetical order is not appropriate.

The other properties are inherited from the base class, System.ServiceModel.MessageContractMemberAttribute.

For more information about controlling the serialization of the contents of a SOAP body without modifying the default SOAP envelope itself, see System.Runtime.Serialization.DataContractAttribute, Specifying Data Transfer in Service Contracts, and Using Data Contracts.

For more information, see Using Message Contracts.