XmlElement.GetAttribute Method

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Returns the attribute value for the specified attribute.

Overloads

GetAttribute(String)	Returns the value for the attribute with the specified name.
GetAttribute(String, String)	Returns the value for the attribute with the specified local name and namespace URI.

GetAttribute(String)

Source:

XmlElement.cs

Returns the value for the attribute with the specified name.

public:
 virtual System::String ^ GetAttribute(System::String ^ name);

public virtual string GetAttribute (string name);

abstract member GetAttribute : string -> string
override this.GetAttribute : string -> string

Public Overridable Function GetAttribute (name As String) As String

Parameters

name

String

The name of the attribute to retrieve. This is a qualified name. It is matched against the Name property of the matching node.

Returns

String

The value of the specified attribute. An empty string is returned if a matching attribute is not found or if the attribute does not have a specified or default value.

Examples

The following example checks to see if the element has the specified attribute.

#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{
   XmlDocument^ doc = gcnew XmlDocument;
   doc->LoadXml( "<book genre='novel' ISBN='1-861001-57-5'><title>Pride And Prejudice</title></book>" );
   XmlElement^ root = doc->DocumentElement;
   
   // Check to see if the element has a genre attribute.
   if ( root->HasAttribute( "genre" ) )
   {
      String^ genre = root->GetAttribute( "genre" );
      Console::WriteLine( genre );
   }
}

using System;
using System.IO;
using System.Xml;

public class Sample
{
  public static void Main()
  {

    XmlDocument doc = new XmlDocument();
    doc.LoadXml("<book genre='novel' ISBN='1-861001-57-5'>" +
                "<title>Pride And Prejudice</title>" +
                "</book>");

    XmlElement root = doc.DocumentElement;

    // Check to see if the element has a genre attribute.
    if (root.HasAttribute("genre")){
      String genre = root.GetAttribute("genre");
      Console.WriteLine(genre);
   }
  }
}

Imports System.IO
Imports System.Xml

public class Sample

  public shared sub Main()

    Dim doc as XmlDocument = new XmlDocument()
    doc.LoadXml("<book genre='novel' ISBN='1-861001-57-5'>" & _
                "<title>Pride And Prejudice</title>" & _
                "</book>")      

    Dim root as XmlElement = doc.DocumentElement

    ' Check to see if the element has a genre attribute.
    if (root.HasAttribute("genre"))
     Dim genre as String = root.GetAttribute("genre")
     Console.WriteLine(genre)
    end if
       
    Console.WriteLine("Display the modified XML...")
    Console.WriteLine(doc.InnerXml)

  end sub
end class

GetAttribute(String, String)

Source:

XmlElement.cs

Returns the value for the attribute with the specified local name and namespace URI.

public:
 virtual System::String ^ GetAttribute(System::String ^ localName, System::String ^ namespaceURI);

public virtual string GetAttribute (string localName, string? namespaceURI);

abstract member GetAttribute : string * string -> string
override this.GetAttribute : string * string -> string

Public Overridable Function GetAttribute (localName As String, namespaceURI As String) As String

Parameters

localName

String

The local name of the attribute to retrieve.

namespaceURI

String

The namespace URI of the attribute to retrieve.

Returns

String

The value of the specified attribute. An empty string is returned if a matching attribute is not found or if the attribute does not have a specified or default value.