XmlWriterSettings XmlWriterSettings XmlWriterSettings XmlWriterSettings Class

Definition

Gibt eine Gruppe von Funktionen an, die für das XmlWriter-Objekt unterstützt werden sollen, das von der Create-Methode erstellt wurde.Specifies a set of features to support on the XmlWriter object created by the Create method.

public ref class XmlWriterSettings sealed
public sealed class XmlWriterSettings
type XmlWriterSettings = class
Public NotInheritable Class XmlWriterSettings
Vererbung
XmlWriterSettingsXmlWriterSettingsXmlWriterSettingsXmlWriterSettings

Beispiele

Das folgende Beispiel erstellt eine XmlWriter , die in eine XML-Datei schreibt und jedes Attribut in einer neuen Zeile.The following example creates an XmlWriter that writes to an XML file and writes each attribute on a new line.

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 XmlWriterSettings = 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:The sample produces the following output:

<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.The Create method is the preferred mechanism for obtaining XmlWriter instances. Die Create -Methode verwendet die XmlWriterSettings Klasse angeben, welche Funktionen im Implementieren der XmlWriter -Objekt, das erstellt wird.The Create method uses the XmlWriterSettings class to specify which features to implement in the XmlWriter object that is created.

Hinweis

Bei Verwendung der XmlWriter Objekt mit der Transform -Methode, die Sie verwenden sollten die OutputSettings -Eigenschaft zum Abrufen einer XmlWriterSettings Objekt mit den richtigen Einstellungen.If you're using the XmlWriter object with the Transform method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. Dieses Verfahren gewährleistet, dass das erstellte XmlWriter-Objekt über die korrekten Ausgabeeinstellungen verfügt.This ensures that the created XmlWriter object has the correct output settings.

Die XmlWriterSettings Klasse enthält Eigenschaften dieses Steuerelements Daten Übereinstimmung mit Standards und die Ausgabe-Format.The XmlWriterSettings class provides properties that control data conformance and output format.

Verwenden Sie für die datenkonformitätsüberprüfung und automatische Korrekturen: Diese Eigenschaften:For data conformance checks and auto-corrections, use these properties:

EigenschaftProperty BedeutungSpecifies WertValue StandardDefault
CheckCharacters Überprüfen Sie, dass in der zulässigen XML-Zeichen sind, ob Zeichensatz, gemäß der W3C.Whether to check that characters are in the legal XML character set, as defined by W3C. true oder falsetrue or false true
ConformanceLevel Ob zu überprüfen, ob die Ausgabe um ein wohlgeformtes XML 1.0-Dokument oder-Fragment ist.Whether to check that output is a well-formed XML 1.0 document or fragment. ConformanceLevel.Document (Anwendungsebene), Fragment (Fragment-Ebene), oder Auto (automatische Erkennung)ConformanceLevel.Document (document-level), Fragment (fragment-level), or Auto (auto-detection) ConformanceLevel.Document (Übereinstimmung auf Dokumentebene)ConformanceLevel.Document (document-level conformance)
WriteEndDocumentOnClose An, ob schließende Tags für alle nicht geschlossene Elemente hinzugefügt. wenn die Close Methode wird aufgerufen.Whether to add closing tags to all unclosed elements when the Close method is called. true oder falsetrue or false true

Um das Ausgabeformat angeben möchten, verwenden Sie diese Eigenschaften:To specify output format, use these properties:

EigenschaftProperty BedeutungSpecifies WertValue StandardDefault
Encoding Um zu verwendende textcodierung.Text encoding to use. System.Text.Encoding-WertSystem.Text.Encoding value Encoding.UTF8
Indent Angibt, ob Elemente eingerückt werden sollenWhether to indent elements true oder falsetrue or false false (keine Einzüge)false (no indentation)
IndentChars Zeichenfolge Einzug verwendet werden soll (wird verwendet, wenn Indent nastaven NA hodnotu true).Character string to use when indenting (used when Indent is set to true). ZeichenfolgeString Zwei LeerzeichenTwo spaces
NewLineChars Zeichenfolge, die für Zeilenumbrüche verwendet.Character string to use for line breaks. ZeichenfolgeString \r\n (Carriage return, Wagenrücklauf, Zeilenvorschub)\r\n (carriage return, line feed)
NewLineHandling Gewusst wie Zeilenumbruchzeichen zu behandeln.How to handle newline characters. System.Xml.NewLineHandling Wert: Entitize (normalisiert), Replace (ersetzen), oder None (lassen Sie unverändert)System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace), or None (leave unchanged) Replace (ersetzen Sie dies durch von angegebenen Zeichen NewLineChars)Replace (replace with characters specified by NewLineChars)
NewLineOnAttributes Angibt, ob Attribute in einzelne Zeilen zu schreiben (hat keine Auswirkungen, wenn Indent ist false).Whether to write attributes on individual lines (has no effect when Indent is false). true oder falsetrue or false false
OmitXmlDeclaration Ob eine XML-Deklaration geschrieben.Whether to write an XML declaration. true oder falsetrue or false false

