XElement.SetAttributeValue(XName, Object) Method

Definition

Namespace:

System.Xml.Linq

Assembly:

System.Xml.XDocument.dll

Source:

XElement.cs

Sets the value of an attribute, adds an attribute, or removes an attribute.

public:
 void SetAttributeValue(System::Xml::Linq::XName ^ name, System::Object ^ value);

public void SetAttributeValue (System.Xml.Linq.XName name, object? value);

member this.SetAttributeValue : System.Xml.Linq.XName * obj -> unit

Public Sub SetAttributeValue (name As XName, value As Object)

Parameters

name

XName

An XName that contains the name of the attribute to change.

value

Object

The value to assign to the attribute. The attribute is removed if the value is null. Otherwise, the value is converted to its string representation and assigned to the Value property of the attribute.

Exceptions

ArgumentException

The value is an instance of XObject.

Examples

The following example creates an element with an attribute. It then uses this method to replace the content of the attribute.

// Create an element with no content.
XElement root = new XElement("Root");

// Add some name/value pairs.
root.SetAttributeValue("Att1", 1);
root.SetAttributeValue("Att2", 2);
root.SetAttributeValue("Att3", 3);
Console.WriteLine(root);

// Modify one of the name/value pairs.
root.SetAttributeValue("Att2", 22);
Console.WriteLine(root);

// Remove one of the name/value pairs.
root.SetAttributeValue("Att3", null);
Console.WriteLine(root);

' Create an element with no content.
Dim root As XElement = <Root/>

' Add some name/value pairs.
root.SetAttributeValue("Att1", 1)
root.SetAttributeValue("Att2", 2)
root.SetAttributeValue("Att3", 3)
Console.WriteLine(root)

' Modify one of the name/value pairs.
root.SetAttributeValue("Att2", 22)
Console.WriteLine(root)

' Remove one of the name/value pairs.
root.SetAttributeValue("Att3", Nothing)
Console.WriteLine(root)

This example produces the following output:

<Root Att1="1" Att2="2" Att3="3" />
<Root Att1="1" Att2="22" Att3="3" />
<Root Att1="1" Att2="22" />

Remarks

This method is designed to make it easy to maintain a list of name/value pairs as a set of attributes. When maintaining the list, you need to add pairs, modify pairs, or delete pairs. If you call this method passing a name that does not exist as an attribute, this method creates an attribute for you. If you call this method passing the name of an existing attribute, this method modifies the value of the attribute to the value that you specify. If you pass null for value, this method removes the attribute.

This method will raise the Changed and the Changing events.

The value is assigned to the attribute with the specified name. If no attribute with the specified name exists, a new attribute is added. If the value is null, the attribute with the specified name, if any, is deleted.

For more information, see Maintain name-value pairs.

See also

• SetValue(Object)
• SetElementValue(XName, Object)
• SetValue(Object)
• LINQ to XML overview
• Maintain name-value pairs