XmlWriter.WriteStartAttribute Method

Definition

When overridden in a derived class, writes the start of an attribute.

Overloads

WriteStartAttribute(String, String, String)

When overridden in a derived class, writes the start of an attribute with the specified prefix, local name, and namespace URI.

WriteStartAttribute(String)

Writes the start of an attribute with the specified local name.

WriteStartAttribute(String, String)

Writes the start of an attribute with the specified local name and namespace URI.

Remarks

For the asynchronous version of this method, see WriteStartAttributeAsync.

WriteStartAttribute(String, String, String)

Source:
XmlWriter.cs
Source:
XmlWriter.cs
Source:
XmlWriter.cs

When overridden in a derived class, writes the start of an attribute with the specified prefix, local name, and namespace URI.

public abstract void WriteStartAttribute (string prefix, string localName, string ns);
public abstract void WriteStartAttribute (string? prefix, string localName, string? ns);

Parameters

prefix
String

The namespace prefix of the attribute.

localName
String

The local name of the attribute.

ns
String

The namespace URI for the attribute.

Exceptions

There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

Remarks

This method enables you to write a value using multiple Write methods.

For the asynchronous version of this method, see WriteStartAttributeAsync.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

WriteStartAttribute(String)

Source:
XmlWriter.cs
Source:
XmlWriter.cs
Source:
XmlWriter.cs

Writes the start of an attribute with the specified local name.

public void WriteStartAttribute (string localName);

Parameters

localName
String

The local name of the attribute.

Exceptions

The writer is closed.

-or-

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.

Remarks

This method enables you to write a value using multiple Write methods.

For the asynchronous version of this method, see WriteStartAttributeAsync.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

WriteStartAttribute(String, String)

Source:
XmlWriter.cs
Source:
XmlWriter.cs
Source:
XmlWriter.cs

Writes the start of an attribute with the specified local name and namespace URI.

public void WriteStartAttribute (string localName, string ns);
public void WriteStartAttribute (string localName, string? ns);

Parameters

localName
String

The local name of the attribute.

ns
String

The namespace URI of the attribute.

Exceptions

There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

Examples

See XmlTextWriter.WriteStartAttribute for an example using this method.

Remarks

This is a more advanced version of WriteAttributeString that allows you to write an attribute value using multiple write methods, such as WriteString, WriteQualifiedName, and so on.

For the asynchronous version of this method, see WriteStartAttributeAsync.

See also

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0