Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
SetAttributeValue Method

XElement.SetAttributeValue Method

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

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

'Declaration
Public Sub SetAttributeValue ( _
	name As XName, _
	value As Object _
)

Parameters

name
Type: System.Xml.Linq.XName
An XName that contains the name of the attribute to change.
value
Type: System.Object
The value to assign to the attribute. The attribute is removed if the value is Nothing. Otherwise, the value is converted to its string representation and assigned to the Value property of the attribute.

ExceptionCondition
ArgumentException

The value is an instance of XObject.

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 Nothing 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 Nothing, the attribute with the specified name, if any, is deleted.

For more information, see Maintaining Name/Value Pairs.

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.
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" />

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2015 Microsoft