XmlDocument.CreateProcessingInstruction Method (String, String)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Creates an XmlProcessingInstruction with the specified name and data.

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

Public Overridable Function CreateProcessingInstruction (
	target As String,
	data As String
) As XmlProcessingInstruction


Type: System.String

The name of the processing instruction.

Type: System.String

The data for the processing instruction.

Return Value

Type: System.Xml.XmlProcessingInstruction

The new XmlProcessingInstruction.

Although this method creates the new object in the context of the document, it does not automatically add the new object to the document tree. To add the new object, you must explicitly call one of the node insert methods.

According to the W3C Extensible Markup Language (XML) 1.0 recommendation (www.w3.org/TR/1998/REC-xml-19980210), ProcessingInstruction nodes are only allowed within Document, Element, and EntityReference nodes, when the EntityReference node is not a child of an Attribute node.

The following example creates a ProcessingInstruction node and adds it to the document.

Imports System
Imports System.IO
Imports System.Xml

public class Sample

  public shared sub Main()

    Dim doc as XmlDocument = new XmlDocument()

    ' Create a procesing instruction.
    Dim newPI as XmlProcessingInstruction 
    Dim PItext as String = "type='text/xsl' href='book.xsl'"
    newPI = doc.CreateProcessingInstruction("xml-stylesheet", PItext)

    ' Display the target and data information.
    Console.WriteLine("<?{0} {1}?>", newPI.Target, newPI.Data)

    ' Add the processing instruction node to the document.

  end sub
end class

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Return to top