HtmlElement.InsertAdjacentElement Method (HtmlElementInsertionOrientation, HtmlElement)


Insert a new element into the Document Object Model (DOM).

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

Public Function InsertAdjacentElement (
	orient As HtmlElementInsertionOrientation,
	newElement As HtmlElement
) As HtmlElement


Type: System.Windows.Forms.HtmlElementInsertionOrientation

Where to insert this element in relation to the current element.

Type: System.Windows.Forms.HtmlElement

The new element to insert.

Return Value

Type: System.Windows.Forms.HtmlElement

The HtmlElement that was just inserted. If insertion failed, this will return null.

Do not call this method until after the DocumentCompleted event on the WebBrowser control has occurred. Calling this method before then can result in an exception, as the document will not have finished loading.

Whether a value of HtmlElementInsertionOrientation is valid will depend on the type of the element. For example, AfterBegin is valid if the element is a DIV, but not if it is a SCRIPT or IMG element, neither of which can contain child elements.

The following code example inserts a DIV element into the top of every page that users view outside of the server. The example requires that your form contains a WebBrowser control named WebBrowser1. Your sample must also import the namespace System.Text.RegularExpressions.

Private Sub AddDivMessage()
    Dim CurrentUri As New Uri(WebBrowser1.Url.ToString())
    Dim HostName As String

    ' Ensure we have a host name, and not just an IP, against which to test.
    If (Not CurrentUri.HostNameType = UriHostNameType.Dns) Then
        Dim Permit As New DnsPermission(System.Security.Permissions.PermissionState.Unrestricted)

        Dim HostEntry As IPHostEntry = System.Net.Dns.GetHostEntry(CurrentUri.Host)
        HostName = HostEntry.HostName
        HostName = CurrentUri.Host
    End If

    If (Not HostName.Contains("")) Then
        AddTopPageMessage("You are viewing a web site other than " & _
            "Please exercise caution, and ensure your web surfing complies with all " & _
            "corporate regulations as laid out in the company handbook.")
    End If
End Sub

Private Sub AddTopPageMessage(ByVal Message As String)
    If (WebBrowser1.Document IsNot Nothing) Then
        With WebBrowser1.Document
            ' Do not insert the warning again if it already exists. 
            Dim ReturnedElems As HtmlElementCollection = .All.GetElementsByName("ADatumWarningDiv")
            If (Not (ReturnedElems Is Nothing) And (ReturnedElems.Count > 0)) Then
                Exit Sub
            End If

            Dim DivElem As HtmlElement = .CreateElement("DIV")
            DivElem.Name = "ADatumWarningDiv"
            DivElem.Style = "background-color:black;color:white;font-weight:bold;width:100%;"
            DivElem.InnerText = Message

            DivElem = .Body.InsertAdjacentElement(HtmlElementInsertionOrientation.AfterBegin, DivElem)
        End With
    End If
End Sub

.NET Framework
Available since 2.0
Return to top