Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si mueve el puntero del mouse sobre el texto.
Traducción
Inglés

Clase XmlRootAttribute

 

Publicado: noviembre de 2016

Controla la serialización XML del destino de atributo como elemento raíz XML.

Espacio de nombres:   System.Xml.Serialization
Ensamblado:  System.Xml (en System.Xml.dll)

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

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

NombreDescripción
System_CAPS_pubmethodXmlRootAttribute()

Inicializa una nueva instancia de la clase XmlRootAttribute.

System_CAPS_pubmethodXmlRootAttribute(String)

Inicializa una nueva instancia de la XmlRootAttribute clase y especifica el nombre del elemento raíz XML.

NombreDescripción
System_CAPS_pubpropertyDataType

Obtiene o establece el tipo de datos XSD del elemento raíz XML.

System_CAPS_pubpropertyElementName

Obtiene o establece el nombre del elemento XML que se genera y reconoce la XmlSerializer clase Serialize y Deserialize métodos, respectivamente.

System_CAPS_pubpropertyIsNullable

Obtiene o establece un valor que indica si el XmlSerializer debe serializar un miembro que se establece en null en el xsi:nil atributo establecido en true.

System_CAPS_pubpropertyNamespace

Obtiene o establece el espacio de nombres del elemento raíz XML.

System_CAPS_pubpropertyTypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.(Heredado de Attribute).

NombreDescripción
System_CAPS_pubmethodEquals(Object)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Devuelve un valor que indica si esta instancia equivale al objeto especificado. (Heredado de Attribute).

System_CAPS_protmethodFinalize()

Permite que un objeto intente liberar recursos y realizar otras operaciones de limpieza antes de ser reclamado por el recolector de basura. (Heredado de Object).

System_CAPS_pubmethodGetHashCode()

Devuelve el código hash de esta instancia.(Heredado de Attribute).

System_CAPS_pubmethodGetType()

Obtiene el Type de la instancia actual.(Heredado de Object).

System_CAPS_pubmethodIsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.(Heredado de Attribute).

System_CAPS_pubmethodMatch(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual al objeto especificado. (Heredado de Attribute).

System_CAPS_protmethodMemberwiseClone()

Crea una copia superficial del Object actual.(Heredado de Object).

System_CAPS_pubmethodToString()

Devuelve una cadena que representa al objeto actual. (Heredado de Object).

NombreDescripción
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.(Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información del tipo de un objeto, que puede utilizarse para obtener la información del tipo de una interfaz. (Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de tipo de información que suministra un objeto (0 ó 1)

(Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.(Heredado de Attribute).

El XmlRootAttribute pertenece a una familia de atributos que controla cómo el XmlSerializer serializa o deserializa un objeto. Para obtener una lista completa de atributos similares, vea Atributos que controlan la serialización XML.

Puede aplicar el XmlRootAttribute a clase, estructura, enumeración o interfaz. También puede aplicar el atributo para el valor devuelto de un método de servicio Web XML.

Cada documento XML debe tener un elemento raíz único que contiene todos los demás elementos. El XmlRootAttribute le permite controlar cómo el XmlSerializer genera el elemento raíz estableciendo determinadas propiedades. Por ejemplo, especificar el nombre del elemento XML generado estableciendo la ElementName propiedad.

Para obtener más información sobre el uso de atributos, vea Extender metadatos mediante atributos.

System_CAPS_noteNota

Puede utilizar la palabra XmlRoot en el código en lugar de más XmlRootAttribute.

El ejemplo siguiente aplica el XmlRootAttribute a una clase. El atributo especifica el nombre del elemento, espacio de nombres y si el elemento está cualificado y si el xsi:nil se genera el atributo si la clase se establece en null.

using System;
using System.IO;
using System.Xml;
using System.Xml.Schema;
using System.Xml.Serialization;

[XmlRoot(Namespace = "www.contoso.com", 
     ElementName = "MyGroupName", 
     DataType = "string", 
     IsNullable=true)]
public class Group
{
    private string groupNameValue;
    // Insert code for the Group class.
    public Group()
    {
    }

    public Group(string groupNameVal)
    {
        groupNameValue = groupNameVal;
    }

    public string GroupName
    {
        get{return groupNameValue;}
        set{groupNameValue = value;}
    }
}
public class Test
{
    static void Main()
    {
        Test t = new Test();
        t.SerializeGroup();
    }

    private void SerializeGroup()
    {
        // Create an instance of the Group class, and an
        // instance of the XmlSerializer to serialize it.
        Group myGroup = new Group("Redmond");
        XmlSerializer ser = new XmlSerializer(typeof(Group));
        // A FileStream is used to write the file.
        FileStream fs = new FileStream("group.xml",FileMode.Create);
        ser.Serialize(fs,myGroup);
        fs.Close();
        Console.WriteLine(myGroup.GroupName);
        Console.WriteLine("Done");
        Console.ReadLine();
    }
}

Plataforma universal de Windows
Disponible desde 8
.NET Framework
Disponible desde 1.1
Biblioteca de clases portable
Se admite en: plataformas portátiles de .NET
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0
Windows Phone
Disponible desde 8.1

Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Volver al principio
Mostrar: