TextMessageEncodingBindingElement Class
TOC
Collapse the table of content
Expand the table of content

TextMessageEncodingBindingElement Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

System.Object
  System.ServiceModel.Channels.BindingElement
    System.ServiceModel.Channels.MessageEncodingBindingElement
      System.ServiceModel.Channels.TextMessageEncodingBindingElement

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

'Declaration
Public NotInheritable Class TextMessageEncodingBindingElement _
	Inherits MessageEncodingBindingElement

The TextMessageEncodingBindingElement type exposes the following members.

  NameDescription
Public methodTextMessageEncodingBindingElementInitializes a new instance of the TextMessageEncodingBindingElement class.
Public methodTextMessageEncodingBindingElement(MessageVersion, Encoding)Initializes a new instance of the TextMessageEncodingBindingElement class with a specified message version and encoding.
Top

  NameDescription
Public propertyMessageVersionGets or sets the SOAP and WS-Addressing versions that are used to format the text message. (Overrides MessageEncodingBindingElement.MessageVersion.)
Public propertyWriteEncodingGets or sets the encoding that is used to format the characters in the text message.
Top

  NameDescription
Public methodBuildChannelFactory(Of TChannel)Builds the channel factory stack on the client that creates a specified type of channel for a specified context. (Overrides BindingElement.BuildChannelFactory(Of TChannel)(BindingContext).)
Public methodCanBuildChannelFactory(Of TChannel)Returns a value that indicates whether the binding element can build a channel factory for a specific type of channel. (Inherited from BindingElement.)
Public methodCloneCreates a new TextMessageEncodingBindingElement object initialized from the current one. (Overrides BindingElement.Clone.)
Public methodCreateMessageEncoderFactoryCreates a factory for text message encoders that employs the message version and character encoding specified by the current encoding binding element. (Overrides MessageEncodingBindingElement.CreateMessageEncoderFactory.)
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 the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetProperty(Of T)Returns a typed object requested, if present, from the appropriate layer in the binding element stack. (Overrides MessageEncodingBindingElement.GetProperty(Of T)(BindingContext).)
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.)
Top

Encoding is the process of transforming a message into a sequence of bytes. Decoding is the reverse process. Windows Phone uses Text encoding for SOAP messages.

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

how to implement a custom message encoder, use the MessageEncodingBindingElement class.


	' This is an example of how to create a custom binding with a text encoding and HTTP tansport,
	' and how to create and open a channel for the service endpoint configured with the custom binding.
	Partial Public Class MainPage
		Inherits PhoneApplicationPage
		'Declare a separate UI thread.
		Private uiThread As SynchronizationContext

		Public Sub New()
			InitializeComponent()
		End Sub

		Private Sub Button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)

			'Create a custom binding that uses HTTP and binary message encoding.
			Dim elements = New List(Of BindingElement)()
			elements.Add(New TextMessageEncodingBindingElement())
			elements.Add(New HttpTransportBindingElement())
			Dim binding = New CustomBinding(elements)

			'Create a channel factory for the service endpoint configured with the custom binding.
			Dim cf = New ChannelFactory(Of IService1)(binding, New EndpointAddress("http://localhost:10483/Service1.svc"))


			'Save the synchronized context for the UI thread.
			uiThread = SynchronizationContext.Current

			'Open the channel.
			Dim channel As IService1 = cf.CreateChannel()

			'Invoke the GetPerson method on the service asynchronously. The signature is:
			'IAsyncResult BeginGetPerson(int personId, AsyncCallback callback, object state)
			channel.BeginGetPerson(4, AddressOf GetPersonCallback, channel)

		End Sub

		'Implement the callback. 
		Private Sub GetPersonCallback(ByVal asyncResult As IAsyncResult)
			Dim p As Person = (CType(asyncResult.AsyncState, IService1)).EndGetPerson(asyncResult)

			'Update the UI thread and its output with the result of the method call.
			uiThread.Post(AddressOf UpdateUI, p)

		End Sub

		'Update the result displayed for the GetPerson invocation.
		Private Sub UpdateUI(ByVal state As Object)
			Dim p As Person = CType(state, Person)
			resultPersonName.Text = "The name of the Person is: " & p.Name
			resultPersonAge.Text = "The age of the Person is: " & p.Age
		End Sub



Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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:
© 2017 Microsoft