IXmlWriter

Show Usages

Abstraction of XML output classes that provide a consistent way to write XML elements to some output

Inheritance Hierarchy

Members

No filters for this type

Properties

namespaceManager

: IXmlNamespaceManager

readonlyabstract

Gets the namespace manager associated with this writer.

readonlyabstract

Property Value

The namespace manager.

Methods

flushDocument

()

abstract

Closes the document.

This is typically used to actually flush the document to an output stream

abstract

getXmlString

(): string

abstract

Gets a text representation of all content that has been written so far.

writeAttribute

(localName: string, value: string): IXmlWriter

Write an XML attribute with the given parameters.

The attribute is not bound to an XML namespace.

Parameters

localName: string: The name of the attribute.
value: string: The value of the attribute.

Return Value

IXmlWriter: The writer instance writer for writer chaining.

writeAttributeNS

(

prefix: string

localName: string

ns: string

value: string

): IXmlWriter

abstract

Writes an XML attribute node.

The attribute is attached to the closest open XML element that has been started with writeStartElement or writeStartElement. Note that namespace declarations should not be written directly as attributes. Instead the namespaceManager should be used.

abstract

Parameters

prefix: string: The namespace prefix of the attribute
localName: string: The local name of the attribute
ns: string: The namespace URI of this attribute
value: string: The value of this attribute

Return Value

IXmlWriter: The writer instance for further chaining

writeCData

(content: string): IXmlWriter

abstract

Writes a CDATA section.

abstract

Parameters

content: string: The content of the CDATA section

Return Value

IXmlWriter: The writer instance for further chaining

writeComment

(comment: string): IXmlWriter

abstract

Writes an XML comment node

abstract

Parameters

comment: string: The content of the comment

Return Value

IXmlWriter: The writer instance for further chaining

writeDocumentFragment

(fragment: Document): IXmlWriter

abstract

Writes a document fragment.

abstract

Parameters

fragment: Document

Return Value

IXmlWriter: The writer instance for further chaining

writeEndDocument

()

abstract

Closes the output.

Attempts to write after this method has been called will have undefined results.

abstract

writeEndElement

(): IXmlWriter

abstract

Closes an XML element previously opened with writeStartElement or writeStartElement.

writeGraphMLXmlAttribute

(attribute: GraphMLXmlAttribute): IXmlWriter

Write an XML attribute from the given attribute struct.

Parameters

attribute: GraphMLXmlAttribute: Encapsulates the current attribute values.

Return Value

IXmlWriter: The writer instance writer for writer chaining.

writeProcessingInstruction

(target: string, data: string): IXmlWriter

abstract

Writes an XML processing instruction.

abstract

Parameters

target: string: The target of the PI
data: string: The data of the PI

Return Value

IXmlWriter: The writer instance for further chaining

writeStartDocument

(): IXmlWriter

abstract

Begins the output process.

writeStartElement

(localName: string, ns: string): IXmlWriter

abstract

Begin a new XML element with given parameters

All subsequent output is attached to this element until writeEndElement has been called or a new element has been started.

This acts like writeStartElement, but uses the default prefix for the namespace

abstract

Parameters

localName: string: The local name of this element
ns: string: The namespace of this element

Return Value

IXmlWriter: The writer instance for further chaining

writeStartElement

(

prefix: string

localName: string

ns: string

): IXmlWriter

abstract

Begins a new XML element with given parameters

All subsequent output is attached to this element until writeEndElement has been called or a new element has been started.

abstract

Parameters

prefix: string: The namespace prefix to use for this element
localName: string: The local name of this element
ns: string: The namespace of this element

Return Value

IXmlWriter: The writer instance for further chaining

writeString

(s: string): IXmlWriter

abstract

Writes a text node.

The string value of s will be correctly escaped

abstract

Parameters

s: string: The string that gets written as XML text

Return Value

IXmlWriter: The writer instance for further chaining