MessageHeaderAttribute Klass

Definition

public ref class MessageHeaderAttribute : System::ServiceModel::MessageContractMemberAttribute

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

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

Public Class MessageHeaderAttribute
Inherits MessageContractMemberAttribute

Arv

Object

Attribute

MessageContractMemberAttribute

MessageHeaderAttribute

Härledda

System.ServiceModel.MessageHeaderArrayAttribute

System.ServiceModel.PeerHopCountAttribute

Attribut

AttributeUsageAttribute

Exempel

I följande kodexempel visas användningen av MessageHeaderAttribute för att skapa en SOAP-rubrik för svarsmeddelandet med Nameegenskaperna , Namespace och MustUnderstand som är inställda på värden som är lämpliga för det här huvudet. Kodexemplet följs av ett exempel på meddelandet när det skickas.

 [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 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

Kommentarer

Med MessageHeaderAttribute attributet kan du mappa fält och egenskaper för en typ som har markerats med MessageContractAttribute attributet till SOAP-meddelanderubriker. Fältet eller egenskapen kan vara av en enkel typ eller en sammansatt typ som kan serialiseras.

Information om hur du styr serialiseringen av innehållet i en SOAP-brödtext utan att ändra själva SOAP-standardkuvertet finns System.Runtime.Serialization.DataContractAttributei Ange dataöverföring i tjänstkontrakt och Använda datakontrakt.

Mer information om hur du skapar meddelandekontrakt finns i Använda meddelandekontrakt.

SOAP-standarden definierar följande attribut som kan finnas i en rubrik:

• Actor eller Role (Actor i SOAP 1.1, Role i SOAP 1.2)

• MustUnderstand

• Relay

Attributet Actor eller Role anger URI:n för noden som ett visst huvud är avsett för. Attributet MustUnderstand anger om huvudet förstår nodbearbetningen. Attributet Relay anger om rubriken ska vidarebefordras till underordnade noder. Windows Communication Foundation (WCF) utför inte någon bearbetning av dessa attribut på inkommande meddelanden, förutom attributet MustUnderstand.

Du kan dock läsa och skriva dessa attribut, även om de inte skickas som standard. Du kan ange attributvärdena på två sätt. Först kan du ändra Actoregenskaperna , MustUnderstand och Relay på MessageHeaderAttribute. (Det finns ingen Role egenskap – ange Actor egenskapen och Role skickas om SOAP 1.2 används). Ett exempel:

Det andra sättet att styra dessa attribut är genom att göra önskad rubriktyp till typparametern för MessageHeader<T> klassen och använda den resulterande typen tillsammans med MessageHeaderAttribute. Använd MessageHeader<T> sedan egenskaperna programmatiskt för att ange SOAP-attributen. Ett exempel:

Om både de dynamiska och statiska kontrollmekanismerna används är de statiska inställningarna standard men kan åsidosättas med hjälp av den dynamiska mekanismen. Ett exempel:

Det är tillåtet att skapa upprepade rubriker med dynamisk attributkontroll. Ett exempel:

[MessageHeaderArray] public MessageHeader<Person> documentApprovers[];

På mottagarsidan kan du bara läsa dessa SOAP-attribut om den generiska MessageHeader<T> klassen används. ActorGranska egenskaperna , Relay eller MustUnderstand för en rubrik av typen MessageHeader<T> för att identifiera attributinställningarna för det mottagna meddelandet.

När ett meddelande tas emot och sedan skickas tillbaka, inställningarna för SOAP-attribut endast tur och retur för rubriker av typen MessageHeader<T> .