XmlDocument.CreateSignificantWhitespace Method (String)

 

Creates an XmlSignificantWhitespace node.

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

Public Overridable Function CreateSignificantWhitespace (
	text As String
) As XmlSignificantWhitespace

Parameters

text
Type: System.String

The string must contain only the following characters  
 
 and 	

Return Value

Type: System.Xml.XmlSignificantWhitespace

A new XmlSignificantWhitespace node.

This method is a Microsoft extension to the Document Object Model (DOM). It is used when you want to manually format your document.

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.

The following example adds significant white space to the document.

Option Explicit
Option Strict

Imports System
Imports System.Xml
Imports Microsoft.VisualBasic

Public Class Sample

    Public Shared Sub Main()

        Dim doc As New XmlDocument()
        doc.LoadXml("<author xml:space='preserve'>" & _
                    "<first-name>Eva</first-name>" & _
                    "<last-name>Corets</last-name>" & _
                    "</author>")

        Console.WriteLine("InnerText before...")
        Console.WriteLine(doc.DocumentElement.InnerText)

        ' Add white space.    
        Dim currNode as XmlNode = doc.DocumentElement
        Dim sigws As XmlSignificantWhitespace = doc.CreateSignificantWhitespace(ControlChars.Tab)
        currNode.InsertAfter(sigws, currNode.FirstChild)

        Console.WriteLine()
        Console.WriteLine("InnerText after...")
        Console.WriteLine(doc.DocumentElement.InnerText)

    End Sub 
End Class 'Sample

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