Share via

  • Article

XAttribute.Remove Method

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

Removes this attribute from its parent element.

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

Syntax

'Declaration
Public Sub Remove

public void Remove()

Exceptions

Exception Condition
InvalidOperationException

The parent element is nulla null reference (Nothing in Visual Basic).

Remarks

You can use this method to modify an XML tree. This method will cause events to occur.

There are many scenarios in which you might want to remove a set of attributes. In LINQ to XML programming, you should not manipulate or modify a set of nodes while you are querying for nodes in that set. In practical terms, this means that you should not iterate over a set of attributes and remove them. Instead, you should materialize them into a List<T> using the ToList<TSource> extension method. Then you can iterate over the list, removing the attributes. For more information, see Declarative Code / Imperative Code Bugs.

Alternatively, if you want to remove a set of attributes, it is recommended that you use the Extensions.Remove method. This method copies the attributes to a list, then iterates over the list, removing the attributes.

Examples

The following example creates an element with three attributes. It then removes one of the attributes.

Dim output As New StringBuilder
Dim root As XElement = <Root Att1="content1" Att2="content2" Att3="content3"/>
Dim att As XAttribute = root.Attribute("Att2")
att.Remove()
output.Append(root)
output.Append(Environment.NewLine)

OutputTextBlock.Text = output.ToString()

StringBuilder output = new StringBuilder();
XElement root = new XElement("Root",
    new XAttribute("Att1", "content1"),
    new XAttribute("Att2", "content2"),
    new XAttribute("Att3", "content3")
);
XAttribute att = root.Attribute("Att2");
att.Remove();
output.Append(root + Environment.NewLine);

OutputTextBlock.Text = output.ToString();

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.