XmlWriterSettings XmlWriterSettings XmlWriterSettings XmlWriterSettings Class

Definición

Especifica un conjunto de características compatibles en el objeto XmlWriter creado mediante el 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
Herencia
XmlWriterSettingsXmlWriterSettingsXmlWriterSettingsXmlWriterSettings

Ejemplos

En el ejemplo siguiente se XmlWriter crea un que escribe en un archivo XML y escribe cada atributo en una nueva línea.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()

El ejemplo genera el siguiente resultado:The sample produces the following output:

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

Comentarios

El Create método es el mecanismo preferido para obtener XmlWriter instancias de.The Create method is the preferred mechanism for obtaining XmlWriter instances. El Create método utiliza la XmlWriterSettings clase para especificar qué características se van a implementar XmlWriter en el objeto que se crea.The Create method uses the XmlWriterSettings class to specify which features to implement in the XmlWriter object that is created.

Nota

XmlWriter Si está utilizando el objeto con el Transform método, debe usar la OutputSettings propiedad para obtener un XmlWriterSettings objeto con la configuración correcta.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. Con ello se garantiza que el objeto XmlWriter creado tenga la configuración de resultados correcta.This ensures that the created XmlWriter object has the correct output settings.

La XmlWriterSettings clase proporciona propiedades que controlan el formato de salida y la conformidad de los datos.The XmlWriterSettings class provides properties that control data conformance and output format.

En el caso de las comprobaciones de cumplimiento de datos y las correcciones automáticas, use estas propiedades:For data conformance checks and auto-corrections, use these properties:

Propiedad.Property EspecificaSpecifies ValorValue DefaultDefault
CheckCharacters Indica si se debe comprobar si los caracteres están en el juego de caracteres XML legal, tal y como se define en W3C.Whether to check that characters are in the legal XML character set, as defined by W3C. true o falsetrue or false true
ConformanceLevel Si se va a comprobar que la salida es un documento o fragmento XML de formato correcto 1,0.Whether to check that output is a well-formed XML 1.0 document or fragment. ConformanceLevel.Document(nivel de documento), Fragment (nivel de fragmento) o Auto (detección automática)ConformanceLevel.Document (document-level), Fragment (fragment-level), or Auto (auto-detection) ConformanceLevel.Document(conformidad de nivel de documento)ConformanceLevel.Document (document-level conformance)
WriteEndDocumentOnClose Indica si se van a agregar etiquetas de cierre a todos los elementos Close sin cerrar cuando se llama al método.Whether to add closing tags to all unclosed elements when the Close method is called. true o falsetrue or false true

Para especificar el formato de salida, use estas propiedades:To specify output format, use these properties:

Propiedad.Property EspecificaSpecifies ValorValue DefaultDefault
Encoding Codificación de texto que se va a usar.Text encoding to use. Valor deSystem.Text.EncodingSystem.Text.Encoding value Encoding.UTF8
Indent Si se van a aplicar sangría a los elementosWhether to indent elements true o falsetrue or false false(sin sangría)false (no indentation)
IndentChars Cadena de caracteres que se va a usar al aplicar sangría Indent (se utiliza truecuando está establecido en).Character string to use when indenting (used when Indent is set to true). StringString Dos espaciosTwo spaces
NewLineChars Cadena de caracteres que se va a utilizar para los saltos de línea.Character string to use for line breaks. StringString \r\n(retorno de carro, avance de línea)\r\n (carriage return, line feed)
NewLineHandling Cómo controlar los caracteres de nueva línea.How to handle newline characters. System.Xml.NewLineHandlingvalor: Entitize (normalizar) Replace , (reemplazar) o None (dejar sin cambios)System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace), or None (leave unchanged) Replace(reemplazar por los caracteres especificados por NewLineChars)Replace (replace with characters specified by NewLineChars)
NewLineOnAttributes Indica si se van a escribir atributos en líneas individuales (no Indent tiene falseningún efecto cuando es).Whether to write attributes on individual lines (has no effect when Indent is false). true o falsetrue or false false
OmitXmlDeclaration Indica si se va a escribir una declaración XML.Whether to write an XML declaration. true o falsetrue or false false

Constructores

