.NET Framework Class Library
MessageContractAttribute Class

Defines a strongly-typed class that corresponds to a SOAP message.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ServiceModelMessageContractAttribute

Namespace:   System.ServiceModel
Assemblies:   System.ServiceModel (in System.ServiceModel.dll)
  System.ServiceModel.Primitives (in System.ServiceModel.Primitives.dll)
Syntax
<[%$TOPIC/ms586728_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/ms586728_en-us_VS_110_2_0_0_0_1%].Class Or [%$TOPIC/ms586728_en-us_VS_110_2_0_0_0_2%].Struct, AllowMultiple := False)> _
Public NotInheritable Class MessageContractAttribute _
	Inherits [%$TOPIC/ms586728_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/ms586728_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/ms586728_en-us_VS_110_2_0_1_0_1%].Class|[%$TOPIC/ms586728_en-us_VS_110_2_0_1_0_2%].Struct, AllowMultiple = false)]
public sealed class MessageContractAttribute : [%$TOPIC/ms586728_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/ms586728_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/ms586728_en-us_VS_110_2_0_2_0_1%]::Class|[%$TOPIC/ms586728_en-us_VS_110_2_0_2_0_2%]::Struct, AllowMultiple = false)]
public ref class MessageContractAttribute sealed : public [%$TOPIC/ms586728_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/ms586728_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/ms586728_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/ms586728_en-us_VS_110_2_0_3_0_2%].Class|[%$TOPIC/ms586728_en-us_VS_110_2_0_3_0_3%].Struct, AllowMultiple = false)>]
type MessageContractAttribute =  
    class 
        inherit [%$TOPIC/ms586728_en-us_VS_110_2_0_3_0_4%] 
    end
public final class MessageContractAttribute extends [%$TOPIC/ms586728_en-us_VS_110_2_0_4_0_0%]

The MessageContractAttribute type exposes the following members.

Constructors
  NameDescription
Public method Supported by Portable Class Library MessageContractAttributeInitializes a new instance of the MessageContractAttribute class.
Top
Properties
  NameDescription
Public property HasProtectionLevelGets a value that indicates whether the message has a protection level.
Public property IsWrappedGets or sets a value that specifies whether the message body has a wrapper element.
Public property ProtectionLevelGets or sets a value that specified whether the message must be encrypted, signed, or both.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public property Supported by Portable Class Library WrapperNameGets or sets the name of the wrapper element of the message body.
Public property Supported by Portable Class Library WrapperNamespaceGets or sets the namespace of the message body wrapper element.
Top
Methods
  NameDescription
Public method Supported by Portable Class Library EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method Supported by Portable Class Library GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method Supported by Portable Class Library GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method Supported by Portable Class Library ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

Use the MessageContractAttribute attribute to specify the structure of the SOAP envelope for a particular message. Your service can then use the message as a parameter or return type in service operations. For information about controlling the serialization of the contents of a SOAP body without modifying the default SOAP envelope itself, see System.Runtime.SerializationDataContractAttribute, Specifying Data Transfer in Service Contracts, and Using Data Contracts.

NoteNote

You cannot use custom message types in your service operation with regular serializable parameters. Either use custom message types or serializable parameters that are not Message objects. For details, see , Specifying Data Transfer in Service Contracts.

To implement a message contract for a type, annotate it with MessageContractAttribute and annotate one or more of the class's fields or properties with MessageBodyMemberAttribute, MessageHeaderAttribute, or MessageHeaderArrayAttribute.

NoteNote

System.ServiceModelMessageParameterAttribute is not a message contract attribute and cannot be used in conjunction with MessageContractAttribute.

Use the Action and ReplyAction properties to specify the value of the <Action> element in the SOAP message.

For more information, see Using Message Contracts.

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.

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> 
'        </HelloResponseMessage> 
'      </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> 
'        </HelloGreetingMessage> 
'      </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
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;
    }
  }
}
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
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.