.NET Framework Class Library
XmlTypeAttribute Class

Controls the XML schema that is generated when the attribute target is serialized by the XmlSerializer.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Xml.SerializationXmlTypeAttribute

Namespace:   System.Xml.Serialization
Assemblies:   System.Xml (in System.Xml.dll)
  System.Xml.XmlSerializer (in System.Xml.XmlSerializer.dll)
Syntax
<[%$TOPIC/0th2hysa_en-us_VS_110_3_0_0_0_0%]([%$TOPIC/0th2hysa_en-us_VS_110_3_0_0_0_1%].Class Or [%$TOPIC/0th2hysa_en-us_VS_110_3_0_0_0_2%].Struct Or [%$TOPIC/0th2hysa_en-us_VS_110_3_0_0_0_3%].Enum Or [%$TOPIC/0th2hysa_en-us_VS_110_3_0_0_0_4%].Interface)> _
Public Class XmlTypeAttribute _
	Inherits [%$TOPIC/0th2hysa_en-us_VS_110_3_0_0_0_5%]
[[%$TOPIC/0th2hysa_en-us_VS_110_3_0_1_0_0%]([%$TOPIC/0th2hysa_en-us_VS_110_3_0_1_0_1%].Class|[%$TOPIC/0th2hysa_en-us_VS_110_3_0_1_0_2%].Struct|[%$TOPIC/0th2hysa_en-us_VS_110_3_0_1_0_3%].Enum|[%$TOPIC/0th2hysa_en-us_VS_110_3_0_1_0_4%].Interface)]
public class XmlTypeAttribute : [%$TOPIC/0th2hysa_en-us_VS_110_3_0_1_0_5%]
[[%$TOPIC/0th2hysa_en-us_VS_110_3_0_2_0_0%]([%$TOPIC/0th2hysa_en-us_VS_110_3_0_2_0_1%]::Class|[%$TOPIC/0th2hysa_en-us_VS_110_3_0_2_0_2%]::Struct|[%$TOPIC/0th2hysa_en-us_VS_110_3_0_2_0_3%]::Enum|[%$TOPIC/0th2hysa_en-us_VS_110_3_0_2_0_4%]::Interface)]
public ref class XmlTypeAttribute : public [%$TOPIC/0th2hysa_en-us_VS_110_3_0_2_0_5%]
[<[%$TOPIC/0th2hysa_en-us_VS_110_3_0_3_0_0%]([%$TOPIC/0th2hysa_en-us_VS_110_3_0_3_0_1%].Class|[%$TOPIC/0th2hysa_en-us_VS_110_3_0_3_0_2%].Struct|[%$TOPIC/0th2hysa_en-us_VS_110_3_0_3_0_3%].Enum|[%$TOPIC/0th2hysa_en-us_VS_110_3_0_3_0_4%].Interface)>]
type XmlTypeAttribute =  
    class 
        inherit [%$TOPIC/0th2hysa_en-us_VS_110_3_0_3_0_5%] 
    end
public class XmlTypeAttribute extends [%$TOPIC/0th2hysa_en-us_VS_110_3_0_4_0_0%]

The XmlTypeAttribute type exposes the following members.

Constructors
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library XmlTypeAttributeInitializes a new instance of the XmlTypeAttribute class.
Public method Supported by the XNA Framework Supported by Portable Class Library XmlTypeAttribute(String)Initializes a new instance of the XmlTypeAttribute class and specifies the name of the XML type.
Top
Properties
  NameDescription
Public property Supported by the XNA Framework Supported by Portable Class Library AnonymousTypeGets or sets a value that determines whether the resulting schema type is an XSD anonymous type.
Public property Supported by the XNA Framework Supported by Portable Class Library IncludeInSchemaGets or sets a value that indicates whether to include the type in XML schema documents.
Public property Supported by the XNA Framework Supported by Portable Class Library NamespaceGets or sets the namespace of the XML type.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public property Supported by the XNA Framework Supported by Portable Class Library TypeNameGets or sets the name of the XML type.
Top
Methods
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Supported by the XNA Framework Supported by Portable Class Library FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method Supported by the XNA Framework MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

The XmlTypeAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. For a complete list of similar attributes, see Attributes That Control XML Serialization.

You can apply the XmlTypeAttribute to a class, structure, enumeration, or interface declaration.

Apply the XmlTypeAttribute to a class to specify the XML type's namespace, the XML type name, and whether to include the type in the XML schema document. To see the results of setting the properties of the XmlTypeAttribute class, compile your application as an executable or DLL, and pass the resulting file to the XML Schema Definition Tool (Xsd.exe). The tool writes the schema, including the type definition.

NoteNote

If you set the IncludeInSchema property to false, the XML Schema Definition Tool (Xsd.exe) does not include the type in the schema. By default, for each public class, the XSD tool generates a complexType and an element of that type.

For more information about using attributes, see Extending Metadata Using Attributes.

NoteNote

You can use the word XmlType in your code instead of the longer XmlTypeAttribute.

Examples

The following example shows two classes to which the XmlTypeAttribute has been applied.

<XmlType(Namespace := "http://www.cpandl.com", _
 TypeName := "GroupMember")> _
Public Class Person
    Public Name As String 
End Class

<XmlType(Namespace := "http://www.cohowinery.com", _
 TypeName := "GroupAddress")> _ 
Public Class Address

    Public Line1 As String 
    Public Line2 As String 
    Public City As String 
    Public State As String 
    Public Zip As String 
End Class 

Public Class Group
    Public Staff() As Person
    Public Manager As Person
    Public Location As Address
End Class
[XmlType(Namespace = "http://www.cpandl.com",
TypeName = "GroupMember")]
public class Person
{
   public string Name;
}

[XmlType(Namespace = "http://www.cohowinery.com",
TypeName = "GroupAddress")]
public class Address
{
   public string Line1;
   public string Line2;
   public string City;
   public string State;
   public string Zip;
}

public class Group
{
   public Person[] Staff;
   public Person Manager;
   public Address Location;
}

[XmlType(Namespace="http://www.cpandl.com",
TypeName="GroupMember")]
public ref class Person
{
public:
   String^ Name;
};


[XmlType(Namespace="http://www.cohowinery.com",
TypeName="GroupAddress")]
public ref class Address
{
public:
   String^ Line1;
   String^ Line2;
   String^ City;
   String^ State;
   String^ Zip;
};

public ref class Group
{
public:
   array<Person^>^Staff;
   Person^ Manager;
   Address^ Location;
};
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.