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 SoapEnumAttribute

 

Publicado: octubre de 2016

Controles de la XmlSerializer serializa un miembro de enumeración.

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

System.Object
  System.Attribute
    System.Xml.Serialization.SoapEnumAttribute

[AttributeUsageAttribute(AttributeTargets.Field)]
public class SoapEnumAttribute : Attribute

NombreDescripción
System_CAPS_pubmethodSoapEnumAttribute()

Inicializa una nueva instancia de la clase SoapEnumAttribute.

System_CAPS_pubmethodSoapEnumAttribute(String)

Inicializa una nueva instancia de la SoapEnumAttribute clase utilizando el nombre de elemento especificado.

NombreDescripción
System_CAPS_pubpropertyName

Obtiene o establece el valor generado en un archivo XML de documentos cuando el XmlSerializer serializa una enumeración o valor reconocido cuando deserializa el miembro de enumeración.

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).

La SoapEnumAttribute clase pertenece a una familia de atributos que controla cómo el XmlSerializer serializa o deserializa un objeto como XML SOAP codificado. El XML resultante se ajusta a la sección 5 del documento del Consorcio WWC (www.w3.org), "Protocolo de acceso simple a objetos (SOAP) 1.1". Para obtener una lista completa de atributos similares, vea Atributos que controlan la serialización SOAP codificada.

Para serializar un objeto como un mensaje SOAP codificado, se debe crear el XmlSerializer mediante un XmlTypeMapping creado con el ImportTypeMapping método de la SoapReflectionImporter clase.

Utilice el SoapEnumAttribute para cambiar la enumeración que la XmlSerializer genera o reconoce (al serializar o deserializar una clase, respectivamente). Por ejemplo, si una enumeración contiene un miembro denominado One, pero prefiere que los resultados XML se denominen Single, aplicar el SoapEnumAttribute al miembro de enumeración y establezca la Name propiedad "Único".

Puede invalidar la Name valor de propiedad de un SoapEnumAttribute mediante la creación de una instancia de la SoapEnumAttribute clase y asignarla a la SoapEnum propiedad de un SoapAttributes. Para obtener más información, consulte el SoapAttributeOverrides general sobre la clase.

Para serializar un objeto como un mensaje SOAP codificado, se debe crear el XmlSerializer mediante un XmlTypeMapping creado con el ImportTypeMapping método de la SoapReflectionImporter clase.

System_CAPS_noteNota

Puede utilizar la palabra SoapEnum en el código en lugar de más SoapEnumAttribute.

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

En el ejemplo siguiente se utiliza el XmlSerializer para serializar una clase denominada Food que incluye una enumeración denominada FoodType. El FoodType se reemplaza la enumeración mediante la creación de un SoapEnumAttribute para cada enumeración y estableciendo la SoapEnum propiedad de un SoapAttributes a la SoapEnumAttribute. El SoapAttributes se agrega a un SoapAttributeOverrides que se utiliza para crear un XmlSerializer.

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

public class Group{
   public string GroupName;
   public GroupType Grouptype;
}

public enum GroupType{
   // Use the SoapEnumAttribute to instruct the XmlSerializer
   // to generate Small and Large instead of A and B.
   [SoapEnum("Small")]
   A,
   [SoapEnum("Large")]
   B
}

public class Run {
   static void Main(){
      Run test= new Run();
      test.SerializeObject("SoapEnum.xml");
      test.SerializeOverride("SoapOverride.xml");
      Console.WriteLine("Fininished writing two files");
   }

     private void SerializeObject(string filename){
      // Create an instance of the XmlSerializer Class.
      XmlTypeMapping mapp  =
      (new SoapReflectionImporter()).ImportTypeMapping(typeof(Group));
      XmlSerializer mySerializer =  new XmlSerializer(mapp);

      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create an instance of the Class that will be serialized.
      Group myGroup = new Group();

      // Set the object properties.
      myGroup.GroupName = ".NET";
      myGroup.Grouptype= GroupType.A;

      // Serialize the Class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup);
       writer.Close();
   }

   private void SerializeOverride(string fileName){
      SoapAttributeOverrides soapOver = new SoapAttributeOverrides();
      SoapAttributes SoapAtts = new SoapAttributes();

      // Add a SoapEnumAttribute for the GroupType.A enumerator.       
      // Instead of 'A'  it will be "West".
      SoapEnumAttribute soapEnum = new SoapEnumAttribute("West");
      // Override the "A" enumerator.
      SoapAtts.SoapEnum = soapEnum;
      soapOver.Add(typeof(GroupType), "A", SoapAtts);

      // Add another SoapEnumAttribute for the GroupType.B enumerator.
      // Instead of //B// it will be "East".
      SoapAtts= new SoapAttributes();
      soapEnum = new SoapEnumAttribute();
      soapEnum.Name = "East";
      SoapAtts.SoapEnum = soapEnum;
      soapOver.Add(typeof(GroupType), "B", SoapAtts);

      // Create an XmlSerializer used for overriding.
      XmlTypeMapping map = 
      new SoapReflectionImporter(soapOver).
      ImportTypeMapping(typeof(Group));
      XmlSerializer ser = new XmlSerializer(map);
      Group myGroup = new Group();
      myGroup.GroupName = ".NET";
      myGroup.Grouptype = GroupType.B;
      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(fileName);
      ser.Serialize(writer, myGroup);
      writer.Close();
   	}
}

.NET Framework
Disponible desde 1.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: