XmlRootAttribute Class
Controls XML serialization of the attribute target as an XML root element.
Assembly: System.Xml (in System.Xml.dll)
The XmlRootAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | XmlRootAttribute() | Initializes a new instance of the XmlRootAttribute class. |
![]() ![]() ![]() | XmlRootAttribute(String) | Initializes a new instance of the XmlRootAttribute class and specifies the name of the XML root element. |
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | DataType | Gets or sets the XSD data type of the XML root element. |
![]() ![]() ![]() | ElementName | Gets or sets the name of the XML element that is generated and recognized by the XmlSerializer class's Serialize and Deserialize methods, respectively. |
![]() ![]() ![]() | IsNullable | Gets or sets a value that indicates whether the XmlSerializer must serialize a member that is set to nullptr into the xsi:nil attribute set to true. |
![]() ![]() | IsNullableSpecified | Gets whether the xsi:nil attribute has been set to true. |
![]() ![]() ![]() | Namespace | Gets or sets the namespace for the XML root element. |
![]() | TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
| 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 XmlRootAttribute 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 XmlRootAttribute to a class, structure, enumeration, or interface. You can also apply the attribute to the return value of an XML Web service method.
Every XML document must have a single root element that contains all the other elements. The XmlRootAttribute allows you to control how the XmlSerializer generates the root element by setting certain properties. For example, specify the name of the generated XML element by setting the ElementName property.
For more information about using attributes, see Extending Metadata Using Attributes.
Note |
|---|
You can use the word XmlRoot in your code instead of the longer XmlRootAttribute. |
The following example applies the XmlRootAttribute to a class. The attribute specifies the element name, namespace, and whether the element is qualified, and whether the xsi:nil attribute is generated if the class is set to nullptr.
#using <System.Xml.dll> #using <System.dll> using namespace System; using namespace System::IO; using namespace System::Xml; using namespace System::Xml::Schema; using namespace System::Xml::Serialization; [XmlRoot(Namespace="www.contoso.com", ElementName="MyGroupName", DataType="string", IsNullable=true)] public ref class Group { private: String^ groupNameValue; public: // Insert code for the Group class. Group(){} Group( String^ groupNameVal ) { groupNameValue = groupNameVal; } property String^ GroupName { String^ get() { return groupNameValue; } void set( String^ value ) { groupNameValue = value; } } }; void SerializeGroup() { // Create an instance of the Group class, and an // instance of the XmlSerializer to serialize it. Group^ myGroup = gcnew Group( "Redmond" ); XmlSerializer^ ser = gcnew XmlSerializer( Group::typeid ); // A FileStream is used to write the file. FileStream^ fs = gcnew FileStream( "group.xml",FileMode::Create ); ser->Serialize( fs, myGroup ); fs->Close(); Console::WriteLine( myGroup->GroupName ); Console::WriteLine( "Done" ); Console::ReadLine(); } int main() { SerializeGroup(); }
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.

