This documentation is archived and is not being maintained.

XElement.Attribute Method

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

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

'Declaration
Public Function Attribute ( _
	name As XName _
) As XAttribute
'Usage
Dim instance As XElement 
Dim name As XName 
Dim returnValue As XAttribute 

returnValue = instance.Attribute(name)

Parameters

name
Type: System.Xml.Linq.XName

The XName of the XAttribute to get.

Return Value

Type: System.Xml.Linq.XAttribute
An XAttribute that has the specified XName; Nothing if there is no attribute with the specified name.

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.

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

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 Working with XML Namespaces.

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"

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
Show: