Export (0) Print
Expand All

XmlChoiceIdentifierAttribute.MemberName Property

Gets or sets the name of the field that returns the enumeration to use when detecting types.

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

public string MemberName { get; set; }
/** @property */
public String get_MemberName ()

/** @property */
public void set_MemberName (String value)

public function get MemberName () : String

public function set MemberName (value : String)

Not applicable.

Property Value

The name of a field that returns an enumeration.

At least one member must be present in the enumeration returned by the field named in the MemberName value. By default, that enumeration name takes the name of the field that the XmlChoiceIdentifierAttribute is applied to.

The following example serializes a class named Choices that includes two fields, MyChoice and ManyChoices. The XmlChoiceIdentifierAttribute is applied to each field that specifies (through the MemberName property) another class member that gets or sets an enumeration that detects the member value. The MyChoice field can be set to a single value, with a corresponding enumeration member found in the EnumType field. The ManyChoices field returns an array of objects. The ChoiceArray field returns an array of enumeration values. For each array member in the ManyChoices field, a corresponding member is found in the array returned by the ChoiceArray field.

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());
      	}
      
   }
}

import System.*;
import System.Xml.*;
import System.Xml.Serialization.*;
import System.IO.*;
public class Choices
{
    // The myChoice field can be set to any one of 
    // the types below. 
    /** @attribute XmlElement("word", String.class)
     */
    /** @attribute XmlElement("Number", int.class)
     */
    /** @attribute XmlElement("DecimalNumber", double.class)
     */
    public Object myChoice;

    // Don't serialize this field. The EnumType field
    // contains the enumeration value that corresponds
    // to the myChoice field value.
    public int enumType;

    // The manyChoices field can contain an array
    // of choices. Each choice must be matched to
    // an array item in the choiceArray field.
    /** @attribute XmlElement("Item", String.class)
     */
    /** @attribute XmlElement("amount", int.class)
     */
    /** @attribute XmlElement("temp", double.class)
     */
    public Object manyChoices[];

    // ThechoiceArray field contains the enumeration
    // values, one for each item in the manyChoices array.
    public int choiceArray[];
} //Choices

/** @attribute XmlType(IncludeInSchema = false)
 */
public class ItemChoiceType
{
    public static final int none = 0;
    public static final int word = 1;
    public static final int number = 2;
    public static final int decimalNumber = 3;
} //ItemChoiceType

public class MoreChoices
{
    public static final int none = 0;
    public static final int item = 1;
    public static final int amount = 2;
    public static final int temp = 3;
} //MoreChoices

public class Test
{
    public static void main(String[] args)
    {
        Test t = new Test();
        t.SerializeObject("Choices.xml");
        t.DeserializeObject("Choices.xml");
    } //main

    private void SerializeObject(String fileName)
    {
        XmlSerializer mySerializer = new XmlSerializer(Choices.class.ToType());
        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", (Int32)5,
            (System.Double)98.6 };
        myChoices.manyChoices = strChoices;
        // For each item in the manyChoices array, add an
        // enumeration value.
        int itmChoices[] = new int[] {
            MoreChoices.item, MoreChoices.amount, MoreChoices.temp
        };

        myChoices.choiceArray = new int[itmChoices.get_Length()];
        itmChoices.CopyTo(myChoices.choiceArray, 0);

        //myChoices.choiceArray = itmChoices;
        mySerializer.Serialize(writer, myChoices);
        writer.Close();
    } //SerializeObject

    private void DeserializeObject(String fileName)
    {
        XmlSerializer ser = new XmlSerializer(Choices.class.ToType());
        // 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.get_Length(); i++) {
            if (System.Convert.ToInt32(myChoices.choiceArray.get_Item(i)) ==
                MoreChoices.item) {
                Console.WriteLine("Item: " 
                    + (String)(myChoices.manyChoices.get_Item(i)));
            }
            else {
                if (System.Convert.ToInt32(myChoices.choiceArray.
                    get_Item(i)) == MoreChoices.amount) {
                    Console.WriteLine("Amount: " +
                        myChoices.manyChoices.get_Item(i).ToString());
                }
            }
            if (System.Convert.ToInt32(myChoices.choiceArray.
                get_Item(i)) == MoreChoices.temp) {
                Console.WriteLine("Temp: " + (String)(
                    myChoices.manyChoices.get_Item(i).ToString()));
            }
        }
    } //DeserializeObject 
} //Test

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2015 Microsoft