SimpleXmlWriter class

Пакет:

azure-maps-spatial-io

Простой и быстрый класс записи XML, который упрощает эффективную сборку XML-строки.

Конструкторы

SimpleXmlWriter(boolean, string, string)

Методы

clear()	Очищает все данные в модуль записи XML и настраивает себя для записи нового документа.
toString()	Закрывает документ и возвращает строковую версию XML-документа.
writeCDataContent(string)	Записывает значение содержимого внутри тега CData.
writeComment(string)	Записывает комментарий в документе.
writeElement(string, any, Record<string, string>)	Записывает полный элемент тега.
writeEndDocument(boolean)	Записывает все оставшиеся закрывающие теги в стеке имен тегов, чтобы закрыть документ.
writeEndElement(boolean)	Записывает закрывающий тег последнего открытого тега.
writeStartDocument(boolean, string, boolean)	Запускает XML-документ.
writeStartElement(string, Record<string, string | number>, boolean, boolean)	Запись элемента тега.
writeString(string, boolean)	Записывает строковое значение.
writeValue(any)	Записывает значение в модуль записи XML.

Сведения о конструкторе

SimpleXmlWriter(boolean, string, string)

new SimpleXmlWriter(prettyPrint?: boolean, newLineChars?: string, indentChars?: string)

Параметры

prettyPrint

boolean

Логическое значение, указывающее, следует ли отформатировать созданный XML и использовать новые строки и отступы. Значение по умолчанию: true.

newLineChars

string

Символы, используемые для создания новой строки в XML-данных. По умолчанию: "\r\n"

indentChars

string

Символы, используемые для создания отступа в XML-данных. По умолчанию: "\t"

Сведения о методе

clear()

Очищает все данные в модуль записи XML и настраивает себя для записи нового документа.

function clear()

toString()

Закрывает документ и возвращает строковую версию XML-документа.

function toString(): string

Возвращаемое значение

string

writeCDataContent(string)

Записывает значение содержимого внутри тега CData.

function writeCDataContent(content: string): SimpleXmlWriter

Параметры

content

string

Значение содержимого для записи.

Возвращаемое значение

SimpleXmlWriter

writeComment(string)

Записывает комментарий в документе.

function writeComment(comment: string): SimpleXmlWriter

Параметры

comment

string

Комментарий для записи в документ.

Возвращаемое значение

SimpleXmlWriter

writeElement(string, any, Record<string, string>)

Записывает полный элемент тега.

function writeElement(name: string, content: any, attributes?: Record<string, string>): SimpleXmlWriter

Параметры

name

string

Имя элемента тега.

content

any

Содержимое элемента тега.

attributes

Record<string, string>

Атрибуты тега.

Возвращаемое значение

SimpleXmlWriter

writeEndDocument(boolean)

Записывает все оставшиеся закрывающие теги в стеке имен тегов, чтобы закрыть документ.

function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter

Параметры

addTrailingNewLineChar

boolean

Логическое значение, указывающее, следует ли добавить конечный новый символ строки. По умолчанию: true

Возвращаемое значение

SimpleXmlWriter

writeEndElement(boolean)

Записывает закрывающий тег последнего открытого тега.

function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter

Параметры

skipNewLine

boolean

Логическое значение, указывающее, не следует ли добавлять новый символ строки после закрывающего тега. Значение по умолчанию: false.

Возвращаемое значение

SimpleXmlWriter

writeStartDocument(boolean, string, boolean)

Запускает XML-документ.

function writeStartDocument(includeEncodingTag?: boolean, encoding?: string, standalone?: boolean): SimpleXmlWriter

Параметры

includeEncodingTag

boolean

Указывает, следует ли добавить тег кодирования в документ. По умолчанию: True.

encoding

string

Строковое значение кодировки документа.

standalone

boolean

Логическое значение, указывающее, является ли XML-документ автономным или нет.

Возвращаемое значение

SimpleXmlWriter

writeStartElement(string, Record<string, string | number>, boolean, boolean)

Запись элемента тега.

function writeStartElement(name: string, attributes?: Record<string, string | number>, selfClosing?: boolean, skipIndent?: boolean): SimpleXmlWriter

Параметры

name

string

Имя этого тега.

attributes

Record<string, string | number>

Атрибуты для этого тега.

selfClosing

boolean

Логическое значение, указывающее, должен ли этот тег быть самозаверяющим или нет.

skipIndent

boolean

Возвращаемое значение

SimpleXmlWriter

writeString(string, boolean)

Записывает строковое значение.

function writeString(value: string, validate?: boolean): SimpleXmlWriter

Параметры

value

string

Строковое значение для записи.

validate

boolean

Логическое значение, указывающее, должен ли модуль записи записывать строку как есть или проверять и экранировать специальные символы.

Возвращаемое значение

SimpleXmlWriter

writeValue(any)

Записывает значение в модуль записи XML.

function writeValue(value: any): SimpleXmlWriter

Параметры

value

any

Любое значение, которое требуется записать.

Возвращаемое значение

SimpleXmlWriter