Export (0) Print
Expand All
Expand Minimize

XmlWriter.WriteCData Method

When overridden in a derived class, writes out a <![CDATA[...]]> block containing the specified text.

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

'Declaration
Public MustOverride Sub WriteCData ( _
	text As String _
)

Parameters

text
Type: System.String

The text to place inside the CDATA block.

ExceptionCondition
ArgumentException

The text would result in a non-well formed XML document.

InvalidOperationException

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message “An asynchronous operation is already in progress.”

If text is either Nothing or String.Empty, this method writes an empty CDATA block, for example <![CDATA[]]>.

For the asynchronous version of this method, see WriteCDataAsync.

The following example writes an XML file representing a book.

Option Strict
Option Explicit

Imports System
Imports System.IO
Imports System.Xml

Public Class Sample
    Private Const filename As String = "sampledata.xml" 

  Public Shared Sub Main()

     Dim settings As XmlWriterSettings = new XmlWriterSettings()
     settings.Indent = true
     Dim writer As XmlWriter = XmlWriter.Create(filename, settings)

     ' Write the Processing Instruction node. 
     Dim PItext As String = "type=""text/xsl"" href=""book.xsl"""
     writer.WriteProcessingInstruction("xml-stylesheet", PItext)

     'Write the DocumentType node.
     writer.WriteDocType("book", Nothing, Nothing, "<!ENTITY h ""hardcover"">")

     ' Write a Comment node.
     writer.WriteComment("sample XML")

     ' Write the root element.
     writer.WriteStartElement("book")

     ' Write the genre attribute
     writer.WriteAttributeString("genre", "novel")

     ' Write the ISBN attribute.
     writer.WriteAttributeString("ISBN", "1-8630-014")

     ' Write the title.
     writer.WriteElementString("title", "The Handmaid's Tale")

     ' Write the style element.
     writer.WriteStartElement("style")
     writer.WriteEntityRef("h")
     writer.WriteEndElement()

     ' Write the price.
     writer.WriteElementString("price", "19.95")

     ' Write CDATA.
     writer.WriteCData("Prices 15% off!!")

     ' Write the close tag for the root element.
     writer.WriteEndElement()

     writer.WriteEndDocument()

     ' Write the XML to file and close the writer
     writer.Flush()
     writer.Close()

    End Sub 'Main 
End Class 'Sample

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft