XmlWriterSettings Klasse

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Gibt eine Gruppe von Funktionen an, die für das XmlWriter-Objekt unterstützt werden sollen, das von der Create-Methode erstellt wurde.

public ref class XmlWriterSettings sealed

public sealed class XmlWriterSettings

type XmlWriterSettings = class

Public NotInheritable Class XmlWriterSettings

Vererbung

Object

XmlWriterSettings

Beispiele

Im folgenden Beispiel wird ein XmlWriter erstellt, das in eine XML-Datei schreibt und jedes Attribut in eine neue Zeile schreibt.

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()

Das Beispiel erzeugt die folgende Ausgabe:

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

Hinweise

Die Create -Methode ist der bevorzugte Mechanismus zum Abrufen von XmlWriter Instanzen. Die Create -Methode verwendet die XmlWriterSettings -Klasse, um anzugeben, welche Features im XmlWriter erstellten -Objekt implementiert werden sollen.

Hinweis

Wenn Sie das XmlWriter -Objekt mit der Transform -Methode verwenden, sollten Sie die OutputSettings -Eigenschaft verwenden, um ein XmlWriterSettings Objekt mit den richtigen Einstellungen abzurufen. Dieses Verfahren gewährleistet, dass das erstellte XmlWriter-Objekt über die korrekten Ausgabeeinstellungen verfügt.

Die XmlWriterSettings -Klasse stellt Eigenschaften bereit, die die Datenkonformität und das Ausgabeformat steuern.

Verwenden Sie für Datenkonformitätsprüfungen und automatische Korrekturen die folgenden Eigenschaften:

Eigenschaft	Bedeutung	Wert	Standard
CheckCharacters	Gibt an, ob die Zeichen im gesetzlichen XML-Zeichensatz enthalten sind, wie von W3C definiert.	true oder false	true
ConformanceLevel	Gibt an, ob überprüft werden soll, ob es sich um ein wohlgeformtes XML 1.0-Dokument oder -Fragment handelt.	ConformanceLevel.Document (Dokumentebene), Fragment (Fragmentebene) oder Auto (automatische Erkennung)	ConformanceLevel.Document (Konformität auf Dokumentebene)
WriteEndDocumentOnClose	Gibt an, ob schließende Tags zu allen nicht geschlossenen Elementen hinzugefügt werden sollen, wenn die Close -Methode aufgerufen wird.	true oder false	true

Verwenden Sie die folgenden Eigenschaften, um das Ausgabeformat anzugeben:

Eigenschaft	Bedeutung	Wert	Standard
Encoding	Zu verwendende Textcodierung.	Wert vom Typ System.Text.Encoding	Encoding.UTF8
Indent	Festlegen, ob Elemente eingezogen werden sollen	true oder false	false (kein Einzug)
IndentChars	Zeichenfolge, die beim Einrücken verwendet werden soll (wird verwendet, wenn Indent auf truefestgelegt ist).	String	Zwei Leerzeichen
NewLineChars	Zeichenfolge, die für Zeilenumbrüche verwendet werden soll.	String	\r\n (Wagenrücklauf, Zeilenvorschub)
NewLineHandling	Behandeln von Zeilenumbruchzeichen.	System.Xml.NewLineHandling wert: Entitize (normalisieren), Replace (ersetzen) oder None (unverändert lassen)	Replace (Ersetzen Sie durch zeichen, die durch angegeben werden NewLineChars.
NewLineOnAttributes	Gibt an, ob Attribute in einzelne Zeilen geschrieben werden sollen (hat keine Auswirkung, wenn Indent ist false).	true oder false	false
OmitXmlDeclaration	Gibt an, ob eine XML-Deklaration geschrieben werden soll.	true oder false	false

Konstruktoren

XmlWriterSettings()

Initialisiert eine neue Instanz der XmlWriterSettings-Klasse.

Eigenschaften

Async	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob asynchrone XmlWriter-Methoden für eine bestimmte XmlWriter-Instanz verwendet werden können.
CheckCharacters	Ruft einen Wert ab, der angibt, ob der XML-Writer prüfen soll, ob alle Zeichen im Dokument dem Abschnitt „2.2 Characters“ (Zeichen) der W3C Recommendation (W3C-Empfehlung) für XML 1.0 entsprechen, oder legt diesen fest.
CloseOutput	Ruft einen Wert ab, der angibt, ob der XmlWriter auch den zugrunde liegenden Stream oder TextWriter schließen soll, wenn die Close()-Methode aufgerufen wird, oder legt diesen Wert fest.
ConformanceLevel	Ruft das Übereinstimmungsniveau ab, auf den der XML-Writer die XML-Ausgabe überprüft, oder legt dieses fest.
DoNotEscapeUriAttributes	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob XmlWriter die URI-Attribute nicht mit Escapezeichen versehen soll.
Encoding	Ruft den Typ der Textcodierung ab oder legt diesen fest.
Indent	Ruft einen Wert ab, der angibt, ob Elemente eingezogen werden sollen, oder legt diesen fest.
IndentChars	Ruft die Zeichenfolge ab, die für den Einzug verwendet werden soll, oder legt diese fest. Diese Einstellung wird verwendet, wenn die Indent-Eigenschaft auf true festgelegt ist.
NamespaceHandling	Ruft einen Wert ab, der angibt, ob der XmlWriter beim Schreiben von XML-Inhalt doppelte Namespacedeklarationen entfernen soll, oder legt diesen fest. Im Standardverhalten gibt der Writer alle Namespacedeklarationen aus, die in der Namespaceauflösung des Writers vorhanden sind.
NewLineChars	Ruft die Zeichenfolge ab, die für Zeilenumbrüche verwendet werden soll, oder legt diese fest.
NewLineHandling	Ruft einen Wert ab, der angibt, ob Zeilenumbrüche in der Ausgabe normalisiert werden sollen, oder legt diesen fest.
NewLineOnAttributes	Ruft einen Wert ab, der angibt, ob Attribute in eine neue Zeile geschrieben werden sollen, oder legt diesen fest.
OmitXmlDeclaration	Ruft einen Wert ab, der angibt, ob eine XML-Deklaration ausgelassen werden soll, oder legt diesen fest.
OutputMethod	Ruft die Methode zum Serialisieren der XmlWriter-Ausgabe ab.
WriteEndDocumentOnClose	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob XmlWriter Endtags zu allen nicht geschlossenen Elementtags hinzufügt, wenn die Close()-Methode aufgerufen wird.

Methoden

Clone()	Erstellt eine Kopie der XmlWriterSettings-Instanz.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
Reset()	Setzt die Member der settings-Klasse auf ihre Standardwerte zurück.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)