Export (0) Print
Expand All

XElement.SetElementValue Method

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)

public function SetElementValue(
	name : XName, 
	value : Object
)

Parameters

name
Type: System.Xml.Linq.XName

An XName that contains the name of the child element to change.

value
Type: System.Object

The value to assign to the child element. The child element 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 child element.

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 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 a 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.

The following example creates an element with a child element. It then uses this method to set the value of the child element.

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

This example produces the following output:

<Root>
  <Ele1>1</Ele1>
  <Ele2>2</Ele2>
  <Ele3>3</Ele3>
</Root>
<Root>
  <Ele1>1</Ele1>
  <Ele2>22</Ele2>
  <Ele3>3</Ele3>
</Root>
<Root>
  <Ele1>1</Ele1>
  <Ele2>22</Ele2>
</Root>

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0

Community Additions

ADD
Show:
© 2014 Microsoft