WebMessageEncodingElement 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 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

NameDescription
System_CAPS_pubmethodWebMessageEncodingElement()

Initializes a new instance of the WebMessageEncodingElement class.

NameDescription
System_CAPS_pubpropertyBindingElementType

Gets the type of the binding element enabled by this configuration element.(Overrides BindingElementExtensionElement.BindingElementType.)

System_CAPS_pubpropertyConfigurationElementName

Gets the name of this configuration element.(Inherited from ServiceModelExtensionElement.)

System_CAPS_pubpropertyCurrentConfiguration

Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyElementInformation

Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)

System_CAPS_protpropertyElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.(Inherited from ConfigurationElement.)

System_CAPS_protpropertyItem[ConfigurationProperty]

Gets or sets a property or attribute of this configuration element.(Inherited from ConfigurationElement.)

System_CAPS_protpropertyItem[String]

Gets or sets a property, attribute, or child element of this configuration element.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAllAttributesExcept

Gets the collection of locked attributes.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAllElementsExcept

Gets the collection of locked elements.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAttributes

Gets the collection of locked attributes (Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockElements

Gets the collection of locked elements.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockItem

Gets or sets a value indicating whether the element is locked.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyMaxReadPoolSize

Gets or sets a value that specifies the maximum number of messages that can be read simultaneously without allocating new readers.

System_CAPS_pubpropertyMaxWritePoolSize

Gets or sets a value that specifies the maximum number of messages that can be sent simultaneously without allocating new writers.

System_CAPS_protpropertyProperties

Gets the collection of properties.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyReaderQuotas

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

System_CAPS_pubpropertyWebContentTypeMapperType

Gets or sets the type name of a WebContentTypeMapper that specifies the format to which the content type of an incoming message is mapped.

System_CAPS_pubpropertyWriteEncoding

Gets or sets the character set encoding to be used for emitting messages on the binding.

NameDescription
System_CAPS_pubmethodApplyConfiguration(BindingElement)

Applies the content of a specified binding element to this binding configuration section.(Overrides BindingElementExtensionElement.ApplyConfiguration(BindingElement).)

System_CAPS_pubmethodCopyFrom(ServiceModelExtensionElement)

Copies the content of the specified configuration section to this element.(Overrides ServiceModelExtensionElement.CopyFrom(ServiceModelExtensionElement).)

System_CAPS_protmethodCreateBindingElement()

When overridden in a derived class, returns a custom binding element object. (Inherited from BindingElementExtensionElement.)

System_CAPS_protmethodDeserializeElement(XmlReader, Boolean)

Reads XML from the configuration file.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodEquals(Object)

Compares the current ConfigurationElement instance to the specified object.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodGetHashCode()

Gets a unique value representing the current ConfigurationElement instance.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodGetType()

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

System_CAPS_protmethodInit()

Sets the ConfigurationElement object to its initial state.(Inherited from ConfigurationElement.)

System_CAPS_protmethodInitializeDefault()

Used to initialize a default set of values for the ConfigurationElement object.(Inherited from ConfigurationElement.)

System_CAPS_protmethodInitializeFrom(BindingElement)

Initializes this binding configuration section with the content of the specified binding element.(Inherited from BindingElementExtensionElement.)

System_CAPS_protmethodIsModified()

Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodIsReadOnly()

Gets a value indicating whether the ConfigurationElement object is read-only.(Inherited from ConfigurationElement.)

System_CAPS_protmethodReset(ConfigurationElement)

Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.(Inherited from ConfigurationElement.)

System_CAPS_protmethodResetModified()

Resets the value of the IsModified method to false when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethodSerializeElement(XmlWriter, Boolean)

Writes the contents of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethodSerializeToXmlElement(XmlWriter, String)

Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethodSetReadOnly()

Sets the IsReadOnly property for the ConfigurationElement object and all subelements.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodToString()

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

System_CAPS_protmethodUnmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Modifies 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.");
      Console.ReadLine();
        }
    }

.NET Framework
Available since 3.5

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
Show: