XmlChoiceIdentifierAttribute Klasse

Definition

Namespace:

System.Xml.Serialization

Assemblys:

netstandard.dll, System.Xml.XmlSerializer.dll

Quelle:

XmlChoiceIdentifierAttribute.cs

Gibt an, dass der Member durch Verwendung einer Enumeration genauer erkannt werden kann.

C#

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=false)]
public class XmlChoiceIdentifierAttribute : Attribute

Vererbung

Object

Attribute

XmlChoiceIdentifierAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird eine Klasse namens Choices serialisiert, die zwei Felder enthält, MyChoice und ManyChoices. Wird XmlChoiceIdentifierAttribute auf jedes Feld angewendet, das (über die MemberName -Eigenschaft) einen anderen Klassenmember angibt, der eine Enumeration abruft oder festlegt, die den Memberwert erkennt. Das MyChoice Feld kann auf einen einzelnen Wert festgelegt werden, wobei sich ein entsprechendes Enumerationselement EnumType im Feld befindet. Das ManyChoices Feld gibt ein Array von -Objekten zurück. Das ChoiceArray Feld gibt ein Array von Enumerationswerten zurück. Für jedes Arraymember im ManyChoices Feld befindet sich ein entsprechendes Element in dem Array, das ChoiceArray vom Feld zurückgegeben wird.

C#

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

public class Choices{
   // The MyChoice field can be set to any one of 
   // the types below. 
   [XmlChoiceIdentifier("EnumType")]
   [XmlElement("Word", typeof(string))]
   [XmlElement("Number", typeof(int))]
   [XmlElement("DecimalNumber", typeof(double))]
   public object MyChoice;

   // Don't serialize this field. The EnumType field
   // contains the enumeration value that corresponds
   // to the MyChoice field value.
   [XmlIgnore]
   public ItemChoiceType EnumType;

   // The ManyChoices field can contain an array
   // of choices. Each choice must be matched to
   // an array item in the ChoiceArray field.
   [XmlChoiceIdentifier("ChoiceArray")]
   [XmlElement("Item", typeof(string))]
   [XmlElement("Amount", typeof(int))]
   [XmlElement("Temp", typeof(double))]
   public object[] ManyChoices;

   // TheChoiceArray field contains the enumeration
   // values, one for each item in the ManyChoices array.
   [XmlIgnore]
   public MoreChoices[] ChoiceArray;
}

[XmlType(IncludeInSchema=false)]
public enum ItemChoiceType{
   None,
   Word, 
   Number,
   DecimalNumber
}

public enum MoreChoices{
   None,
   Item,
   Amount,
   Temp
}

public class Test{
   static void Main(){
      Test t = new Test();
      t.SerializeObject("Choices.xml");
      t.DeserializeObject("Choices.xml");
   }

   private void SerializeObject(string filename){
      XmlSerializer mySerializer = 
      new XmlSerializer(typeof(Choices));
      TextWriter writer = new StreamWriter(filename);
      Choices myChoices = new Choices();

      // Set the MyChoice field to a string. Set the
      // EnumType to Word.
      myChoices.MyChoice= "Book";
      myChoices.EnumType = ItemChoiceType.Word;

      // Populate an object array with three items, one
      // of each enumeration type. Set the array to the 
      // ManyChoices field.
      object[] strChoices = new object[]{"Food",  5, 98.6};
      myChoices.ManyChoices=strChoices;

      // For each item in the ManyChoices array, add an
      // enumeration value.
      MoreChoices[] itmChoices = new MoreChoices[]
      {MoreChoices.Item, 
      MoreChoices.Amount,
      MoreChoices.Temp};
      myChoices.ChoiceArray=itmChoices;
      
      mySerializer.Serialize(writer, myChoices);
      writer.Close();
   }

