XmlWriterSettings.NewLineOnAttributes Property

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Source:

XmlWriterSettings.cs

Gets or sets a value indicating whether to write attributes on a new line.

public:
 property bool NewLineOnAttributes { bool get(); void set(bool value); };

public bool NewLineOnAttributes { get; set; }

member this.NewLineOnAttributes : bool with get, set

Public Property NewLineOnAttributes As Boolean

Property Value

Boolean

true to write attributes on individual lines; otherwise, false. The default is false.

Examples

The following example creates an XmlWriter that writes to an XML file and writes each attribute on a new line.

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.OmitXmlDeclaration = true;
settings.NewLineOnAttributes = true;

writer = XmlWriter.Create(Console.Out, settings);

writer.WriteStartElement("order");
writer.WriteAttributeString("orderID", "367A54");
writer.WriteAttributeString("date", "2001-05-03");
writer.WriteElementString("price", "19.95");
writer.WriteEndElement();
    
writer.Flush();

        Dim settings As New XmlWriterSettings()
        settings.Indent = True
        settings.OmitXmlDeclaration = True
        settings.NewLineOnAttributes = True
   
        writer = XmlWriter.Create(Console.Out, settings)

        writer.WriteStartElement("order")
        writer.WriteAttributeString("orderID", "367A54")
        writer.WriteAttributeString("date", "2001-05-03")
        writer.WriteElementString("price", "19.95")
        writer.WriteEndElement()

        writer.Flush()

The sample produces the following output:

<order
  orderID="367A54"
  date="2001-05-03">
  <price>19.95</price>
</order>

Remarks

This property only applies to XmlWriter instances that output text content; otherwise, this setting is ignored.

When NewLineOnAttributes is set to true, each attribute is prepended with a new line and one extra level of indentation.

This setting has no effect when the Indent property value is false.