XmlWriter Classe

Definição

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Origem:

XmlWriter.cs

Representa um gravador que fornece uma maneira rápida, não armazenada em cache, somente de encaminhamento para gerar fluxos ou arquivos que contêm dados XML.

public ref class XmlWriter abstract : IAsyncDisposable, IDisposable

public abstract class XmlWriter : IAsyncDisposable, IDisposable

type XmlWriter = class
    interface IAsyncDisposable
    interface IDisposable

Public MustInherit Class XmlWriter
Implements IAsyncDisposable, IDisposable

Herança

Object

XmlWriter

Derivado

System.Xml.XmlDictionaryWriter

System.Xml.XmlTextWriter

System.Xml.Xsl.Runtime.XmlQueryOutput

Implementações

IDisposable IAsyncDisposable

Exemplos

O código de exemplo a seguir mostra como usar a API assíncrona para gerar XML.

async Task TestWriter(Stream stream)
{
    XmlWriterSettings settings = new XmlWriterSettings();
    settings.Async = true;

    using (XmlWriter writer = XmlWriter.Create(stream, settings)) {
        await writer.WriteStartElementAsync("pf", "root", "http://ns");
        await writer.WriteStartElementAsync(null, "sub", null);
        await writer.WriteAttributeStringAsync(null, "att", null, "val");
        await writer.WriteStringAsync("text");
        await writer.WriteEndElementAsync();
        await writer.WriteProcessingInstructionAsync("pName", "pValue");
        await writer.WriteCommentAsync("cValue");
        await writer.WriteCDataAsync("cdata value");
        await writer.WriteEndElementAsync();
        await writer.FlushAsync();
    }
}

Comentários

Para obter mais informações sobre essa API, consulte comentários de API Suplementar paraXmlWriter.

Construtores

XmlWriter()

Inicializa uma nova instância da classe XmlWriter.

Propriedades

Settings	Obtém o objeto XmlWriterSettings usado para criar essa instância de XmlWriter.
WriteState	Quando substituído em uma classe derivada, obtém o estado do gravador.
XmlLang	Quando substituído em uma classe derivada, obtém o escopo xml:lang atual.
XmlSpace	Quando substituído em uma classe derivada, obtém um XmlSpace que representa o escopo xml:space atual.

Métodos