   private void DeserializeObject(string filename){
      XmlSerializer ser = new XmlSerializer(typeof(Choices));

      // A FileStream is needed to read the XML document.
      FileStream fs = new FileStream(filename, FileMode.Open);
      Choices myChoices = (Choices)
      ser.Deserialize(fs);
      fs.Close();

      // Disambiguate the MyChoice value using the enumeration.
      if(myChoices.EnumType == ItemChoiceType.Word){
           Console.WriteLine("Word: " +  
            myChoices.MyChoice.ToString());
        }
      else if(myChoices.EnumType == ItemChoiceType.Number){
           Console.WriteLine("Number: " +
            myChoices.MyChoice.ToString());
        }
      else if(myChoices.EnumType == ItemChoiceType.DecimalNumber){
           Console.WriteLine("DecimalNumber: " +
            myChoices.MyChoice.ToString());
        }

      // Disambiguate the ManyChoices values using the enumerations.
      for(int i = 0; i<myChoices.ManyChoices.Length; i++){
      if(myChoices.ChoiceArray[i] == MoreChoices.Item)
        Console.WriteLine("Item: " + (string) myChoices.ManyChoices[i]);
      else if(myChoices.ChoiceArray[i] == MoreChoices.Amount)
        Console.WriteLine("Amount: " + myChoices.ManyChoices[i].ToString());
      if(myChoices.ChoiceArray[i] == MoreChoices.Temp)
        Console.WriteLine("Temp: " + (string) myChoices.ManyChoices[i].ToString());
        }
   }
}

Hinweise

Die XML-Schemaelementdefinition namens xsi:choice wird verwendet, um ein komplexes Element zu definieren, das nur ein untergeordnetes Element in einer Instanz enthalten kann (maxoccurs = 1). Dieses untergeordnete Element kann einer von mehreren Typen sein, und es kann einen von mehreren Namen haben. Jeder Name ist einem bestimmten Typ zugeordnet. demselben Typ können jedoch mehrere Namen zugeordnet werden. Aus diesem Grund ist eine Instanz eines solchen Elements nicht eindeutig. Betrachten Sie beispielsweise das folgende Schemafragment, das ein solches undeutliches Element namens MyChoicedefiniert.

<xsd:complexType name="MyChoice">  
 <xsd:sequence>  
 <xsd:choice minOccurs="0" maxOccurs="1">  
 <xsd:element minOccurs="1" maxOccurs="1" name="ChoiceOne" type="xsd:string" />  
 <xsd:element minOccurs="1" maxOccurs="1" name="ChoiceTwo" type="xsd:string" />  
 </xsd:choice>  
 </xsd:sequence>  
</xsd:complexType>  

Mit XmlChoiceIdentifierAttribute können Sie jeder Instanz des Members einen speziellen Enumerationswert zuweisen. Sie müssen die Enumeration entweder selbst erstellen, oder sie kann vom XML-Schemadefinitionstool (Xsd.exe) generiert werden. Der folgende C#-Code zeigt, wie auf XmlChoiceIdentifierAttribute ein Item Feld angewendet wird. Die MemberName -Eigenschaft identifiziert das Feld, das die Enumeration enthält, die weiter verwendet wird, um die Auswahl zu erkennen.

public class Choices{  
 [XmlChoiceIdentifier("ItemType")]  
 [XmlChoiceIdentifier("ChoiceOne")]  
 [XmlChoiceIdentifier("ChoiceTwo")]  
 public string MyChoice;  

 // Do not serialize this next field:  
 [XmlIgnore]  
 public ItemChoiceType ItemType;  
}  
// Do not include this enumeration in the XML schema.  
[XmlType(IncludeInSchema = false)]  
public enum ItemChoiceType{  
 ChoiceOne,  
 ChoiceTwo,  
}  

Wenn dieser Code vorhanden ist, können Sie diese Klasse serialisieren und deserialisieren, indem Sie das ItemType Feld auf eine entsprechende Enumeration festlegen. Wenn Sie z. B. die Choice Klasse serialisieren möchten, sieht der C#-Code wie folgt aus.

