Export (0) Print
Expand All

XmlNode.InsertBefore Method

Inserts the specified node immediately before the specified reference node.

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

'Declaration
Public Overridable Function InsertBefore ( _
	newChild As XmlNode, _
	refChild As XmlNode _
) As XmlNode

Parameters

newChild
Type: System.Xml.XmlNode
The XmlNode to insert.
refChild
Type: System.Xml.XmlNode
The XmlNode that is the reference node. The newChild is placed before this node.

Return Value

Type: System.Xml.XmlNode
The node being inserted.

ExceptionCondition
InvalidOperationException

The current node is of a type that does not allow child nodes of the type of the newChild node.

The newChild is an ancestor of this node.

ArgumentException

The newChild was created from a different document than the one that created this node.

The refChild is not a child of this node.

This node is read-only.

If refChild is Nothing, insert newChild at the end of the list of child nodes. All the contents of the newChild are inserted, in the same order, before refChild. If the newChild is already in the tree, it is removed from its original position and added to its target position. For more information about inserting nodes, see Inserting Nodes into an XML Document.

If the node being inserted was created from another document, you can use XmlDocument.ImportNode to import the node to the current document. The imported node can then be inserted into the current document.

Notes to Inheritors

When overriding InsertBefore in a derived class, in order for events to be raised correctly, you must call the InsertBefore method of the base class.

The following example adds a new node to the XML document.


Option Strict
Option Explicit

Imports System
Imports System.IO
Imports System.Xml

Public Class Sample

    Public Shared Sub Main()

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

        Dim root As XmlNode = doc.DocumentElement

        'Create a new node.
        Dim elem As XmlElement = doc.CreateElement("price")
        elem.InnerText = "19.95"

        'Add the node to the document.
        root.InsertBefore(elem, root.FirstChild)

        Console.WriteLine("Display the modified XML...")
        doc.Save(Console.Out)
    End Sub 'Main 
End Class 'Sample


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Community Additions

ADD
Show:
© 2014 Microsoft