XmlRootAttribute Class

July 28, 2014

Controls XML serialization of the attribute target as an XML root element.

System.Object
  System.Attribute
    System.Xml.Serialization.XmlRootAttribute

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

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Enum|AttributeTargets.Interface|AttributeTargets.ReturnValue|AttributeTargets.Struct)]
public class XmlRootAttribute : Attribute

The XmlRootAttribute type exposes the following members.

  NameDescription
Public methodXmlRootAttribute()Initializes a new instance of the XmlRootAttribute class.
Public methodXmlRootAttribute(String)Initializes a new instance of the XmlRootAttribute class and specifies the name of the XML root element.
Top

  NameDescription
Public propertyDataTypeGets or sets the XSD data type of the XML root element.
Public propertyElementNameGets or sets the name of the XML element that is generated and recognized by the XmlSerializer class's Serialize and Deserialize methods, respectively.
Public propertyIsNullableGets or sets a value that indicates whether the XmlSerializer must serialize a member that is set to null into the xsi:nil attribute set to true.
Public propertyNamespaceGets or sets the namespace for the XML root element.
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The XmlRootAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object.

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.

NoteNote:

You can use the word XmlRoot in your code instead of the longer XmlRootAttribute.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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