MessagePropertyAttribute Class
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents data that is passed locally with a custom message type but not serialized into a SOAP message.

Namespace:   System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

SystemObject
   SystemAttribute
    System.ServiceModelMessagePropertyAttribute

[AttributeUsageAttribute(AttributeTargets.Property | AttributeTargets.Field, 
	Inherited = false)]
public sealed class MessagePropertyAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Property | AttributeTargets::Field, 
	Inherited = false)]
public ref class MessagePropertyAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Property | AttributeTargets.Field,
    Inherited = false)>]
type MessagePropertyAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field,
	Inherited := False)>
Public NotInheritable Class MessagePropertyAttribute
	Inherits Attribute
NameDescription
System_CAPS_pubmethod MessagePropertyAttribute

Initializes a new instance of the MessagePropertyAttribute class.

NameDescription
System_CAPS_pubproperty

Gets or sets the name of the property.

System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethod Equals

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod IsDefaultAttribute

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

Use the MessagePropertyAttribute attribute to attach data to the custom message type as it passes through the Windows Communication Foundation (WCF) system without serializing the data into a SOAP message.

The following code example demonstrates the use of the MessagePropertyAttribute attribute.

[MessageContractAttribute] 
public class CustomMessage 
{ 
    private Person internalPerson; 
    [MessageProperty] 
    private int a = 23; 
    [MessageBodyMember(Name="Person")] 
    public PersonType Data 
    { 
        get 
        { 
            return internalPerson; 
        } 
        set
        { 
            this.internalPerson = (Person)value; 
        } 
    } 
}
<MessageContractAttribute> _
Public Class CustomMessage
	Private internalPerson As Person
	<MessageProperty> _
	Private a As Integer = 23
	<MessageBodyMember(Name:="Person")> _
	Public Property Data() As PersonType
		Get
			Return internalPerson
		End Get
		Set(ByVal value As PersonType)
			Me.internalPerson = CType(value, Person)
		End Set
	End Property
End Class
.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top