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