Choices mc = new Choices();  
mc.MyChoice = "Item Choice One";  
mc.ItemType = ItemChoiceType.ChoiceOne;  

Beim Deserialisieren sieht der C#-Code wie folgt aus:

MyChoice mc = (MyChoice) myXmlSerializer.Deserialize(myReader);  
if(mc.ItemType == ItemChoiceType.ChoiceOne)  
 {  
     // Handle choice one.  
 }  
if(mc.ItemType == ItemChoiceType.ChoiceTwo)  
 {  
     // Handle choice two.  
 }  
if(mc.ItemType != null)  
 {  
     throw CreateUnknownTypeException(mc.Item);  
 }  

Es gibt ein zweites Szenario, wenn verwendet XmlChoiceIdentifierAttribute wird. Im folgenden Schema ist das Element ein Feld, das ein Array von Elementen zurückgibt (maxOccurs="unbounded"). Das Array kann Objekte der ersten Wahl ("D-a-t-a") und der zweiten Auswahl ("MoreData") enthalten.

<xsd:complexType name="MyChoice">  
 <xsd:sequence>  
 <xsd:choice minOccurs="0" maxOccurs="unbounded">  
 <xsd:element minOccurs="1" maxOccurs="1" name="D-a-t-a" type="xsd:string" />  
 <xsd:element minOccurs="1" maxOccurs="1" name="MoreData" type="xsd:string" />  
 </xsd:choice>  
 </xsd:sequence>  
</xsd:complexType>  

Die resultierende Klasse verwendet dann ein Feld, um ein Array von Elementen zurückzugeben. Für jedes Element im Array muss auch eine entsprechende ItemChoiceType Enumeration gefunden werden. Die übereinstimmenden Enumerationen sind in dem Array enthalten, das ItemsElementName vom Feld zurückgegeben wird.

public class MyChoice {  
 [System.Xml.Serialization.XmlElementAttribute("D-a-t-a", typeof(string), IsNullable=false)]  
 [System.Xml.Serialization.XmlElementAttribute("MoreData", typeof(string), IsNullable=false)]  
 [System.Xml.Serialization.XmlChoiceIdentifierAttribute("ItemsElementName")]  
 public string[] Items;  
 [System.Xml.Serialization.XmlElementAttribute(IsNullable=false)]  
 [System.Xml.Serialization.XmlIgnoreAttribute()]  
 public ItemsChoiceType[] ItemsElementName;  
}  
[System.Xml.Serialization.XmlTypeAttribute(IncludeInSchema=false)]  
public enum ItemsChoiceType {  
 [System.Xml.Serialization.XmlEnumAttribute("D-a-t-a")]  
 Data,  
 MoreData,  
}  

Verwenden Sie beim Deserialisieren eines Objekts, das eine Reihe von Auswahlmöglichkeiten enthält, eine Steuerelementstruktur (z. B. eine if... Dann... else-Struktur), um zu bestimmen, wie ein bestimmter Wert deserialisiert wird. Überprüfen Sie in der Steuerelementstruktur den Enumerationswert, und deserialisieren Sie den Wert entsprechend.

Konstruktoren

XmlChoiceIdentifierAttribute()	Initialisiert eine neue Instanz der XmlChoiceIdentifierAttribute-Klasse.
XmlChoiceIdentifierAttribute(String)	Initialisiert eine neue Instanz der XmlChoiceIdentifierAttribute-Klasse.

Eigenschaften

MemberName	Ruft den Namen des Felds ab, das die Enumeration zurückgibt, mit der Typen bestimmt werden, oder legt diesen fest.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Gilt für:

Weitere Informationen

• XmlAttributes
• Einführung in die XML-Serialisierung
• How to: Angeben eines alternativen Elementnamens für einen XML-Stream.
• Steuern der XML-Serialisierung mit Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)