XmlTypeAttribute Class
Controls the XML schema that is generated when the attribute target is serialized by the XmlSerializer.
Assembly: System.Xml (in System.Xml.dll)
The XmlTypeAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | 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. |
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | 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. |
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
![]() ![]() ![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() ![]() | 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 | 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.) |
| Name | Description | |
|---|---|---|
![]() ![]() | _Attribute::GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
![]() ![]() | _Attribute::Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
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 Extending Metadata Using Attributes.
Note |
|---|
You can use the word XmlType in your code instead of the longer XmlTypeAttribute. |
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; };
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

