XmlWriterSettings Classe

Definição

Especifica um conjunto de recursos para dar suporte ao objeto XmlWriter criado pelo método Create.Specifies a set of features to support on the XmlWriter object created by the Create method.

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

Exemplos

O exemplo a seguir cria um XmlWriter que grava em um arquivo XML e grava cada atributo em uma nova linha.The following example creates an XmlWriter that writes to an XML file and writes each attribute on a new line.

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:The sample produces the following output:

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

Comentários

O Create método é o mecanismo preferencial para a obtenção de XmlWriter instâncias.The Create method is the preferred mechanism for obtaining XmlWriter instances. O Create método usa a XmlWriterSettings classe para especificar quais recursos implementar no XmlWriter objeto que é criado.The Create method uses the XmlWriterSettings class to specify which features to implement in the XmlWriter object that is created.

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.If you're using the XmlWriter object with the Transform method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. Isso assegura que o objeto XmlWriter criado tenha as configurações de saída correta.This ensures that the created XmlWriter object has the correct output settings.

A XmlWriterSettings classe fornece propriedades que controlam a conformidade de dados e o formato de saída.The XmlWriterSettings class provides properties that control data conformance and output format.

Para verificações de conformidade de dados e correções automáticas, use estas propriedades:For data conformance checks and auto-corrections, use these properties:

PropriedadeProperty EspecificaSpecifies ValorValue PadrãoDefault
CheckCharacters Se é para verificar se os caracteres estão no conjunto de caracteres XML jurídico, conforme definido pelo W3C.Whether to check that characters are in the legal XML character set, as defined by W3C. true ou falsetrue or false true
ConformanceLevel Se é para verificar se a saída é um fragmento ou documento XML 1,0 bem formado.Whether to check that output is a well-formed XML 1.0 document or fragment. ConformanceLevel.Document (nível de documento), Fragment (nível de fragmento) ou Auto (detecção automática)ConformanceLevel.Document (document-level), Fragment (fragment-level), or Auto (auto-detection) ConformanceLevel.Document (conformidade em nível de documento)ConformanceLevel.Document (document-level conformance)
WriteEndDocumentOnClose Se as marcas de fechamento serão adicionadas a todos os elementos não fechados quando o Close método for chamado.Whether to add closing tags to all unclosed elements when the Close method is called. true ou falsetrue or false true

Para especificar o formato de saída, use estas propriedades:To specify output format, use these properties:

PropriedadeProperty EspecificaSpecifies ValorValue PadrãoDefault
Encoding Codificação de texto a ser usada.Text encoding to use. System.Text.Encoding valorSystem.Text.Encoding value Encoding.UTF8
Indent Se os elementos devem ser recuadosWhether to indent elements true ou falsetrue or false false (sem recuo)false (no indentation)
IndentChars Cadeia de caracteres a ser usada ao recuar (usado quando Indent é definido como true ).Character string to use when indenting (used when Indent is set to true). StringString Dois espaçosTwo spaces
NewLineChars Cadeia de caracteres a ser usada para quebras de linha.Character string to use for line breaks. StringString \r\n (retorno de carro, alimentação de linha)\r\n (carriage return, line feed)
NewLineHandling Como lidar com caracteres de nova linha.How to handle newline characters. System.Xml.NewLineHandling valor: Entitize (Normalize), Replace (replace) ou None (deixe inalterado)System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace), or None (leave unchanged) Replace (substituir pelos caracteres especificados por NewLineChars )Replace (replace with characters specified by NewLineChars)
NewLineOnAttributes Se os atributos devem ser gravados em linhas individuais (não tem efeito quando Indent é false ).Whether to write attributes on individual lines (has no effect when Indent is false). true ou falsetrue or false false
OmitXmlDeclaration Se uma declaração XML deve ser gravada.Whether to write an XML declaration. true ou falsetrue or false false

Construtores

XmlWriterSettings()

Inicializa uma nova instância da classe XmlWriterSettings.Initializes a new instance of the XmlWriterSettings class.

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.Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

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.Gets or sets a value that indicates whether the XML writer should check to ensure that all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.

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.Gets or sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the Close() method is called.

ConformanceLevel

Obtém ou define o nível de conformidade em relação ao qual o gravador de XML verifica a saída XML.Gets or sets the level of conformance that the XML writer checks the XML output for.

DoNotEscapeUriAttributes

Obtém ou define um valor que indica se o XmlWriter não escapa atributos de URI.Gets or sets a value that indicates whether the XmlWriter does not escape URI attributes.

Encoding

Obtém ou define o tipo de codificação de texto a usar.Gets or sets the type of text encoding to use.

Indent

Obtém ou define um valor que indica se deseja recuar elementos.Gets or sets a value indicating whether to indent elements.

IndentChars

Especifica ou define a cadeia de caracteres a ser usada ao recuar.Gets or sets the character string to use when indenting. Esta configuração é usada quando a propriedade Indent for definida como true.This setting is used when the Indent property is set to 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.Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. O comportamento padrão do gravador é produzir todas as declarações de namespace presentes no resolvedor do namespace do gravador como saída.The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.

NewLineChars

Obtém ou define a cadeia de caracteres a ser usada para quebras de linha.Gets or sets the character string to use for line breaks.

NewLineHandling

Obtém ou define um valor que indica se você deseja normalizar quebras de linha na saída.Gets or sets a value indicating whether to normalize line breaks in the output.

NewLineOnAttributes

Obtém ou define um valor que indica se os atributos devem ser gravados em uma nova linha.Gets or sets a value indicating whether to write attributes on a new line.

OmitXmlDeclaration

Obtém ou define um valor que indica se uma declaração XML deve ser omitida.Gets or sets a value indicating whether to omit an XML declaration.

OutputMethod

Obtém o método usado para serializar a saída XmlWriter.Gets the method used to serialize the XmlWriter output.

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.Gets or sets a value that indicates whether the XmlWriter will add closing tags to all unclosed element tags when the Close() method is called.

Métodos

Clone()

Cria uma cópia da instância XmlWriterSettings.Creates a copy of the XmlWriterSettings instance.

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
Reset()

Redefine os membros da classe de configurações para seus valores padrão.Resets the members of the settings class to their default values.

ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Aplica-se a