Click or drag to resize
IMessageFormatter Methods

The IMessageFormatter type exposes the following members.

Methods
  NameDescription
Public methodAppendElement
Creates an array element and appends it to the element on which this IMessageFormatter is operating on.
Public methodAppendValue(Boolean)
Appends the specified value to the element on which this IMessageFormatter is operating.
Public methodAppendValue(Char)
Appends the specified value to the element on which this IMessageFormatter is operating.
Public methodAppendValue(Double)
Appends the specified value to the element on which this IMessageFormatter is operating.
Public methodAppendValue(Int32)
Appends the specified value to the element on which this IMessageFormatter is operating.
Public methodAppendValue(Int64)
Appends the specified value to the element on which this IMessageFormatter is operating.
Public methodAppendValue(Single)
Appends the specified value to the element on which this IMessageFormatter is operating.
Public methodAppendValue(String)
Appends the specified value to the element on which this IMessageFormatter is operating.
Public methodAppendValue(Datetime)
Appends the specified value to the element on which this IMessageFormatter is operating.
Public methodAppendValue(Name)
Appends the specified value to the element on which this IMessageFormatter is operating.
Public methodFormatMessageXml
Formats the message from its XML representation. The behavior is undefined if further formatting is done using this IMessageFormatter.
Public methodPopElement
Undoes the most recent call to PushElement(Name) on this IMessageFormatter and returns the context of the IMessageFormatter to where it was before the call to PushElement(Name). Once PopElement has been called it is invalid to attempt to re-visit the same context.
Public methodPushElement
Changes the level at which this IMessageFormatter is operating to the specified element name. The element name must identify either a choice, a sequence or an array at the current level of the schema or the behavior is undefined.

After this returns the context of the IMessageFormatter is set to the element name in the schema and any calls to SetElement(Name, Boolean), its overrides, or PushElement(Name) are applied at that level.

If name represents an array of scalars then AppendValue(Boolean) or its overrides must be used to add values.

If name represents an array of complex types then AppendElement creates the first entry and sets the context of the IMessageFormatter to that element. Calling AppendElement again will create another entry.

Public methodSetElement(Name, Datetime)
Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
Public methodSetElement(Name, Name)
Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
Public methodSetElement(Name, Boolean)
Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
Public methodSetElement(Name, Byte)
Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
Public methodSetElement(Name, Char)
Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
Public methodSetElement(Name, Double)
Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
Public methodSetElement(Name, Int32)
Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
Public methodSetElement(Name, Int64)
Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
Public methodSetElement(Name, Single)
Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
Public methodSetElement(Name, String)
Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
Public methodSetElementNull
Creates a null element with the specified name.

Note that whether or not fields containing null values are published to subscribers is dependent upon details of the service and the schema configuration.

Top
See Also