XmlWriterSettings Classe

Definição

Espaço de Nomes:
System.Xml
Assemblagens:
System.Xml.dll, System.Xml.ReaderWriter.dll
Assemblagem:
System.Xml.dll
Assemblagem:
System.Xml.ReaderWriter.dll
Assemblagem:
netstandard.dll

Especifica um conjunto de funcionalidades a suportar no 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 seguinte cria um XmlWriter que escreve num ficheiro XML e escreve cada atributo numa 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()

A amostra produz o seguinte resultado:

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

Observações

O Create método é o mecanismo preferido para obter XmlWriter instâncias. O Create método utiliza a XmlWriterSettings classe para especificar quais as funcionalidades a implementar no XmlWriter objeto criado.

Note

Se estiveres a usar o XmlWriter objeto com o Transform método, deves usar a OutputSettings propriedade para obter um XmlWriterSettings objeto com as definições corretas. Isto garante que o objeto criado XmlWriter tem as definições de saída corretas.

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

Para verificações de conformidade e autocorreções de dados, utilize estas propriedades:

Property Especifica valor Predefinido
CheckCharacters Se deve verificar se os caracteres estão no conjunto de caracteres XML legal, conforme definido pelo W3C. true ou false true
ConformanceLevel Se deve verificar se o resultado é um documento XML 1.0 bem formado ou fragmento. ConformanceLevel.Document (nível de documento), Fragment (nível de fragmento) ou Auto (auto-deteção) ConformanceLevel.Document (conformidade ao nível do documento)
WriteEndDocumentOnClose Se deve adicionar etiquetas de fecho a todos os elementos não fechados quando o Close método é chamado. true ou false true

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

Property Especifica valor Predefinido
Encoding Codificação de texto para usar. System.Text.Encoding valor Encoding.UTF8
Indent Se deve indentar elementos true ou false false (sem reentrância)
IndentChars Cadeia de caracteres a usar ao indentar (usada quando Indent está definida como true). String Dois espaços
NewLineChars Cadeia de caracteres para usar para quebras de linha. String \r\n (retorno de carro, alimentação de linha) para plataformas não-Unix, ou \n (alimentação de linha) para plataformas Unix
NewLineHandling Como lidar com personagens de nova linha. System.Xml.NewLineHandling valor: Entitize (normalizar), Replace (substituir) ou None (deixar inalterado) Replace (substituir com caracteres especificados por NewLineChars)
NewLineOnAttributes Se deve escrever atributos em linhas individuais (não tem efeito quando Indent é false). true ou false false
OmitXmlDeclaration Se deve escrever uma declaração XML. true ou false false

Construtores

Name Description
XmlWriterSettings()

Inicializa uma nova instância da XmlWriterSettings classe.

Propriedades

Name Description
Async

Obtém ou define um valor que indica se métodos assíncronos XmlWriter podem ser usados numa instância particular XmlWriter .
CheckCharacters

Recebe ou define um valor que indica se o escritor XML deve verificar se todos os caracteres no documento cumprem a secção "2.2 Caracteres" da Recomendação XML 1.0 do W3C.
CloseOutput

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

Obtém ou define o nível de conformidade que o escritor XML verifica na saída XML.
DoNotEscapeUriAttributes

Recebe ou define um valor que indica se o XmlWriter não escapa dos atributos 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 deve indentar elementos.
IndentChars

Obtém ou define a cadeia de caracteres para usar ao incarnar. Esta definição é usada quando a Indent propriedade está definida para true.
NamespaceHandling

Recebe ou define um valor que indica se deve XmlWriter remover declarações duplicadas de namespace ao escrever conteúdo XML. O comportamento padrão é o escritor gerar todas as declarações de namespace presentes no resolver de namespace do escritor.
NewLineChars

Obtém ou define a cadeia de caracteres para usar nos quebras de linha.
NewLineHandling

Recebe ou define um valor que indica se deve normalizar quebras de linha na saída.
NewLineOnAttributes

Recebe ou define um valor que indica se deve escrever atributos numa nova linha.
OmitXmlDeclaration

Recebe ou define um valor que indica se deve omitir uma declaração XML.
OutputMethod

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

Recebe ou define um valor que indica se irá XmlWriter adicionar etiquetas de fecho a todas as etiquetas de elementos não fechados quando o Close() método for chamado.

Métodos

Name 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 função de hash predefinida.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do atual Object.

(Herdado de Object)
Reset()

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

Devolve uma cadeia que representa o objeto atual.

(Herdado de Object)

Aplica-se a