SimpleXmlWriter class
فئة كتابة XML بسيطة وسريعة تجعل من السهل إنشاء سلسلة XML بكفاءة.
المنشئون
Simple |
الأساليب
clear() | مسح كافة البيانات في كاتب XML وإعداد نفسه لاستخدامه لكتابة مستند جديد. |
to |
إغلاق المستند وإرجاع إصدار سلسلة من مستند XML. |
write |
كتابة قيمة محتوى داخل علامة CData. |
write |
يكتب تعليقا في المستند. |
write |
كتابة عنصر علامة كامل. |
write |
يكتب كل علامة الإغلاق المتبقية في مكدس اسم العلامة لإغلاق المستند. |
write |
يكتب علامة إغلاق العلامة الأخيرة التي تم فتحها. |
write |
بدء مستند XML. |
write |
كتابة عنصر علامة. |
write |
كتابة قيمة سلسلة. |
write |
يكتب قيمة إلى كاتب 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
قيمة المحتوى المراد كتابتها.
المرتجعات
writeComment(string)
يكتب تعليقا في المستند.
function writeComment(comment: string): SimpleXmlWriter
المعلمات
- comment
-
string
التعليق الذي يجب كتابته إضافة إلى المستند.
المرتجعات
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>
سمات العلامة.
المرتجعات
writeEndDocument(boolean)
يكتب كل علامة الإغلاق المتبقية في مكدس اسم العلامة لإغلاق المستند.
function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter
المعلمات
- addTrailingNewLineChar
-
boolean
قيمة منطقية تشير إلى ما إذا كان يجب إضافة حرف سطر جديد زائد أم لا.
افتراضي: true
المرتجعات
writeEndElement(boolean)
يكتب علامة إغلاق العلامة الأخيرة التي تم فتحها.
function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter
المعلمات
- skipNewLine
-
boolean
قيمة منطقية تشير إلى ما إذا كان يجب عدم إضافة حرف السطر الجديد بعد علامة الإغلاق.
افتراضي: false
.
المرتجعات
writeStartDocument(boolean, string, boolean)
بدء مستند XML.
function writeStartDocument(includeEncodingTag?: boolean, encoding?: string, standalone?: boolean): SimpleXmlWriter
المعلمات
- includeEncodingTag
-
boolean
يحدد ما إذا كان يجب إضافة علامة الترميز إلى المستند. الافتراضي: صحيح.
- encoding
-
string
قيمة ترميز السلسلة للمستند.
- standalone
-
boolean
قيمة منطقية تشير إلى ما إذا كان مستند XML مستقلا أم لا.
المرتجعات
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
المرتجعات
writeString(string, boolean)
كتابة قيمة سلسلة.
function writeString(value: string, validate?: boolean): SimpleXmlWriter
المعلمات
- value
-
string
قيمة السلسلة المراد كتابتها.
- validate
-
boolean
قيمة منطقية تشير إلى ما إذا كان يجب على الكاتب كتابة السلسلة كما هي، أو التحقق من صحة الأحرف الخاصة وإلغاءها.
المرتجعات
writeValue(any)
يكتب قيمة إلى كاتب XML.
function writeValue(value: any): SimpleXmlWriter
المعلمات
- value
-
any
أي قيمة يجب كتابتها.