XmlWriterSettings.Encoding XmlWriterSettings.Encoding XmlWriterSettings.Encoding XmlWriterSettings.Encoding Property

Definition

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

public:
 property System::Text::Encoding ^ Encoding { System::Text::Encoding ^ get(); void set(System::Text::Encoding ^ value); };
public System.Text.Encoding Encoding { get; set; }
member this.Encoding : System.Text.Encoding with get, set
Public Property Encoding As Encoding

Eigenschaftswert

Die zu verwendende Textcodierung.The text encoding to use. Die Standardeinstellung ist Encoding.UTF8.The default is Encoding.UTF8.

Beispiele

Im folgenden Beispiel wird ein XML-Fragment in einen Speicherstream geschrieben.The following example writes an XML fragment to a memory stream.

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");
writer.Flush();
writer.Close();

// Do additonal processing on the stream.
Dim settings As XmlWriterSettings = New XmlWriterSettings()
settings.OmitXmlDeclaration = true
settings.ConformanceLevel = ConformanceLevel.Fragment
settings.CloseOutput = false

' Create the XmlWriter object and write some content.
Dim strm as MemoryStream = new MemoryStream()
Dim writer As XmlWriter = XmlWriter.Create(strm, settings)
writer.WriteElementString("orderID", "1-456-ab")
writer.WriteElementString("orderID", "2-36-00a")
writer.Flush()
writer.Close()

' Do additonal processing on the stream.

Hinweise

Der XmlWriter codiert einen Puffer von Zeichen auf einmal und nicht als Zeichen nach Zeichen.The XmlWriter encodes a buffer of characters all at once, rather than character by character. Eine-Ausnahme wird ausgelöst, Flush wenn die-Methode aufgerufen wird, wenn Codierungsfehler auftreten.An exception is thrown when the Flush method is called if any encoding errors are encountered.

Die Encoding -Eigenschaft gilt nur für XmlWriter die-Instanzen, die mit dem angegebenen Stream oder mit dem angegebenen Dateinamen erstellt werden.The Encoding property only applies to the XmlWriter instances that are created either with the specified Stream or with the specified file name. Wenn die XmlWriter -Instanz mit dem angegebenen TextWritererstellt wird, Encoding wird die-Eigenschaft von der Codierung des zugrunde liegenden TextWriterüberschrieben.If the XmlWriter instance is created with the specified TextWriter, the Encoding property is overridden by the encoding of the underlying TextWriter. Wenn diese Eigenschaft beispielsweise für einen bestimmten XmlWriterauf Unicode (UTF-16) festgelegt ist, der zugrunde liegende Writer jedoch ein StreamWriter ist (der von TextWriterabgeleitet ist), dessen Codierung auf UTF8 festgelegt ist, wird die Ausgabe UTF-8-codiert.For example, if this property is set to Unicode (UTF-16) for a particular XmlWriter, but the underlying writer is a StreamWriter (which derives from TextWriter) with its encoding set to UTF8, the output will be UTF-8 encoded.

Wenn die XmlWriter -Instanz mit anderen Ausgabeparametern erstellt wird, Encoding wird die-Eigenschaft ignoriert.If the XmlWriter instance is created with other output parameters, the Encoding property is ignored.

Im folgenden Beispiel:In the following example:

  • Der Standardwert von Encoding ist Encoding.UTF8.The default value of Encoding is Encoding.UTF8.

  • Der StreamWriter wird auf fest Encoding.Unicode gelegt, StreamWriterund die-Codierung über Encoding schreibt die-Einstellung.The StreamWriter is set to Encoding.Unicode and the StreamWriter's encoding overrides the Encoding setting.

  • Die Ausgabe Encoding.Unicodelautet.The output will be Encoding.Unicode.

using (StreamWriter output =  
    new StreamWriter(new FileStream("Xml01.xml", FileMode.Create), Encoding.Unicode))  
{  
    using (XmlWriter xmlWriter =  
        XmlWriter.Create(output, new XmlWriterSettings()))  
    {  
        xmlWriter.WriteStartDocument();  
        xmlWriter.WriteStartElement("Root");  
        xmlWriter.WriteEndElement();  
        xmlWriter.WriteEndDocument();  
    }  
}  

Wichtig

Akzeptieren Sie kein Encoding Objekt aus einer nicht vertrauenswürdigen Quelle.Do not accept an Encoding object from an untrusted source.

Gilt für: