XmlWriterSettings Kelas

Definisi

Ruang nama:

System.Xml

Rakitan:

netstandard.dll, System.Xml.ReaderWriter.dll

Sumber:

XmlWriterSettings.cs

Menentukan sekumpulan fitur yang akan didukung pada objek yang XmlWriter dibuat oleh Create metode .

public ref class XmlWriterSettings sealed

public sealed class XmlWriterSettings

type XmlWriterSettings = class

Public NotInheritable Class XmlWriterSettings

Warisan

Object

XmlWriterSettings

Contoh

Contoh berikut membuat yang XmlWriter menulis ke file XML dan menulis setiap atribut pada baris baru.

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.OmitXmlDeclaration = true;
settings.NewLineOnAttributes = true;

writer = XmlWriter.Create(Console.Out, settings);

writer.WriteStartElement("order");
writer.WriteAttributeString("orderID", "367A54");
writer.WriteAttributeString("date", "2001-05-03");
writer.WriteElementString("price", "19.95");
writer.WriteEndElement();
    
writer.Flush();

        Dim settings As New XmlWriterSettings()
        settings.Indent = True
        settings.OmitXmlDeclaration = True
        settings.NewLineOnAttributes = True
   
        writer = XmlWriter.Create(Console.Out, settings)

        writer.WriteStartElement("order")
        writer.WriteAttributeString("orderID", "367A54")
        writer.WriteAttributeString("date", "2001-05-03")
        writer.WriteElementString("price", "19.95")
        writer.WriteEndElement()

        writer.Flush()

Sampel menghasilkan output berikut:

<order
  orderID="367A54"
  date="2001-05-03">
  <price>19.95</price>
</order>

Keterangan

Metode Create ini adalah mekanisme yang disukai untuk mendapatkan XmlWriter instans. Metode ini Create menggunakan XmlWriterSettings kelas untuk menentukan fitur mana yang akan diterapkan dalam XmlWriter objek yang dibuat.

Nota

Jika Anda menggunakan XmlWriter objek dengan Transform metode , Anda harus menggunakan OutputSettings properti untuk mendapatkan objek dengan pengaturan yang XmlWriterSettings benar. Ini memastikan bahwa objek yang dibuat XmlWriter memiliki pengaturan output yang benar.

Kelas ini XmlWriterSettings menyediakan properti yang mengontrol kesuaian data dan format output.

Untuk pemeriksaan kesamaan data dan koreksi otomatis, gunakan properti ini:

Harta benda	Menetapkan	Nilai	Default
CheckCharacters	Apakah akan memeriksa apakah karakter berada dalam set karakter XML legal, seperti yang didefinisikan oleh W3C.	true atau false	true
ConformanceLevel	Apakah akan memeriksa apakah output adalah dokumen atau fragmen XML 1.0 yang terbentuk dengan baik.	ConformanceLevel.Document (tingkat dokumen), Fragment (tingkat fragmen), atau Auto (deteksi otomatis)	ConformanceLevel.Document (kesuaian tingkat dokumen)
WriteEndDocumentOnClose	Apakah akan menambahkan tag penutup ke semua elemen yang tidak tertutup ketika metode dipanggil Close .	true atau false	true

Untuk menentukan format output, gunakan properti ini:

Harta benda	Menetapkan	Nilai	Default
Encoding	Pengodean teks yang akan digunakan.	System.Text.Encoding nilai	Encoding.UTF8
Indent	Apakah akan mengindentasi elemen	true atau false	false (tidak ada indentasi)
IndentChars	String karakter yang akan digunakan saat indentasi (digunakan saat Indent diatur ke true).	string	Dua spasi
NewLineChars	String karakter yang digunakan untuk pemisah baris.	string	\r\n (carriage return, line feed) untuk platform non-Unix, atau \n (umpan baris) untuk platform Unix
NewLineHandling	Cara menangani karakter baris baru.	System.Xml.NewLineHandling nilai: Entitize (normalisasi), Replace (ganti), atau None (biarkan tidak berubah)	Replace (ganti dengan karakter yang ditentukan oleh NewLineChars)
NewLineOnAttributes	Apakah akan menulis atribut pada baris individual (tidak berpengaruh ketika Indent adalah false).	true atau false	false
OmitXmlDeclaration	Apakah akan menulis deklarasi XML.	true atau false	false

Konstruktor

Nama	Deskripsi
XmlWriterSettings()	Menginisialisasi instans baru dari kelas XmlWriterSettings.

Properti

Nama	Deskripsi
Async	Mendapatkan atau menetapkan nilai yang menunjukkan apakah metode asinkron XmlWriter dapat digunakan pada instans tertentu XmlWriter .
CheckCharacters	Mendapatkan atau menetapkan nilai yang menunjukkan apakah penulis XML harus memeriksa untuk memastikan bahwa semua karakter dalam dokumen sesuai dengan bagian "2.2 Karakter" dari Rekomendasi XML 1.0 W3C.
CloseOutput	Mendapatkan atau menetapkan nilai yang menunjukkan apakah XmlWriter juga harus menutup aliran yang mendasar atau TextWriter ketika metode dipanggil Close() .
ConformanceLevel	Mendapatkan atau mengatur tingkat kesuaian tempat penulis XML memeriksa output XML.
DoNotEscapeUriAttributes	Mendapatkan atau menetapkan nilai yang menunjukkan apakah XmlWriter atribut URI tidak lolos.
Encoding	Mendapatkan atau mengatur jenis pengodean teks yang akan digunakan.
Indent	Mendapatkan atau menetapkan nilai yang menunjukkan apakah akan mengindentasi elemen.
IndentChars	Mendapatkan atau mengatur string karakter yang akan digunakan saat mengindentasi. Pengaturan ini digunakan ketika Indent properti diatur ke true.
NamespaceHandling	Mendapatkan atau menetapkan nilai yang menunjukkan apakah XmlWriter harus menghapus deklarasi namespace layanan duplikat saat menulis konten XML. Perilaku default adalah agar penulis menghasilkan semua deklarasi namespace yang ada di pemecah masalah namespace penulis.
NewLineChars	Mendapatkan atau mengatur string karakter yang akan digunakan untuk pemisah baris.
NewLineHandling	Mendapatkan atau menetapkan nilai yang menunjukkan apakah akan menormalkan hentian baris dalam output.
NewLineOnAttributes	Mendapatkan atau menetapkan nilai yang menunjukkan apakah akan menulis atribut pada baris baru.
OmitXmlDeclaration	Mendapatkan atau menetapkan nilai yang menunjukkan apakah akan menghilangkan deklarasi XML.
OutputMethod	Mendapatkan metode yang digunakan untuk menserialisasikan XmlWriter output.
WriteEndDocumentOnClose	Mendapatkan atau menetapkan nilai yang menunjukkan apakah XmlWriter akan menambahkan tag penutup ke semua tag elemen yang tidak diklompokkan saat metode dipanggil Close() .

Metode

Nama	Deskripsi
Clone()	Membuat salinan XmlWriterSettings instans.
Equals(Object)	Menentukan apakah objek yang ditentukan sama dengan objek saat ini. (Diperoleh dari Object)
GetHashCode()	Berfungsi sebagai fungsi hash default. (Diperoleh dari Object)
GetType()	Mendapatkan Type instans saat ini. (Diperoleh dari Object)
MemberwiseClone()	Membuat salinan dangkal dari Objectsaat ini. (Diperoleh dari Object)
Reset()	Mereset anggota kelas pengaturan ke nilai defaultnya.
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)