• Article

XmlWriter.WriteAttributeString Method (String, String)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

When overridden in a derived class, writes out the attribute with the specified local name and value.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)

Syntax

'Declaration
Public Sub WriteAttributeString ( _
    localName As String, _
    value As String _
)

public void WriteAttributeString(
    string localName,
    string value
)

Parameters

Exceptions

Exception Condition
InvalidOperationException

The state of writer is not WriteState.Element or writer is closed.
ArgumentException

The xml:space or xml:lang attribute value is invalid.

Remarks

WriteAttributeString does the following:

  • If the attribute value includes double or single quotes, they are replaced with " and ' respectively.

  • If writing an xml:space attribute, the writer verifies the attribute value is valid. (Valid values are preserve or default.)

  • If writing an xml:lang attribute, the writer does not verify that the attribute value is valid according to the W3C XML 1.0 recommendation.

Examples

Dim output As New StringBuilder()

Dim settings As New XmlWriterSettings()
settings.Indent = True
Using writer As XmlWriter = XmlWriter.Create(output, settings)

    ' Write the root element.
    writer.WriteStartElement("order")

    ' Write an element with attributes.
    writer.WriteStartElement("item")
    writer.WriteAttributeString("date", "2/19/01")
    writer.WriteAttributeString("orderID", "136A5")

    ' Write a full end element. Because this element has no
    ' content, calling WriteEndElement would have written a
    ' short end tag '/>'.
    writer.WriteFullEndElement()

    writer.WriteEndElement()

    ' Write the XML to file and close the writer
End Using
OutputTextBlock.Text = output.ToString()


StringBuilder output = new StringBuilder();

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
using (XmlWriter writer = XmlWriter.Create(output, settings))
{
    // Write the root element.
    writer.WriteStartElement("order");

    // Write an element with attributes.
    writer.WriteStartElement("item");
    writer.WriteAttributeString("date", "2/19/01");
    writer.WriteAttributeString("orderID", "136A5");

    // Write a full end element. Because this element has no
    // content, calling WriteEndElement would have written a
    // short end tag '/>'.
    writer.WriteFullEndElement();

    writer.WriteEndElement();

    // Write the XML to file and close the writer
}


OutputTextBlock.Text = output.ToString();

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.