Edit

Share via


XmlSerializerFormatAttribute Class

Definition

Instructs the Windows Communication Foundation (WCF) infrastructure to use the XmlSerializer instead of the XmlObjectSerializer.

public ref class XmlSerializerFormatAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface | System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)]
public sealed class XmlSerializerFormatAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface | System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)>]
type XmlSerializerFormatAttribute = class
    inherit Attribute
Public NotInheritable Class XmlSerializerFormatAttribute
Inherits Attribute
Inheritance
XmlSerializerFormatAttribute
Attributes

Examples

The following example applies the XmlSerializerFormatAttribute to an interface.

[ServiceContract, XmlSerializerFormat(Style = OperationFormatStyle.Rpc,
    Use = OperationFormatUse.Encoded)]
public interface ICalculator
{
    [OperationContract, XmlSerializerFormat(Style = OperationFormatStyle.Rpc,
        Use = OperationFormatUse.Encoded)]
    double Add(double a, double b);
}
<ServiceContract(), XmlSerializerFormat(Style := OperationFormatStyle.Rpc, _
   Use := OperationFormatUse.Encoded)>  _
Public Interface ICalculator
    <OperationContract(), XmlSerializerFormat(Style := OperationFormatStyle.Rpc, _
        Use := OperationFormatUse.Encoded)>  _
    Function Add(ByVal a As Double, ByVal b As Double) As Double 
End Interface

Remarks

This attribute is similar to the DataContractFormatAttribute attribute. Both attributes can be applied to a method, class, or interface.

For more information about the XmlSerializer, see Using the XmlSerializer Class.

A method can have either of the two attributes applied, but not both. Any operation that has neither applied uses the attribute applied to the containing class. If the containing class does not have either attribute applied, the DataContractSerializer is used.

Applying the attribute also causes a XmlSerializerOperationBehavior to be created at runtime. The behavior allows customization at runtime of the serializer behavior.

Constructors

XmlSerializerFormatAttribute()

Initializes a new instance of the XmlSerializerFormatAttribute class.

Properties

Style

Gets or sets the SOAP style of the XmlSerializer.

SupportFaults

Gets or sets a value that indicates that the XmlSerializer should be used for reading and writing faults.

TypeId

When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
Use

Gets or sets a value that specifies the format to use.

Methods

Equals(Object)

Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Returns the hash code for this instance.

(Inherited from Attribute)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See also