• Article

XElement.SetElementValue Method

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

Sets the value of a child element, adds a child element, or removes a child element.

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

Syntax

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

public void SetElementValue(
    XName name,
    Object value
)

Parameters

  • value
    Type: System.Object
    The value to assign to the child element. The child element is removed if the value is nulla null reference (Nothing in Visual Basic). Otherwise, the value is converted to its string representation and assigned to the Value property of the child element.

Exceptions

Exception Condition
ArgumentException

The value is an instance of XObject.

Remarks

This method is designed to make it easy to maintain a list of name/value pairs as a set of children elements. 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 a child element, this method creates a child element for you. If you call this method passing the name of an existing child element, this method modifies the value of the child element to the value that you specify. If you pass nulla null reference (Nothing in Visual Basic) for value, this method removes the child element.

This method will raise events.

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

This method does not add child nodes or attributes to the specified child element. This method throws an exception if any object that derives from XObject is passed as value.

For more information, see Maintaining Name/Value Pairs in the .NET Framework documentation.

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.