XmlTextAttribute Clase

Definición

Espacio de nombres:

System.Xml.Serialization

Ensamblados:

netstandard.dll, System.Xml.ReaderWriter.dll

Source:

XmlTextAttribute.cs

Indica a XmlSerializer que el miembro debe tratarse como texto XML cuando se serializa o se deserializa la clase contenedora.

C#

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlTextAttribute : Attribute

Herencia

Object

Attribute

XmlTextAttribute

Atributos

AttributeUsageAttribute

Ejemplos

C#

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

public class Group1{
   // The XmlTextAttribute with type set to string informs the
   // XmlSerializer that strings should be serialized as XML text.
   [XmlText(typeof(string))]
   [XmlElement(typeof(int))]
   [XmlElement(typeof(double))]
   public object [] All= new object []{321, "One", 2, 3.0, "Two" };
}

public class Group2{
   [XmlText(Type = typeof(GroupType))]
   public GroupType Type;
}
public enum GroupType{
   Small,
   Medium,
   Large
}

public class Group3{
   [XmlText(Type=typeof(DateTime))]
   public DateTime CreationTime = DateTime.Now;
}

public class Test{
   static void Main(){
      Test t = new Test();
      t.SerializeArray("XmlText1.xml");
      t.SerializeEnum("XmlText2.xml");
      t.SerializeDateTime("XmlText3.xml");
   }

   private void SerializeArray(string filename){
      XmlSerializer ser = new XmlSerializer(typeof(Group1));
      Group1 myGroup1 = new Group1();

      TextWriter writer = new StreamWriter(filename);

      ser.Serialize(writer, myGroup1);
      writer.Close();
   }

   private void SerializeEnum(string filename){
      XmlSerializer ser = new XmlSerializer(typeof(Group2));
      Group2 myGroup = new Group2();
      myGroup.Type = GroupType.Medium;
      TextWriter writer = new StreamWriter(filename);

      ser.Serialize(writer, myGroup);
      writer.Close();
   }

   private void SerializeDateTime(string filename){
      XmlSerializer ser = new XmlSerializer(typeof(Group3));
      Group3 myGroup = new Group3();
      TextWriter writer = new StreamWriter(filename);

      ser.Serialize(writer, myGroup);
      writer.Close();
   }
}

Comentarios

XmlTextAttribute pertenece a una familia de atributos que controla cómo serializa XmlSerializer y deserializa un objeto (a través de sus Serialize métodos y Deserialize ). Para obtener una lista completa de atributos similares, vea Atributos que controlan la serialización XML.

Solo se puede aplicar una instancia de la XmlTextAttribute clase en una clase .

Puede aplicar a XmlTextAttribute campos públicos y propiedades públicas de lectura y escritura que devuelven tipos primitivos y de enumeración.

Puede aplicar a XmlTextAttribute un campo o propiedad que devuelve una matriz de cadenas. También puede aplicar el atributo a una matriz de tipo Object , pero debe establecer la Type propiedad en cadena. En ese caso, las cadenas insertadas en la matriz se serializan como texto XML.

XmlTextAttribute También se puede aplicar a un campo que devuelve una XmlNode matriz de XmlNode objetos o .

De forma predeterminada, serializa XmlSerializer un miembro de clase como un elemento XML. Sin embargo, si aplica a XmlTextAttribute un miembro, XmlSerializer traduce su valor en texto XML. Esto significa que el valor se codifica en el contenido de un elemento XML.

La Herramienta de definición de esquemas XML (Xsd.exe) genera ocasionalmente el elemento XmlTextAttribute al crear clases a partir de un archivo de definición de esquema XML (XSD). Esto ocurre cuando el esquema contiene un complexType objeto con contenido mixto; en ese caso, la clase correspondiente contiene un miembro que devuelve una matriz de cadenas a la que se aplica .XmlTextAttribute Por ejemplo, cuando la Xml Schema Definition herramienta procesa este esquema:

XML

<xs:schema attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace=""   
xmlns:xs="http://www.w3.org/2001/XMLSchema">  
  <xs:element name="LinkList" type="LinkList" />  
  <xs:complexType name="LinkList" mixed="true">  
    <xs:sequence>  
      <xs:element minOccurs="1" maxOccurs="1" name="id" type="xs:int" />  
      <xs:element minOccurs="0" maxOccurs="1" name="name" type="xs:string" />  
      <xs:element minOccurs="0" maxOccurs="1" name="next" type="LinkList" />  
    </xs:sequence>  
  </xs:complexType>  
</xs:schema>  

se genera la siguiente clase (se han quitado espacios adicionales y comentarios):

C#

[System.CodeDom.Compiler.GeneratedCodeAttribute("xsd", "2.0.50727.42")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
[System.Xml.Serialization.XmlRootAttribute(Namespace = "", IsNullable = false)]
public partial class LinkList
{

    private int idField;
    private string nameField;
    private LinkList nextField;
    private string[] textField;

    public int id
    {
        get
        {
            return this.idField;
        }
        set
        {
            this.idField = value;
        }
    }

    public string name
    {
        get
        {
            return this.nameField;
        }
        set
        {
            this.nameField = value;
        }
    }

    public LinkList next
    {
        get
        {
            return this.nextField;
        }
        set
        {
            this.nextField = value;
        }
    }

    [System.Xml.Serialization.XmlTextAttribute()]
    public string[] Text
    {
        get
        {
            return this.textField;
        }
        set
        {
            this.textField = value;
        }
    }
}

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

Nota

Puede usar la palabra XmlText en el código en lugar del más largo XmlTextAttribute.

Constructores

XmlTextAttribute()	Inicializa una nueva instancia de la clase XmlTextAttribute.
XmlTextAttribute(Type)	Inicializa una nueva instancia de la clase XmlTextAttribute.

Propiedades

DataType	Obtiene o establece el tipo de datos XSD (Lenguaje de definición de esquemas XML) del texto generado por XmlSerializer.
Type	Obtiene o establece el tipo del miembro.
TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)

Métodos

Equals(Object)	Devuelve un valor que indica si esta instancia es igual que un objeto especificado. (Heredado de Attribute)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de Attribute)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	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)
Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Se aplica a

Consulte también

• XmlAttributeOverrides
• XmlAttributes
• XmlSerializer
• XmlText
• Introducción a la serialización XML
• Cómo: Especificar un nombre de elemento alternativo para una secuencia XML
• Controlar la serialización XML mediante atributos
• Ejemplos de serialización XML
• Herramienta de definición de esquema XML (Xsd.exe)