C# xml serialization remove jagged array element name

Question

I have the below classes:

public class MainRequest
{
    private Request _dataField;

    [XmlElementAttribute("Parameters")]
    public Request Parameters
    {
        get
        {
            return _dataField;
        }
        set
        {
            _dataField = value;
        }
    }
}


public class Request
{
    private RequestSize _requestSize;

    private Field[][] _field;

    [XmlElementAttribute(IsNullable = true)]
    public RequestSize RequestSize
    {
        get
        {
            return _requestSize;
        }
        set
        {
            _requestSize = value;
        }
    }

    [XmlArrayItem("BatchEntry")]
    [XmlArrayItemAttribute("ParameterEntry", IsNullable = false, NestingLevel = 1)]
    public Field[][] Batch
    {
        get
        {
            return _field;
        }
        set
        {
            _field = value;
        }
    }
}

public class RequestSize
{
    private string _count;

    private string _value;

    [XmlAttributeAttribute]
    public string Count
    {
        get
        {
            return _count;
        }
        set
        {
            _count = value;
        }
    }

    [XmlTextAttribute]
    public string Value
    {
        get
        {
            return _value;
        }
        set
        {
            _value = value;
        }
    }
}


public class Field
{

    private string _fieldName;

    private string _fieldValue;

    [XmlAttributeAttribute(AttributeName = "name")]
    public string Name
    {
        get
        {
            return _fieldName;
        }
        set
        {
            _fieldName = value;
        }
    }

    [XmlTextAttribute]
    public string Value
    {
        get
        {
            return _fieldValue;
        }
        set
        {
            _fieldValue = value;
        }
    }
}

When they are serialized I get:

<Parameters>
  <RequestSize Count="1">2</RequestSize>
  <Batch>
    <BatchEntry>
      <ParameterEntry name="AAA">111</ParameterEntry>
      <ParameterEntry name="BBB">222</ParameterEntry>
      <ParameterEntry name="CCC">333</ParameterEntry>
    </BatchEntry>
  </Batch>
</Parameters>

I am trying to get rid of the Batch element. What I want the xml to look like is:

<Parameters>
  <RequestSize Count="1">2</RequestSize>
  <BatchEntry>
    <ParameterEntry name="AAA">111</ParameterEntry>
    <ParameterEntry name="BBB">222</ParameterEntry>
    <ParameterEntry name="CCC">333</ParameterEntry>
  </BatchEntry>
</Parameters>

I tried using the XmlElement attribute on the Field[][] but I get an error when I do that:

[XmlElement("Batch")]
public Field[][] Batch
{
    get
    {
        return _field;
    }
    set
    {
        _field = value;
    }
}



Error   97  Cannot convert type 'Field[][]' to 'Field[]'

Is there a way I can serialize the array elements without that top level element name?

I just edited my answer, try it out. I think it should work. — corylulu
– corylulu, Commented Feb 3, 2012 at 21:43

Community · Accepted Answer · 2017-05-23 10:27:13Z

It appears that what you’re trying to accomplish isn’t supported natively; there’s no way of applying an XmlElement attribute to a jagged array. See XmlSerializer bug when serializing collection of collections without root element?

However, what you can do is decompose your Field[][] jagged array into a simple array of a new type – let’s name it Batch – which would in turn contain an array of your Field type. The following code generates the XML you’re after:

public class MainRequest
{
    [XmlElementAttribute("Parameters")]
    public Request Parameters { get; set; }
}

public class Request
{
    [XmlElementAttribute(IsNullable = true)]
    public RequestSize RequestSize { get; set; }

    [XmlElement("BatchEntry")]
    public Batch[] Batches { get; set; }
}

public class RequestSize
{
    [XmlAttributeAttribute]
    public string Count { get; set; }

    [XmlTextAttribute]
    public string Value { get; set; }
}

public class Batch
{
    [XmlElementAttribute("ParameterEntry")]
    public Field[] Fields { get; set; }
}

public class Field
{
    [XmlAttributeAttribute(AttributeName = "name")]
    public string Name { get; set; }

