Export (0) Print
Expand All

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)

member SetAttributeValue : 
        name:XName * 
        value:Object -> unit

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 a null reference (Nothing in Visual Basic). 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 a null reference (Nothing in Visual Basic) 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 a null reference (Nothing in Visual Basic), 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.

No code example is currently available or this language may not be supported.

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.5.2, 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft