XElement.Attribute(XName) Method

Reference

Definition

Namespace:: System.Xml.Linq

Assemblies:: System.Xml.Linq.dll, System.Xml.XDocument.dll

Assemblies:: netstandard.dll, System.Xml.XDocument.dll

Assembly:: System.Xml.XDocument.dll

Assembly:: System.Xml.Linq.dll

Assembly:: netstandard.dll

Source:: XElement.cs

Source:: XElement.cs

Source:: XElement.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the XAttribute of this XElement that has the specified XName.

public:
 System::Xml::Linq::XAttribute ^ Attribute(System::Xml::Linq::XName ^ name);

public System.Xml.Linq.XAttribute Attribute(System.Xml.Linq.XName name);

public System.Xml.Linq.XAttribute? Attribute(System.Xml.Linq.XName name);

member this.Attribute : System.Xml.Linq.XName -> System.Xml.Linq.XAttribute

Public Function Attribute (name As XName) As XAttribute

Parameters

name: XName

The XName of the XAttribute to get.

Returns

XAttribute

An XAttribute that has the specified XName; null if there is no attribute with the specified name.

Examples

The following example creates an element with an attribute. It then retrieves the attribute using this method.

XElement xmlTree = new XElement("Root",
    new XAttribute("Att", "attribute content")
);
XAttribute att = xmlTree.Attribute("Att");
Console.WriteLine(att);

Dim xmlTree As XElement = <Root Att="attribute content"/>

Dim att As XAttribute = xmlTree.Attribute("Att")
Console.WriteLine(att)

This example produces the following output:

Att="attribute content"

The following is the same example, but in this case the XML is in a namespace. For more information, see Work with XML Namespaces.

XNamespace aw = "http://www.adventure-works.com";
XElement xmlTree = new XElement(aw + "Root",
    new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"),
    new XAttribute(aw + "Att", "attribute content")
);
XAttribute att = xmlTree.Attribute(aw + "Att");
Console.WriteLine(att);

Imports <xmlns:aw="http://www.adventure-works.com">

Module Module1
    Sub Main()
        Dim xmlTree As XElement = <aw:Root aw:Att="attribute content"/>

        Dim att As XAttribute = xmlTree.Attribute(GetXmlNamespace(aw) + "Att")
        Console.WriteLine(att)
    End Sub
End Module

This example produces the following output:

aw:Att="attribute content"

Remarks

Some axis methods return collections of elements or attributes. This method returns only a single attribute. Sometimes this is referred to as a singleton (in contrast to a collection).

Visual Basic users can use the integrated attribute axis to retrieve the value of an attribute with a specified name.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

Share via