    [XmlTextAttribute]
    public string Value { get; set; }
}

public static void Main(string[] args)
{
    var request = new MainRequest
    {
        Parameters = new Request
        {
            RequestSize = new RequestSize
            {
                Count = "1",
                Value = "2",
            },
            Batches = new Batch[]
            {
                new Batch 
                { 
                    Fields = new Field[] 
                    { 
                        new Field { Name = "AAA", Value = "111"},
                        new Field { Name = "BBB", Value = "222"},
                        new Field { Name = "CCC", Value = "333"},
                    }
                }
            }
        }
    };

    using (var stream = new MemoryStream())
    using (var reader = new StreamReader(stream))
    {
        XmlSerializer serializer = new XmlSerializer(typeof(MainRequest));
        serializer.Serialize(stream, request);

        stream.Seek(0, SeekOrigin.Begin);
        var str = reader.ReadToEnd();
    }
}

Generated XML:

<?xml version="1.0"?>
<MainRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Parameters>
    <RequestSize Count="1">2</RequestSize>
    <BatchEntry>
      <ParameterEntry name="AAA">111</ParameterEntry>
      <ParameterEntry name="BBB">222</ParameterEntry>
      <ParameterEntry name="CCC">333</ParameterEntry>
    </BatchEntry>
  </Parameters>
</MainRequest>

The advantage of this approach is that it would still work if you define multiple batches. For example:

    var request = new MainRequest
    {
        Parameters = new Request
        {
            RequestSize = new RequestSize
            {
                Count = "2",
                Value = "5",
            },
            Batches = new Batch[]
            {
                new Batch 
                { 
                    Fields = new Field[] 
                    { 
                        new Field { Name = "AAA", Value = "111"},
                        new Field { Name = "BBB", Value = "222"},
                        new Field { Name = "CCC", Value = "333"},
                    }
                },
                new Batch 
                { 
                    Fields = new Field[] 
                    { 
                        new Field { Name = "DDD", Value = "444"},
                        new Field { Name = "EEE", Value = "555"},
                    }
                }
            }
        }
    };

…would generate:

<?xml version="1.0"?>
<MainRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Parameters>
    <RequestSize Count="2">5</RequestSize>
    <BatchEntry>
      <ParameterEntry name="AAA">111</ParameterEntry>
      <ParameterEntry name="BBB">222</ParameterEntry>
      <ParameterEntry name="CCC">333</ParameterEntry>
    </BatchEntry>
    <BatchEntry>
      <ParameterEntry name="DDD">444</ParameterEntry>
      <ParameterEntry name="EEE">555</ParameterEntry>
    </BatchEntry>
  </Parameters>
</MainRequest>

Austin Salonen · Accepted Answer · 2012-02-03 21:26:26Z

0

Through experimentation, you'll have to rename Batch to BatchEntry (apparently you cannot combine XmlElement and XmlArrayItem) and then you can you the XmlArrayItem attribute with a name of "ParameterEntry".

This will work:

/* No idea why this a 2-d array... It doesn't match your XML */
[XmlArrayItem("ParameterEntry")]
public Field[] BatchEntry    //was Batch

answered Feb 3, 2012 at 21:26

Austin Salonen

50.4k16 gold badges112 silver badges140 bronze badges

Comments

corylulu · Accepted Answer · 2012-02-03 22:01:23Z

0

Try something like

    [XmlIgnore]
    public Field[][] Batch
    {
        get
        {
            return _field;
        }
        set
        {
            _field = value;
        }
    }
    [XmlArrayItemAttribute("ParameterEntry", IsNullable = false)]
    public Field[] BatchEntry
    {
        get
        {
            List<Field> OneDimFields = new List<Field>();
            foreach(Field[] field in _field)
            {
                OneDimFields.AddRange(field);
            }
            return OneDimFields.ToArray(); 
        }
    }

edited Feb 3, 2012 at 22:01

answered Feb 3, 2012 at 21:32

corylulu

3,5091 gold badge22 silver badges36 bronze badges

Collectives™ on Stack Overflow

C# xml serialization remove jagged array element name

3 Answers 3

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related