Close()	Quando substituído em uma classe derivada, fecha esse fluxo e o fluxo subjacente.
Create(Stream)	Cria uma nova instância de XmlWriter usando o fluxo especificado.
Create(Stream, XmlWriterSettings)	Cria uma nova instância de XmlWriter usando o fluxo e XmlWriterSettings objeto.
Create(String)	Cria uma nova instância de XmlWriter usando o nome de arquivo especificado.
Create(String, XmlWriterSettings)	Cria uma nova instância de XmlWriter usando o nome do arquivo e XmlWriterSettings objeto.
Create(StringBuilder)	Cria uma nova instância de XmlWriter usando o StringBuilderespecificado.
Create(StringBuilder, XmlWriterSettings)	Cria uma nova instância de XmlWriter usando os objetos StringBuilder e XmlWriterSettings.
Create(TextWriter)	Cria uma nova instância de XmlWriter usando o TextWriterespecificado.
Create(TextWriter, XmlWriterSettings)	Cria uma nova instância de XmlWriter usando os objetos TextWriter e XmlWriterSettings.
Create(XmlWriter)	Cria uma nova instância de XmlWriter usando o objeto XmlWriter especificado.
Create(XmlWriter, XmlWriterSettings)	Cria uma nova instância de XmlWriter usando os objetos XmlWriter e XmlWriterSettings especificados.
Dispose()	Libera todos os recursos usados pela instância atual da classe XmlWriter.
Dispose(Boolean)	Libera os recursos não gerenciados usados pelo XmlWriter e, opcionalmente, libera os recursos gerenciados.
DisposeAsync()	Executa tarefas definidas pelo aplicativo associadas à liberação, liberação ou redefinição de recursos não gerenciados de forma assíncrona.
DisposeAsyncCore()	Executa tarefas definidas pelo aplicativo associadas à liberação, liberação ou redefinição de recursos gerenciados de forma assíncrona.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
Flush()	Quando substituído em uma classe derivada, libera o que está no buffer para os fluxos subjacentes e também libera o fluxo subjacente.
FlushAsync()	Libera de forma assíncrona o que estiver no buffer para os fluxos subjacentes e também libera o fluxo subjacente.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
LookupPrefix(String)	Quando substituído em uma classe derivada, retorna o prefixo mais próximo definido no escopo do namespace atual para o URI do namespace.
MemberwiseClone()	Cria uma cópia superficial do Objectatual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
WriteAttributes(XmlReader, Boolean)	Quando substituído em uma classe derivada, grava todos os atributos encontrados na posição atual no XmlReader.
WriteAttributesAsync(XmlReader, Boolean)	Grava de forma assíncrona todos os atributos encontrados na posição atual no XmlReader.
WriteAttributeString(String, String)	Quando substituído em uma classe derivada, grava o atributo com o nome e o valor locais especificados.
WriteAttributeString(String, String, String)	Quando substituído em uma classe derivada, grava um atributo com o nome local, o URI do namespace e o valor especificados.
WriteAttributeString(String, String, String, String)	Quando substituído em uma classe derivada, grava o atributo com o prefixo, o nome local, o URI do namespace e o valor especificados.
WriteAttributeStringAsync(String, String, String, String)	Grava de forma assíncrona o atributo com o prefixo, o nome local, o URI do namespace e o valor especificados.
WriteBase64(Byte[], Int32, Int32)	Quando substituído em uma classe derivada, codifica os bytes binários especificados como Base64 e grava o texto resultante.
WriteBase64Async(Byte[], Int32, Int32)	Codifica de forma assíncrona os bytes binários especificados como Base64 e grava o texto resultante.
WriteBinHex(Byte[], Int32, Int32)	Quando substituído em uma classe derivada, codifica os bytes binários especificados como BinHex e grava o texto resultante.
WriteBinHexAsync(Byte[], Int32, Int32)	Codifica de forma assíncrona os bytes binários especificados como BinHex e grava o texto resultante.
WriteCData(String)	Quando substituído em uma classe derivada, grava um <! [CDATA[...]]> bloco que contém o texto especificado.
WriteCDataAsync(String)	Grava de forma assíncrona um <! [CDATA[...]]> bloco que contém o texto especificado.
WriteCharEntity(Char)	Quando substituído em uma classe derivada, força a geração de uma entidade de caractere para o valor de caractere Unicode especificado.
WriteCharEntityAsync(Char)	Força de forma assíncrona a geração de uma entidade de caractere para o valor de caractere Unicode especificado.
WriteChars(Char[], Int32, Int32)	Quando substituído em uma classe derivada, grava um buffer de texto por vez.
WriteCharsAsync(Char[], Int32, Int32)	Grava de forma assíncrona o texto um buffer de cada vez.
WriteComment(String)	Quando substituído em uma classe derivada, grava um comentário <!--...--> que contém o texto especificado.
WriteCommentAsync(String)	Grava de forma assíncrona um comentário <!--...--> que contém o texto especificado.
WriteDocType(String, String, String, String)	Quando substituído em uma classe derivada, grava a declaração DOCTYPE com o nome especificado e atributos opcionais.
WriteDocTypeAsync(String, String, String, String)	Grava de forma assíncrona a declaração DOCTYPE com o nome especificado e atributos opcionais.
WriteElementString(String, String)	Grava um elemento com o nome e o valor locais especificados.
WriteElementString(String, String, String)	Grava um elemento com o nome local, o URI do namespace e o valor especificados.
WriteElementString(String, String, String, String)	Grava um elemento com o prefixo, o nome local, o URI do namespace e o valor especificados.
WriteElementStringAsync(String, String, String, String)	Grava de forma assíncrona um elemento com o prefixo, o nome local, o URI do namespace e o valor especificados.
WriteEndAttribute()	Quando substituído em uma classe derivada, fecha a chamada WriteStartAttribute(String, String) anterior.
WriteEndAttributeAsync()	Fecha assíncronamente a chamada WriteStartAttribute(String, String) anterior.
WriteEndDocument()	Quando substituído em uma classe derivada, fecha todos os elementos ou atributos abertos e coloca o gravador de volta no estado Iniciar.
WriteEndDocumentAsync()	Fecha de forma assíncrona todos os elementos ou atributos abertos e coloca o gravador de volta no estado Iniciar.
WriteEndElement()	Quando substituído em uma classe derivada, fecha um elemento e exibe o escopo do namespace correspondente.
WriteEndElementAsync()	Fecha de forma assíncrona um elemento e exibe o escopo do namespace correspondente.
WriteEntityRef(String)	Quando substituído em uma classe derivada, grava uma referência de entidade como &name;.
WriteEntityRefAsync(String)	Grava de forma assíncrona uma referência de entidade como &name;.
WriteFullEndElement()	Quando substituído em uma classe derivada, fecha um elemento e exibe o escopo do namespace correspondente.
WriteFullEndElementAsync()	Fecha de forma assíncrona um elemento e exibe o escopo do namespace correspondente.
WriteName(String)	Quando substituído em uma classe derivada, grava o nome especificado, garantindo que ele seja um nome válido de acordo com a recomendação W3C XML 1.0 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).
WriteNameAsync(String)	Grava de forma assíncrona o nome especificado, garantindo que ele seja um nome válido de acordo com a recomendação W3C XML 1.0 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).
WriteNmToken(String)	Quando substituído em uma classe derivada, grava o nome especificado, garantindo que seja um NmToken válido de acordo com a recomendação W3C XML 1.0 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).
WriteNmTokenAsync(String)	Grava de forma assíncrona o nome especificado, garantindo que ele seja um NmToken válido de acordo com a recomendação W3C XML 1.0 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).
WriteNode(XmlReader, Boolean)	Quando substituído em uma classe derivada, copia tudo, do leitor para o gravador e move o leitor para o início do próximo irmão.
WriteNode(XPathNavigator, Boolean)	Copia tudo do objeto XPathNavigator para o gravador. A posição do XPathNavigator permanece inalterada.
WriteNodeAsync(XmlReader, Boolean)	Copia de forma assíncrona tudo, desde o leitor até o gravador e move o leitor para o início do próximo irmão.
WriteNodeAsync(XPathNavigator, Boolean)	Copia de forma assíncrona tudo do objeto XPathNavigator para o gravador. A posição do XPathNavigator permanece inalterada.
WriteProcessingInstruction(String, String)	Quando substituído em uma classe derivada, grava uma instrução de processamento com um espaço entre o nome e o texto da seguinte maneira: <?name text?>.
WriteProcessingInstructionAsync(String, String)	Grava de forma assíncrona uma instrução de processamento com um espaço entre o nome e o texto da seguinte maneira: <?name text?>.
WriteQualifiedName(String, String)	Quando substituído em uma classe derivada, grava o nome qualificado do namespace. Esse método procura o prefixo que está no escopo do namespace fornecido.
WriteQualifiedNameAsync(String, String)	Grava de forma assíncrona o nome qualificado do namespace. Esse método procura o prefixo que está no escopo do namespace fornecido.
WriteRaw(Char[], Int32, Int32)	Quando substituído em uma classe derivada, grava a marcação bruta manualmente de um buffer de caracteres.
WriteRaw(String)	Quando substituído em uma classe derivada, grava a marcação bruta manualmente de uma cadeia de caracteres.
WriteRawAsync(Char[], Int32, Int32)	Grava manualmente a marcação bruta de forma assíncrona de um buffer de caracteres.
WriteRawAsync(String)	Grava a marcação bruta manualmente de uma cadeia de caracteres de forma assíncrona.
WriteStartAttribute(String)	Grava o início de um atributo com o nome local especificado.
WriteStartAttribute(String, String)	Grava o início de um atributo com o nome local especificado e o URI do namespace.
WriteStartAttribute(String, String, String)	Quando substituído em uma classe derivada, grava o início de um atributo com o prefixo, o nome local e o URI do namespace especificados.
WriteStartAttributeAsync(String, String, String)	Grava de forma assíncrona o início de um atributo com o prefixo, o nome local e o URI do namespace especificados.
WriteStartDocument()	Quando substituído em uma classe derivada, grava a declaração XML com a versão "1.0".
WriteStartDocument(Boolean)	Quando substituído em uma classe derivada, grava a declaração XML com a versão "1.0" e o atributo autônomo.
WriteStartDocumentAsync()	Grava de forma assíncrona a declaração XML com a versão "1.0".
WriteStartDocumentAsync(Boolean)	Grava de forma assíncrona a declaração XML com a versão "1.0" e o atributo autônomo.
WriteStartElement(String)	Quando substituído em uma classe derivada, grava uma marca inicial com o nome local especificado.
WriteStartElement(String, String)	Quando substituído em uma classe derivada, grava a marca inicial especificada e a associa ao namespace fornecido.
WriteStartElement(String, String, String)	Quando substituído em uma classe derivada, grava a marca inicial especificada e a associa ao namespace e ao prefixo fornecidos.
WriteStartElementAsync(String, String, String)	Grava de forma assíncrona a marca inicial especificada e a associa ao namespace e ao prefixo fornecidos.
WriteString(String)	Quando substituído em uma classe derivada, grava o conteúdo de texto especificado.
WriteStringAsync(String)	Grava de forma assíncrona o conteúdo de texto especificado.
WriteSurrogateCharEntity(Char, Char)	Quando substituído em uma classe derivada, gera e grava a entidade de caractere substituto para o par de caracteres alternativos.
WriteSurrogateCharEntityAsync(Char, Char)	Gera e grava de forma assíncrona a entidade de caractere substituto para o par de caracteres substituto.
WriteValue(Boolean)	Grava um valor Boolean.
WriteValue(DateTime)	Grava um valor DateTime.
WriteValue(DateTimeOffset)	Grava um valor DateTimeOffset.
WriteValue(Decimal)	Grava um valor Decimal.
WriteValue(Double)	Grava um valor Double.
WriteValue(Int32)	Grava um valor Int32.
WriteValue(Int64)	Grava um valor Int64.
WriteValue(Object)	Grava o valor do objeto.
WriteValue(Single)	Grava um número de ponto flutuante de precisão única.
WriteValue(String)	Grava um valor String.
WriteWhitespace(String)	Quando substituído em uma classe derivada, grava o espaço em branco especificado.
WriteWhitespaceAsync(String)	Grava de forma assíncrona o espaço em branco determinado.

Métodos de Extensão

ConfigureAwait(IAsyncDisposable, Boolean)

Configura como as esperas nas tarefas retornadas de um descartável assíncrono serão executadas.

Confira também

• documentos XML e de dados