Export (0) Print
Expand All

ContextMessageProperty Class

A property used to communicate context between the application and channel layers on either the client or the service.

System.Object
  System.ServiceModel.Channels.ContextMessageProperty

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

[SerializableAttribute]
public class ContextMessageProperty : IMessageProperty

The ContextMessageProperty type exposes the following members.

  NameDescription
Public methodContextMessageProperty()Initializes a new instance of the ContextMessageProperty class.
Public methodContextMessageProperty(IDictionary<String, String>)Initializes a new instance of the ContextMessageProperty class with a specified context.
Top

  NameDescription
Public propertyContextGets the context used to correlate messages within a conversation between a client and a service.
Public propertyStatic memberNameGets the name of the context message property.
Top

  NameDescription
Public methodAddOrReplaceInMessageSets the value of the ContextMessageProperty property in a specified Message from the current instance of ContextMessageProperty.
Public methodAddOrReplaceInMessagePropertiesSets the value of the ContextMessageProperty property in a specified collection of MessageProperties from the current instance of ContextMessageProperty.
Public methodCreateCopyCreates a copy of the current instance of ContextMessageProperty.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodStatic memberTryCreateFromHttpCookieHeaderAttempts to instantiate a ContextMessageProperty from the key/value pairs of a specified HTTP cookie.
Public methodStatic memberTryGet(Message, ContextMessageProperty)Attempts to get the ContextMessageProperty from the properties of a specified message.
Public methodStatic memberTryGet(MessageProperties, ContextMessageProperty)Attempts to get the ContextMessageProperty from a specified collection of message properties.
Top

A collection of properties that are added to a Message that correlates messages that form part of a conversation between a client and a service.

If Enabled is true, context is established at the channel layer, and all incoming messages on the client and the service have this context property attached by the context channel. If Enabled is false the ContextMessageProperty is used to attach context to an outgoing message on the client or the service at the application layer.

The ContextMessageProperty can be used on the client or on the service. Alternatively, on the client only, the current context can be obtained or a new context can be set on channel instance using GetContext and SetContext properties.

.NET Framework

Supported in: 4.5.3, 4, 3.5

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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