Export (0) Print
Expand All

XmlSerializerAssemblyAttribute Class

Applied to a Web service client proxy, enables you to specify an assembly that contains custom-made serializers.

System.Object
  System.Attribute
    System.Xml.Serialization.XmlSerializerAssemblyAttribute

Namespace:  System.Xml.Serialization
Assembly:  System.Xml (in System.Xml.dll)

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface, AllowMultiple = false)]
public sealed class XmlSerializerAssemblyAttribute : Attribute

The XmlSerializerAssemblyAttribute type exposes the following members.

  NameDescription
Public methodXmlSerializerAssemblyAttribute()Initializes a new instance of the XmlSerializerAssemblyAttribute class.
Public methodXmlSerializerAssemblyAttribute(String)Initializes a new instance of the XmlSerializerAssemblyAttribute class with the specified assembly name.
Public methodXmlSerializerAssemblyAttribute(String, String)Initializes a new instance of the XmlSerializerAssemblyAttribute class with the specified assembly name and location of the assembly.
Top

  NameDescription
Public propertyAssemblyNameGets or sets the name of the assembly that contains serializers for a specific set of types.
Public propertyCodeBaseGets or sets the location of the assembly that contains the serializers.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

Use the XmlSerializerAssemblyAttribute to increase the performance of a Web service client application.

A typical method of using this attribute is as follows:

  1. Create a client proxy for a Web service.

  2. Open the machine.config file.

  3. Under the system.diagnostics element, add a value under the <switches> element to keep the compiled files:

    <system.diagnostics>
       <switches>
          <add name="XmlSerialization.Compilation" value="4"/>
       </switches>
    </system.diagnostics>
    
  4. Compile the proxy.

  5. Run the proxy application.

  6. Open a command window and navigate to the \Temp directory used by the XmlSerializer to cache files.

    cd %temp%
    
  7. Find the last file created using the dir command with the /OD switch.

    dir *.vb /OD 
    
  8. Compile the file into an assembly. Name the assembly.

  9. Edit the original proxy code by applying the XmlSerializerAssemblyAttribute to the class. Specify the assembly name, as shown in the following C# code.

    [XmlSerializerAssemblyAttribute(AssemblyName="hello.serializer")]
    public class Hello: System.Web.Services.Protocols.SoapHttpClientProtocol {
       // Proxy code not shown.
    }
    
<XmlSerializerAssemblyAttribute(AssemblyName:="hello.serializer")> _
Public Class Hello
Implements System.Web.Services.Protocols.SoapHttpClientProtocol 
   ' Proxy code not shown.
End Class

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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