WebMessageEncodingElement Class

Definition

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

public ref class WebMessageEncodingElement sealed : System::ServiceModel::Configuration::BindingElementExtensionElement
public sealed class WebMessageEncodingElement : System.ServiceModel.Configuration.BindingElementExtensionElement
type WebMessageEncodingElement = class
    inherit BindingElementExtensionElement
Public NotInheritable Class WebMessageEncodingElement
Inherits BindingElementExtensionElement
Inheritance
Inheritance

Examples

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();  
        }  
    }  

Remarks

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.

Constructors

WebMessageEncodingElement()

Initializes a new instance of the WebMessageEncodingElement class.

Properties

BindingElementType

Gets the type of the binding element enabled by this configuration element.

ConfigurationElementName

Gets the name of this configuration element.

(Inherited from ServiceModelExtensionElement)
CurrentConfiguration

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

(Inherited from ConfigurationElement)
ElementInformation

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

(Inherited from ConfigurationElement)
ElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Inherited from ConfigurationElement)
EvaluationContext

Gets the ContextInformation object for the ConfigurationElement object.

(Inherited from ConfigurationElement)
HasContext

Gets a value that indicates whether the CurrentConfiguration property is null.

(Inherited from ConfigurationElement)
Item[ConfigurationProperty]

Gets or sets a property or attribute of this configuration element.

(Inherited from ConfigurationElement)
Item[String]

Gets or sets a property, attribute, or child element of this configuration element.

(Inherited from ConfigurationElement)
LockAllAttributesExcept

Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockAllElementsExcept

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockAttributes

Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockElements

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockItem

Gets or sets a value indicating whether the element is locked.

(Inherited from ConfigurationElement)
MaxReadPoolSize

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

MaxWritePoolSize

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

Properties

Gets the collection of properties.

(Inherited from ConfigurationElement)
ReaderQuotas

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

WebContentTypeMapperType

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

WriteEncoding

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

Methods

ApplyConfiguration(BindingElement)

Applies the content of a specified binding element to this binding configuration section.

CopyFrom(ServiceModelExtensionElement)

Copies the content of the specified configuration section to this element.

CreateBindingElement()

When overridden in a derived class, returns a custom binding element object.

(Inherited from BindingElementExtensionElement)
DeserializeElement(XmlReader, Boolean)

Reads XML from the configuration file.

(Inherited from ConfigurationElement)
Equals(Object)

Compares the current ConfigurationElement instance to the specified object.

(Inherited from ConfigurationElement)
GetHashCode()

Gets a unique value representing the current ConfigurationElement instance.

(Inherited from ConfigurationElement)
GetTransformedAssemblyString(String)

Returns the transformed version of the specified assembly name.

(Inherited from ConfigurationElement)
GetTransformedTypeString(String)

Returns the transformed version of the specified type name.

(Inherited from ConfigurationElement)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
Init()

Sets the ConfigurationElement object to its initial state.

(Inherited from ConfigurationElement)
InitializeDefault()

Used to initialize a default set of values for the ConfigurationElement object.

(Inherited from ConfigurationElement)
InitializeFrom(BindingElement)

Initializes this binding configuration section with the content of the specified binding element.

(Inherited from BindingElementExtensionElement)
IsModified()

Gets a value that specifies whether this configuration element has been modified.

(Inherited from ServiceModelExtensionElement)
IsReadOnly()

Gets a value indicating whether the ConfigurationElement object is read-only.

(Inherited from ConfigurationElement)
ListErrors(IList)

Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.

(Inherited from ConfigurationElement)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)

Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

Gets a value indicating whether an unknown element is encountered during deserialization.

(Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String)

Throws an exception when a required property is not found.

(Inherited from ConfigurationElement)
PostDeserialize()

Called after deserialization.

(Inherited from ConfigurationElement)
PreSerialize(XmlWriter)

Called before serialization.

(Inherited from ConfigurationElement)
Reset(ConfigurationElement)

Resets the internal state of this configuration element object, including the locks and the properties collections.

(Inherited from ServiceModelExtensionElement)
ResetModified()

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

(Inherited from ConfigurationElement)
SerializeElement(XmlWriter, Boolean)

Writes the contents of this configuration element to the configuration file.

(Inherited from ServiceModelExtensionElement)
SerializeToXmlElement(XmlWriter, String)

Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

Sets a property to the specified value.

(Inherited from ConfigurationElement)
SetPropertyValueIfNotDefaultValue<T>(String, T)

Sets the property value for the configuration element if the value is not the default value.

(Inherited from ServiceModelConfigurationElement)
SetReadOnly()

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

(Inherited from ConfigurationElement)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Modifies the ConfigurationElement object to remove all values that should not be saved.

(Inherited from ConfigurationElement)

Applies to