HtmlElement.GetAttribute Method (System.Windows.Forms)

GetAttribute Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

HtmlElement..::.GetAttribute Method

Retrieves the value of the named attribute on the element.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic

Public Function GetAttribute ( _
    attributeName As String _
) As String

public string GetAttribute(
    string attributeName
)

Visual C++

public:
String^ GetAttribute(
    String^ attributeName
)

member GetAttribute : 
        attributeName:string -> string

Parameters

attributeName: Type: System..::.String
The name of the attribute. This argument is case-insensitive.

Return Value

Type: System..::.String
The value of this attribute on the element, as a String value. If the specified attribute does not exist on this element, returns an empty string.

Remarks

An attribute in HTML is any valid name/value pair for that element. HtmlElement exposes only those attributes that are common to all elements, leaving out those that only apply to certain types of elements; SRC is a predefined attribute for the IMG tag, for example, but not for the DIV tag. Use GetAttribute and SetAttribute to manipulate attributes not exposed on the managed Document Object Model (DOM).

GetAttribute and SetAttribute are case-insensitive.

Examples

The following code example retrieves all of the META tags within an HTML document, using GetAttribute to find the META tag with the name Description. The example requires that your application has a WebBrowser control named WebBrowser1.

Visual Basic

    Private Sub DisplayMetaDescription()
        If (WebBrowser1.Document IsNot Nothing) Then
            Dim Elems As HtmlElementCollection 
            Dim WebOC as WebBrowser = WebBrowser1

        Elems = WebOC.Document.GetElementsByTagName("META")

            For Each elem As HtmlElement In Elems
                Dim NameStr As String = elem.GetAttribute("name")

                If ((NameStr IsNot Nothing) And (NameStr.Length <> 0)) Then
                    If NameStr.ToLower().Equals("description") Then
                        Dim ContentStr As String = elem.GetAttribute("content")
                        MessageBox.Show("Document: " & WebOC.Url.ToString() & vbCrLf & "Description: " & ContentStr)
                    End If
                End If
            Next
        End If
    End Sub

private void DisplayMetaDescription()
{
    if (webBrowser1.Document != null)
    {
        HtmlElementCollection elems = webBrowser1.Document.GetElementsByTagName("META");
        foreach (HtmlElement elem in elems)
        {
            String nameStr = elem.GetAttribute("name");
            if (nameStr != null && nameStr.Length != 0)
            {
                String contentStr = elem.GetAttribute("content");
                MessageBox.Show("Document: " + webBrowser1.Url.ToString() + "\nDescription: " + contentStr);
            }
        }
    }
}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

HtmlElement Class

System.Windows.Forms Namespace

Other Resources

getAttribute Method