Konstruktoren

XmlWriterSettings() XmlWriterSettings() XmlWriterSettings() XmlWriterSettings()

Initialisiert eine neue Instanz der XmlWriterSettings-Klasse.Initializes a new instance of the XmlWriterSettings class.

Eigenschaften

Async Async Async 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.Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

CheckCharacters CheckCharacters CheckCharacters 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.Gets or sets a value that indicates whether the XML writer should check to ensure that all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.

CloseOutput CloseOutput CloseOutput 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.Gets or sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the Close() method is called.

ConformanceLevel ConformanceLevel ConformanceLevel ConformanceLevel

Ruft das Übereinstimmungsniveau ab, auf den der XML-Writer die XML-Ausgabe überprüft, oder legt dieses fest.Gets or sets the level of conformance that the XML writer checks the XML output for.

DoNotEscapeUriAttributes DoNotEscapeUriAttributes DoNotEscapeUriAttributes DoNotEscapeUriAttributes

Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob XmlWriter die URI-Attribute nicht mit Escapezeichen versehen soll.Gets or sets a value that indicates whether the XmlWriter does not escape URI attributes.

Encoding Encoding Encoding Encoding

Ruft den Typ der Textcodierung ab oder legt diesen fest.Gets or sets the type of text encoding to use.

Indent Indent Indent Indent

Ruft einen Wert ab, der angibt, ob Elemente eingezogen werden sollen, oder legt diesen fest.Gets or sets a value indicating whether to indent elements.

IndentChars IndentChars IndentChars IndentChars

Ruft die Zeichenfolge ab, die für den Einzug verwendet werden soll, oder legt diese fest.Gets or sets the character string to use when indenting. Diese Einstellung wird verwendet, wenn die Indent-Eigenschaft auf true festgelegt ist.This setting is used when the Indent property is set to true.

NamespaceHandling NamespaceHandling NamespaceHandling NamespaceHandling

Ruft einen Wert ab, der angibt, ob der XmlWriter beim Schreiben von XML-Inhalt doppelte Namespacedeklarationen entfernen soll, oder legt diesen fest.Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. Im Standardverhalten gibt der Writer alle Namespacedeklarationen aus, die in der Namespaceauflösung des Writers vorhanden sind.The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.

NewLineChars NewLineChars NewLineChars NewLineChars

Ruft die Zeichenfolge ab, die für Zeilenumbrüche verwendet werden soll, oder legt diese fest.Gets or sets the character string to use for line breaks.

NewLineHandling NewLineHandling NewLineHandling NewLineHandling

Ruft einen Wert ab, der angibt, ob Zeilenumbrüche in der Ausgabe normalisiert werden sollen, oder legt diesen fest.Gets or sets a value indicating whether to normalize line breaks in the output.

NewLineOnAttributes NewLineOnAttributes NewLineOnAttributes NewLineOnAttributes

Ruft einen Wert ab, der angibt, ob Attribute in eine neue Zeile geschrieben werden sollen, oder legt diesen fest.Gets or sets a value indicating whether to write attributes on a new line.

OmitXmlDeclaration OmitXmlDeclaration OmitXmlDeclaration OmitXmlDeclaration

Ruft einen Wert ab, der angibt, ob eine XML-Deklaration ausgelassen werden soll, oder legt diesen fest.Gets or sets a value indicating whether to omit an XML declaration.

OutputMethod OutputMethod OutputMethod OutputMethod

Ruft die Methode zum Serialisieren der XmlWriter-Ausgabe ab.Gets the method used to serialize the XmlWriter output.

WriteEndDocumentOnClose WriteEndDocumentOnClose WriteEndDocumentOnClose 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.Gets or sets a value that indicates whether the XmlWriter will add closing tags to all unclosed element tags when the Close() method is called.

Methoden

Clone() Clone() Clone() Clone()

Erstellt eine Kopie der XmlWriterSettings-Instanz.Creates a copy of the XmlWriterSettings instance.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fungiert als die Standardhashfunktion.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
Reset() Reset() Reset() Reset()

Setzt die Member der settings-Klasse auf ihre Standardwerte zurück.Resets the members of the settings class to their default values.

ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Gilt für: