MessagePropertyAttribute Class

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

MessagePropertyAttribute.cs

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

public ref class MessagePropertyAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class MessagePropertyAttribute : Attribute

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

Public NotInheritable Class MessagePropertyAttribute
Inherits Attribute

Inheritance

Object

Attribute

MessagePropertyAttribute

Attributes

AttributeUsageAttribute

Examples

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

Remarks

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.

Constructors

MessagePropertyAttribute()

Initializes a new instance of the MessagePropertyAttribute class.

Properties

Name	Gets or sets the name of the property.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
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)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)