XmlWriterSettings Classe

  • Referência

Definição

Namespace:
System.Xml
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll

Especifica um conjunto de recursos para dar suporte ao objeto XmlWriter criado pelo método Create.

public ref class XmlWriterSettings sealed
public sealed class XmlWriterSettings
type XmlWriterSettings = class
Public NotInheritable Class XmlWriterSettings
Herança
Object
XmlWriterSettings

Exemplos

O exemplo a seguir cria um XmlWriter que grava em um arquivo XML e grava cada atributo em uma nova linha.

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

O exemplo produz a seguinte saída:

<order
  orderID="367A54"
  date="2001-05-03">
  <price>19.95</price>
</order>

Comentários

O Create método é o mecanismo preferencial para obter XmlWriter instâncias. O Create método usa a XmlWriterSettings classe para especificar quais recursos implementar no XmlWriter objeto criado.

Observação

Se você estiver usando o XmlWriter objeto com o Transform método , deverá usar a OutputSettings propriedade para obter um XmlWriterSettings objeto com as configurações corretas. Isso assegura que o objeto XmlWriter criado tenha as configurações de saída correta.

A XmlWriterSettings classe fornece propriedades que controlam a conformidade de dados e o formato de saída.

Para verificações de conformidade de dados e correções automáticas, use estas propriedades:

Propriedade Especifica Valor Padrão
CheckCharacters Se deseja verificar se os caracteres estão no conjunto de caracteres XML legal, conforme definido pelo W3C. true ou false true
ConformanceLevel Se é necessário verificar se a saída é um documento ou fragmento XML 1.0 bem formado. ConformanceLevel.Document (nível de documento), Fragment (nível de fragmento) ou Auto (detecção automática) ConformanceLevel.Document (conformidade no nível do documento)
WriteEndDocumentOnClose Se deve adicionar marcas de fechamento a todos os elementos não revelados quando o Close método é chamado. true ou false true

Para especificar o formato de saída, use estas propriedades:

Propriedade Especifica Valor Padrão
Encoding Codificação de texto a ser usada. System.Text.Encoding valor Encoding.UTF8
Indent Se os elementos devem ser recuos true ou false false (sem recuo)
IndentChars Cadeia de caracteres a ser usada ao recuar (usado quando Indent é definido como true). String Dois espaços
NewLineChars Cadeia de caracteres a ser usada para quebras de linha. String \r\n (retorno de carro, alimentação de linha)
NewLineHandling Como lidar com caracteres de nova linha. System.Xml.NewLineHandling value: Entitize (normalizar), Replace (substituir) ou None (deixar inalterado) Replace (substitua por caracteres especificados por NewLineChars)
NewLineOnAttributes Se os atributos devem ser gravados em linhas individuais (não tem efeito quando Indent é false). true ou false false
OmitXmlDeclaration Se deve gravar uma declaração XML. true ou false false

Construtores

XmlWriterSettings()

Inicializa uma nova instância da classe XmlWriterSettings.

Propriedades

Async

Obtém ou define um valor que indica se métodos XmlWriter assíncronos podem ser usados em uma instância XmlWriter específica.
CheckCharacters

Obtém ou define um valor que indica se o gravador XML deve verificar para garantir que todos os caracteres no documento estejam em conformidade com a seção "2.2 Caracteres" da Recomendação XML 1.0 do W3C.
CloseOutput

Obtém ou define um valor que indica se o XmlWriter deve fechar também o fluxo subjacente ou TextWriter quando o método Close() for chamado.
ConformanceLevel

Obtém ou define o nível de conformidade em relação ao qual o gravador de XML verifica a saída XML.
DoNotEscapeUriAttributes

Obtém ou define um valor que indica se o XmlWriter não escapa atributos de URI.
Encoding

Obtém ou define o tipo de codificação de texto a usar.
Indent

Obtém ou define um valor que indica se deseja recuar elementos.
IndentChars

Especifica ou define a cadeia de caracteres a ser usada ao recuar. Esta configuração é usada quando a propriedade Indent for definida como true.
NamespaceHandling

Obtém ou define um valor que indica se o XmlWriter deve remover declarações de namespace duplicadas ao gravar o conteúdo XML. O comportamento padrão do gravador é produzir todas as declarações de namespace presentes no resolvedor do namespace do gravador como saída.
NewLineChars

Obtém ou define a cadeia de caracteres a ser usada para quebras de linha.
NewLineHandling

Obtém ou define um valor que indica se você deseja normalizar quebras de linha na saída.
NewLineOnAttributes

Obtém ou define um valor que indica se os atributos devem ser gravados em uma nova linha.
OmitXmlDeclaration

Obtém ou define um valor que indica se uma declaração XML deve ser omitida.
OutputMethod

Obtém o método usado para serializar a saída XmlWriter.
WriteEndDocumentOnClose

Obtém ou define um valor que indica se o XmlWriter adicionará marcas de fechamento a odas as marcas de elemento que não estiverem fechadas quando o método Close() for chamado.

Métodos

Clone()

Cria uma cópia da instância XmlWriterSettings.
Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
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)
MemberwiseClone()

Cria uma cópia superficial do Object atual.

(Herdado de Object)
Reset()

Redefine os membros da classe de configurações para seus valores padrão.
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Aplica-se a