Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
WebMessageEncodingElement Class
Collapse the table of content
Expand the table of content

WebMessageEncodingElement Class

Represents the configuration element that specifies the character encoding used for non-SOAP messages. This class cannot be inherited.

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

public sealed class WebMessageEncodingElement : BindingElementExtensionElement

The WebMessageEncodingElement type exposes the following members.

Public methodWebMessageEncodingElementInitializes a new instance of the WebMessageEncodingElement class.

Public propertyBindingElementTypeGets the type of the binding element enabled by this configuration element. (Overrides BindingElementExtensionElement.BindingElementType.)
Public propertyConfigurationElementNameGets the name of this configuration element. (Inherited from ServiceModelExtensionElement.)
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected propertyItem[String]Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Public propertyMaxReadPoolSizeGets or sets a value that specifies the maximum number of messages that can be read simultaneously without allocating new readers.
Public propertyMaxWritePoolSizeGets or sets a value that specifies the maximum number of messages that can be sent simultaneously without allocating new writers.
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Public propertyReaderQuotasGets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.
Public propertyWebContentTypeMapperTypeGets or sets the type name of a WebContentTypeMapper that specifies the format to which the content type of an incoming message is mapped.
Public propertyWriteEncodingGets or sets the character set encoding to be used for emitting messages on the binding.

Public methodApplyConfigurationApplies the content of a specified binding element to this binding configuration section. (Overrides BindingElementExtensionElement.ApplyConfiguration(BindingElement).)
Public methodCopyFromCopies the content of the specified configuration section to this element. (Overrides ServiceModelExtensionElement.CopyFrom(ServiceModelExtensionElement).)
Protected methodCreateBindingElementWhen overridden in a derived class, returns a custom binding element object. (Inherited from BindingElementExtensionElement.)
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
Public methodGetHashCodeGets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodInitializeFromInitializes this binding configuration section with the content of the specified binding element. (Inherited from BindingElementExtensionElement.)
Protected methodIsModifiedIndicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected methodResetResets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
Protected methodResetModifiedResets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeElementWrites the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlySets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeModifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)

Encoding is the process of transforming a set of Unicode characters into a sequence of bytes. The types of encoding for non-SOAP messages are text, JSON and raw.

The WebMessageEncodingElement represents the WebMessageEncodingBindingElement in configuration. The WebMessageEncodingBindingElement provides the extensibility point for plugging in a composite encoder that can be used to override how incoming message content-types map to the various inner encoders (text/JSON/raw binary) provided by Windows Communication Foundation (WCF). The composite message encoder does not support SOAP or WS-Addressing.

using System;
using System.Text;
using System.ServiceModel;
using System.ServiceModel.Web;
using System.ServiceModel.Configuration;

class Program
  static void Main(string[] args)
      WebMessageEncodingElement webMEE = new WebMessageEncodingElement();
      Console.WriteLine("The BE type is: {0}", webMEE.BindingElementType);

      int maxReadPoolSize = webMEE.MaxReadPoolSize;
      Console.WriteLine("The MaxReadPoolSize is: {0}", maxReadPoolSize);
      maxReadPoolSize = 128;
      Console.WriteLine("The MaxReadPoolSize has been changed to: {0}", maxReadPoolSize);

      int maxWritePoolSize = webMEE.MaxWritePoolSize;
      Console.WriteLine("The MaxWritePoolSize is: {0}", maxWritePoolSize);
      maxWritePoolSize = 48;
      Console.WriteLine("The MaxWritePoolSize has been changed to: {0}", maxWritePoolSize);

      Encoding webMessageEncoding = webMEE.WriteEncoding;
      Console.WriteLine("The write encoding is: {0}", webMessageEncoding);
      webMessageEncoding = UnicodeEncoding.Unicode;
      Console.WriteLine("The write encoding has been changed to: {0}", webMessageEncoding);

      XmlDictionaryReaderQuotasElement webMessageReaderQuotasElement = webMEE.ReaderQuotas;
      Console.WriteLine("The max depth of the reader Quotas is: {0}", webMessageReaderQuotasElement.MaxDepth);

      Console.WriteLine("Press <ENTER> to terminate the program.");

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 3.5 SP1

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