Compartilhar via

XmlWriterSettings Classe

Definição

Namespace:
System.Xml
Assemblies:
System.Xml.dll, System.Xml.ReaderWriter.dll
Assemblies:
netstandard.dll, System.Xml.ReaderWriter.dll
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll
Origem:
XmlWriterSettings.cs
Origem:
XmlWriterSettings.cs
Origem:
XmlWriterSettings.cs
Origem:
XmlWriterSettings.cs
Origem:
XmlWriterSettings.cs

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

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 que é 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 garante que o objeto criado XmlWriter tenha as configurações de saída corretas.

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 Default
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 a saída deve ser verificada é um documento ou fragmento XML 1.0 bem formado. ConformanceLevel.Document (nível do 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 Default
Encoding Codificação de texto a ser usada. Valor System.Text.Encoding Encoding.UTF8
Indent Se os elementos devem ser recuos true ou false false (sem recuo)
IndentChars Cadeia de caracteres a ser usada ao recuar (usada quando Indent é definida como true). String Dois espaços
NewLineChars Cadeia de caracteres a ser usada para quebras de linha. String \r\n (retorno de carro, feed de linha) para plataformas não Unix ou \n (feed de linha) para plataformas Unix
NewLineHandling Como lidar com caracteres de nova linha. System.Xml.NewLineHandling valor: 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 uma declaração XML deve ser gravada. true ou false false

Construtores

Nome Description
XmlWriterSettings()

Inicializa uma nova instância da classe XmlWriterSettings.

Propriedades

Nome Description
Async

Obtém ou define um valor que indica se métodos assíncronos podem ser usados XmlWriter em uma instância específica XmlWriter .
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 W3C XML 1.0.
CloseOutput

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

Obtém ou define o nível de conformidade para o qual o gravador XML verifica a saída XML.
DoNotEscapeUriAttributes

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

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

Obtém ou define um valor que indica se os elementos devem ser recuos.
IndentChars

Obtém ou define a cadeia de caracteres a ser usada ao recuar. Essa configuração é usada quando a Indent propriedade é definida como true.
NamespaceHandling

Obtém ou define um valor que indica se as XmlWriter declarações de namespace devem ser removidas duplicadas ao escrever conteúdo XML. O comportamento padrão é que o gravador produza todas as declarações de namespace presentes no resolvedor de namespace do gravador.
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 as quebras de linha devem ser normalizados 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 omitir.
OutputMethod

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

Obtém ou define um valor que indica se as XmlWriter marcas de fechamento serão adicionadas a todas as marcas de elemento não reveladas quando o Close() método for chamado.

Métodos

Nome Description
Clone()

Cria uma cópia da XmlWriterSettings instância.
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 Objectatual.

(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