XmlTypeAttribute Class

Definition

Namespace:

System.Xml.Serialization

Assembly:

System.Xml.XmlSerializer.dll

Source:

XmlTypeAttribute.cs

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

public ref class XmlTypeAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Interface | System.AttributeTargets.Struct)]
public class XmlTypeAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Interface | System.AttributeTargets.Struct)>]
type XmlTypeAttribute = class
    inherit Attribute

Public Class XmlTypeAttribute
Inherits Attribute

Inheritance

Object

Attribute

XmlTypeAttribute

Attributes

AttributeUsageAttribute

Examples

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

[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;
};

[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 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

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.

Note

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 Attributes.

Note

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

Constructors

XmlTypeAttribute()	Initializes a new instance of the XmlTypeAttribute class.
XmlTypeAttribute(String)	Initializes a new instance of the XmlTypeAttribute class and specifies the name of the XML type.

Properties

AnonymousType	Gets or sets a value that determines whether the resulting schema type is an XSD anonymous type.
IncludeInSchema	Gets or sets a value that indicates whether to include the type in XML schema documents.
Namespace	Gets or sets the namespace of the XML type.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)
TypeName	Gets or sets the name of the XML type.

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)

See also

• XmlAttributeOverrides
• XmlAttributes
• XmlSerializer
• XmlText
• Introducing XML Serialization
• How to: Specify an Alternate Element Name for an XML Stream
• Controlling XML Serialization Using Attributes
• Examples of XML Serialization