XmlWriterSettings Klasse

Definition

Namespace:

System.Xml

Assemblys:

netstandard.dll, System.Xml.ReaderWriter.dll

Quelle:

XmlWriterSettings.cs

Gibt eine Reihe von Features an, die für das XmlWriter von der Create Methode erstellte Objekt unterstützt werden sollen.

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 Objekt 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 in dem 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. Dadurch wird sichergestellt, dass das erstellte XmlWriter Objekt über die richtigen 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 autokorrekturen die folgenden Eigenschaften:

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

Verwenden Sie die folgenden Eigenschaften, um das Ausgabeformat anzugeben:

Eigentum	Bedeutung	Wert	Vorgabe
Encoding	Zu verwendende Textcodierung.	System.Text.Encoding-Wert	Encoding.UTF8
Indent	Gibt an, ob Elemente eingezogen werden sollen	true oder false	false (kein Einzug)
IndentChars	Zeichenzeichenfolge, die beim Einrücken verwendet werden soll (wird verwendet, wenn Indent festgelegt trueist).	String	Zwei Leerzeichen
NewLineChars	Zeichenzeichenfolge, die für Zeilenumbrüche verwendet werden soll.	String	\r\n (Wagenrücklauf, Zeilenvorschub) für Nicht-Unix-Plattformen oder \n (Zeilenvorschub) für Unix-Plattformen
NewLineHandling	Behandeln von Neuzeilenzeichen	System.Xml.NewLineHandling wert: Entitize (normalisieren), Replace (ersetzen) oder None (unverändert lassen)	Replace (ersetzen durch Zeichen, die durch NewLineChars)
NewLineOnAttributes	Gibt an, ob Attribute in einzelnen Zeilen geschrieben werden sollen (hat keine Auswirkung, wenn Indent dies der Zeitpunkt ist false).	true oder false	false
OmitXmlDeclaration	Gibt an, ob eine XML-Deklaration geschrieben werden soll.	true oder false	false

Konstruktoren

Name	Beschreibung
XmlWriterSettings()	Initialisiert eine neue Instanz der XmlWriterSettings-Klasse.

Eigenschaften

Name	Beschreibung
Async	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob asynchrone XmlWriter Methoden für eine bestimmte XmlWriter Instanz verwendet werden können.
CheckCharacters	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der XML-Writer überprüfen soll, um sicherzustellen, dass alle Zeichen im Dokument dem Abschnitt "2.2 Zeichen" der W3C XML 1.0-Empfehlung entsprechen.
CloseOutput	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der XmlWriter zugrunde liegende Datenstrom auch geschlossen werden soll oder TextWriter wenn die Close() Methode aufgerufen wird.
ConformanceLevel	Ruft die Konformitätsstufe ab, auf die der XML-Writer die XML-Ausgabe überprüft, oder legt diese fest.
DoNotEscapeUriAttributes	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die XmlWriter URI-Attribute nicht escapen.
Encoding	Ruft den typ der zu verwendenden Textcodierung ab oder legt diesen fest.
Indent	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob Elemente eingezogen werden sollen.
IndentChars	Ruft die beim Einrücken zu verwendende Zeichenfolge ab oder legt sie fest. Diese Einstellung wird verwendet, wenn die Indent Eigenschaft auf true.
NamespaceHandling	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob beim XmlWriter Schreiben von XML-Inhalten doppelte Namespacedeklarationen entfernt werden sollen. Das Standardverhalten ist, dass der Writer alle Namespacedeklarationen ausgibt, die im Namespace-Resolver des Writers vorhanden sind.
NewLineChars	Ruft die zeichenzeichenfolge ab, die für Zeilenumbrüche verwendet werden soll, oder legt diese fest.
NewLineHandling	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob Zeilenumbrüche in der Ausgabe normalisiert werden sollen.
NewLineOnAttributes	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob Attribute in eine neue Zeile geschrieben werden sollen.
OmitXmlDeclaration	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob eine XML-Deklaration weggelassen werden soll.
OutputMethod	Ruft die Methode ab, die zum Serialisieren der XmlWriter Ausgabe verwendet wird.
WriteEndDocumentOnClose	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die XmlWriter schließenden Tags allen nicht markierten Elementtags hinzugefügt werden, wenn die Close() Methode aufgerufen wird.

Methoden

Name	Beschreibung
Clone()	Erstellt eine Kopie der XmlWriterSettings Instanz.
Equals(Object)	Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht. (Geerbt von Object)
GetHashCode()	Dient als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft die Type der aktuellen Instanz ab. (Geerbt von Object)
MemberwiseClone()	Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object)
Reset()	Setzt die Member der Einstellungsklasse auf ihre Standardwerte zurück.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)