TextMessageEncodingBindingElement Class

Definition

The binding element that specifies the character encoding and message versioning used for text-based SOAP messages.

public ref class TextMessageEncodingBindingElement sealed : System::ServiceModel::Channels::MessageEncodingBindingElement
public ref class TextMessageEncodingBindingElement sealed : System::ServiceModel::Channels::MessageEncodingBindingElement, System::ServiceModel::Description::IPolicyExportExtension, System::ServiceModel::Description::IWsdlExportExtension
public sealed class TextMessageEncodingBindingElement : System.ServiceModel.Channels.MessageEncodingBindingElement
public sealed class TextMessageEncodingBindingElement : System.ServiceModel.Channels.MessageEncodingBindingElement, System.ServiceModel.Description.IPolicyExportExtension, System.ServiceModel.Description.IWsdlExportExtension
type TextMessageEncodingBindingElement = class
    inherit MessageEncodingBindingElement
type TextMessageEncodingBindingElement = class
    inherit MessageEncodingBindingElement
    interface IWsdlExportExtension
    interface IPolicyExportExtension
Public NotInheritable Class TextMessageEncodingBindingElement
Inherits MessageEncodingBindingElement
Public NotInheritable Class TextMessageEncodingBindingElement
Inherits MessageEncodingBindingElement
Implements IPolicyExportExtension, IWsdlExportExtension
Inheritance
TextMessageEncodingBindingElement
Implements

Remarks

Encoding is the process of transforming a message into a sequence of bytes. Decoding is the reverse process. Windows Communication Foundation (WCF) includes three types of encoding for SOAP messages: Text, Binary and Message Transmission Optimization Mechanism (MTOM).

The text encoding represented by the TextMessageEncodingBindingElement is the most interoperable, but the least efficient encoder for XML messages. Web service or Web service client can generally understand textual XML. However, transmitting large blocks of binary data as text is not efficient.

For more information about the binding element that specifies messages are encoded using the .NET Binary Format for XML, see BinaryMessageEncodingBindingElement.

For more information about the binding element that specifies messages are encoded using the MTOM message encoding, see MtomMessageEncodingBindingElement.

For more information about how to implement a custom message encoder, use the MessageEncodingBindingElement class.

Constructors

TextMessageEncodingBindingElement()

Initializes a new instance of the TextMessageEncodingBindingElement class.

TextMessageEncodingBindingElement(MessageVersion, Encoding)

Initializes a new instance of the TextMessageEncodingBindingElement class with a specified message version and encoding.

Properties

MaxReadPoolSize

Gets or sets the number of readers that are allocated to a pool and ready for use to process incoming messages.

MaxWritePoolSize

Gets or sets the number of writers that are allocated to a pool and ready for use to process outgoing messages.

MessageVersion

Gets or sets the SOAP and WS-Addressing versions that are used to format the text message.

ReaderQuotas

Gets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.

WriteEncoding

Gets or sets the encoding that is used to format the characters in the text message.

Methods

BuildChannelFactory<TChannel>(BindingContext)

Builds the channel factory stack on the client that creates a specified type of channel for a specified context.

BuildChannelListener<TChannel>(BindingContext)

Builds the channel listener on the service that accepts a specified type of channel for a specified context.

BuildChannelListener<TChannel>(BindingContext)

Initializes a channel listener to accept channels of a specified type from the binding context.

(Inherited from BindingElement)
CanBuildChannelFactory<TChannel>(BindingContext)

Returns a value that indicates whether the binding element can build a channel factory for a specific type of channel.

(Inherited from BindingElement)
CanBuildChannelListener<TChannel>(BindingContext)

Returns a value that indicates whether the current binding can build a listener for a specified type of channel and context.

CanBuildChannelListener<TChannel>(BindingContext)

Returns a value that indicates whether the binding element can build a listener for a specific type of channel.

(Inherited from BindingElement)
Clone()

Creates a new TextMessageEncodingBindingElement object initialized from the current one.

CreateMessageEncoderFactory()

Creates a factory for text message encoders that employs the message version and character encoding specified by the current encoding binding element.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetProperty<T>(BindingContext)

Returns a typed object requested, if present, from the appropriate layer in the binding element stack.

GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ShouldSerializeReaderQuotas()

Returns whether the constraints placed on the complexity of SOAP message structure should be serialized.

ShouldSerializeWriteEncoding()

Returns whether the Encoding that is used to format the message characters should be serialized.

ToString()

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

IPolicyExportExtension.ExportPolicy(MetadataExporter, PolicyConversionContext)

Generates WSDL contract information from encoding policies contained in the binding element.

IWsdlExportExtension.ExportContract(WsdlExporter, WsdlContractConversionContext)

Generates WSDL contract information from encoding policies contained in the binding element.

IWsdlExportExtension.ExportEndpoint(WsdlExporter, WsdlEndpointConversionContext)

Generates WSDL contract information from encoding policies contained in the binding element.

Applies to