IXmlWriter

Description

interface Tinman.Core.Xml.IXmlWriter

Derived from: IPathInfo
Extended by: IXmlStream

Base interface for classes that allow sequential writing of XML data.

To write to a stream of XML data, use the following call sequence:

WriteHeaderBegin
Write zero or more preamble nodes:
WriteComment, WriteInstruction, WriteSpace
WriteHeaderEnd
(A) Write zero or more content nodes:
- WriteChar, WriteComment, WriteData, WriteEntity, WriteInstruction, WriteSpace, WriteText
- Write an element node with this sequence:
  - WriteElementBegin
  - Write zero or more attribute nodes:
    
    WriteAttributeBegin
    
    Write zero or more value nodes:
    WriteChar, WriteEntity, WriteText
    
    WriteAttributeEnd
  - Go to (A) recursively.
  - WriteElementEnd

Public / Methods

WriteAttributeBegin

public method WriteAttributeBegin → (1)

name ⁱⁿ : XmlName: See XmlAttribute.Name.

Writes the start of an XmlAttribute node.

IOException: If an I/O error has occurred.

WriteAttributeEnd

public method WriteAttributeEnd → ()

Writes the end of an XmlAttribute node.

IOException: If an I/O error has occurred.

WriteChar

public method WriteChar → (2)

value ⁱⁿ : char: See XmlChar.Value.
hexadecimal ⁱⁿ : bool: See XmlChar.IsHexadecimal.

Writes an XmlChar node.

IOException: If an I/O error has occurred.

WriteComment

public method WriteComment → (1)

text ⁱⁿ : string: See XmlComment.Text.

Writes an XmlComment node.

If text ⁱⁿ is null, no write access is performed.

IOException: If an I/O error has occurred.

WriteData

public method WriteData → (1)

text ⁱⁿ : string: See XmlData.Text.

Writes an XmlData node.

If text ⁱⁿ is null, no write access is performed.

IOException: If an I/O error has occurred.

WriteElementBegin

public method WriteElementBegin → (2)

name ⁱⁿ : XmlName: See XmlElement.Name.
compact ^opt : bool = true: See XmlElement.IsCompact.

Writes the start of an XmlElement node.

IOException: If an I/O error has occurred.

WriteElementEnd

public method WriteElementEnd → ()

Writes the end of an XmlElement node.

IOException: If an I/O error has occurred.

WriteEntity

public method WriteEntity → (1)

name ⁱⁿ : XmlName: See XmlEntity.Name.

Writes an XmlEntity node.

IOException: If an I/O error has occurred.

WriteHeaderBegin

public method WriteHeaderBegin → (7)

name ^opt : XmlName = default(XmlName): See XmlDocument.Name.
systemId ^opt : string = null: See XmlDocument.SystemId.
publicId ^opt : string = null: See XmlDocument.PublicId.
versionMajor ^opt : int32 = 1: See XmlDocument.Version.
versionMinor ^opt : int32 = 0: See XmlDocument.Version.
encoding ^opt : string = "utf-8": See XmlDocument.Encoding.
standAlone ^opt : int32 = 0: See XmlDocument.StandAlone.

Writes the header of an XmlDocument node.

IOException: If an I/O error has occurred.

WriteHeaderEnd

public method WriteHeaderEnd → ()

Ends writing of the document header.

IOException: If an I/O error has occurred.

WriteInstruction

public method WriteInstruction → (2)

target ⁱⁿ : XmlName: See XmlInstruction.Target.
source ⁱⁿ : string: See XmlInstruction.Source.

Writes an XmlInstruction node.

IOException: If an I/O error has occurred.

WriteSpace

public method WriteSpace → (1)

value ⁱⁿ : string: See XmlSpace.Space.

Writes an XmlSpace node.

If value ⁱⁿ is null, no write access is performed.

IOException: If an I/O error has occurred.

WriteText

public method WriteText → (1)

value ⁱⁿ : string: See XmlText.Value.

Writes an XmlText node.

If value ⁱⁿ is null, no write access is performed.

IOException: If an I/O error has occurred.

IXmlWriter

Description

Public / Methods

Write​Attribute​Begin

Write​Attribute​End

Write​Char

Write​Comment

Write​Data

Write​Element​Begin

Write​Element​End

Write​Entity

Write​Header​Begin

Write​Header​End

Write​Instruction

Write​Space

Write​Text