XmlWriterSettings.Encoding Propriedade

Definição

Obtém ou define o tipo de codificação de texto a usar.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

Valor da propriedade

Encoding

A codificação de texto a ser usada.The text encoding to use. O padrão é Encoding.UTF8.The default is Encoding.UTF8.

Exemplos

O exemplo a seguir mostra como definir a Enconding Propriedade:The following example shows how to set the Enconding property:

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.Encoding = Encoding.Unicode;
XmlWriter writer = XmlWriter.Create("books.xml", settings);
Dim settings As New XmlWriterSettings()
settings.Indent = True
settings.Encoding = Encoding.Unicode
Dim writer As XmlWriter = XmlWriter.Create("books.xml", settings)

Comentários

O XmlWriter codifica um buffer de caracteres de uma só vez, em vez de caractere por caractere.The XmlWriter encodes a buffer of characters all at once, rather than character by character. Uma exceção é lançada quando o Flush método é chamado se algum erro de codificação for encontrado.An exception is thrown when the Flush method is called if any encoding errors are encountered.

A Encoding propriedade se aplica somente às XmlWriter instâncias que são criadas com o especificado Stream ou com o nome de arquivo especificado.The Encoding property only applies to the XmlWriter instances that are created either with the specified Stream or with the specified file name. Se a XmlWriter instância for criada com o especificado TextWriter , a Encoding propriedade será substituída pela codificação do subjacente TextWriter .If the XmlWriter instance is created with the specified TextWriter, the Encoding property is overridden by the encoding of the underlying TextWriter. Por exemplo, se essa propriedade for definida como Unicode (UTF-16) para um específico XmlWriter , mas o gravador subjacente for um StreamWriter (derivado de TextWriter ) com sua codificação definida como UTF8, a saída será codificada em UTF-8.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.

Se a XmlWriter instância for criada com outros parâmetros de saída, a Encoding propriedade será ignorada.If the XmlWriter instance is created with other output parameters, the Encoding property is ignored.

No exemplo a seguir:In the following example:

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

Importante

Não aceite um Encoding objeto de uma fonte não confiável.Do not accept an Encoding object from an untrusted source.

Aplica-se a