Export (0) Print
Expand All

XmlWriter.WriteEntityRef Method

When overridden in a derived class, writes out an entity reference as &name;.

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

'Declaration
Public MustOverride Sub WriteEntityRef ( _
	name As String _
)

Parameters

name
Type: System.String
The name of the entity reference.

ExceptionCondition
ArgumentException

name is either Nothing or String.Empty.

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, 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

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