XmlWriterSettings() XmlWriterSettings() XmlWriterSettings() XmlWriterSettings()

Inicializa una nueva instancia de la clase XmlWriterSettings.Initializes a new instance of the XmlWriterSettings class.

Propiedades

Async Async Async Async

Obtiene o establece un valor que indica si los métodos asincrónicos XmlWriter se pueden utilizar en una instancia determinada de XmlWriter.Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

CheckCharacters CheckCharacters CheckCharacters CheckCharacters

Obtiene o establece un valor que indica si el escritor XML debería comprobar y asegurarse de que todos los caracteres en el documento se ajustan a la sección "2.2 Characters" de la recomendación del Consorcio W3C XML 1.0.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 CloseOutput CloseOutput CloseOutput

Obtiene o establece un valor que indica si el objeto XmlWriter también debe cerrar la secuencia subyacente o TextWriter cuando se llama al método Close().Gets or sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the Close() method is called.

ConformanceLevel ConformanceLevel ConformanceLevel ConformanceLevel

Obtiene o establece el nivel de conformidad que el sistema de escritura XML comprueba para la salida XML.Gets or sets the level of conformance that the XML writer checks the XML output for.

DoNotEscapeUriAttributes DoNotEscapeUriAttributes DoNotEscapeUriAttributes DoNotEscapeUriAttributes

Obtiene o establece un valor que indica si XmlWriter no realiza escape de los atributos de URI.Gets or sets a value that indicates whether the XmlWriter does not escape URI attributes.

Encoding Encoding Encoding Encoding

Obtiene o establece el tipo de codificación de texto que se va a usar.Gets or sets the type of text encoding to use.

Indent Indent Indent Indent

Obtiene o establece un valor que indica si se va a aplicar sangría a los elementos.Gets or sets a value indicating whether to indent elements.

IndentChars IndentChars IndentChars IndentChars

Obtiene o establece la cadena de caracteres que se va a utilizar al aplicar sangría.Gets or sets the character string to use when indenting. Esta opción se utiliza cuando la propiedad Indent se establece en true.This setting is used when the Indent property is set to true.

NamespaceHandling NamespaceHandling NamespaceHandling NamespaceHandling

Obtiene o establece un valor que indica si XmlWriter debe quitar declaraciones de espacio de nombres duplicadas al escribir contenido XML.Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. El comportamiento predeterminado es que el sistema de escritura genere todas las declaraciones de espacio de nombres que se encuentran en la resolución de espacios de nombres del sistema de escritura.The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.

NewLineChars NewLineChars NewLineChars NewLineChars

Obtiene o establece la cadena de caracteres que se va a utilizar para los saltos de línea.Gets or sets the character string to use for line breaks.

NewLineHandling NewLineHandling NewLineHandling NewLineHandling

Obtiene o establece un valor que indica si se deben normalizar los saltos de línea en el resultado.Gets or sets a value indicating whether to normalize line breaks in the output.

NewLineOnAttributes NewLineOnAttributes NewLineOnAttributes NewLineOnAttributes

Obtiene o establece un valor que indica si los atributos se deben escribir en una nueva línea.Gets or sets a value indicating whether to write attributes on a new line.

OmitXmlDeclaration OmitXmlDeclaration OmitXmlDeclaration OmitXmlDeclaration

Obtiene o establece un valor que indica si debe omitir una declaración XML.Gets or sets a value indicating whether to omit an XML declaration.

OutputMethod OutputMethod OutputMethod OutputMethod

Obtiene el método utilizado para serializar el resultado de XmlWriter.Gets the method used to serialize the XmlWriter output.

WriteEndDocumentOnClose WriteEndDocumentOnClose WriteEndDocumentOnClose WriteEndDocumentOnClose

Obtiene o establece un valor que indica si XmlWriter agregará etiquetas de cierre a todas las etiquetas de elementos sin cerrar cuando se llame al método Close().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() Clone() Clone() Clone()

Crea una copia de la instancia de la clase XmlWriterSettings.Creates a copy of the XmlWriterSettings instance.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
Reset() Reset() Reset() Reset()

Restablece los miembros de la clase de configuración a sus valores predeterminados.Resets the members of the settings class to their default values.

ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Se aplica a