XmlWriterSettings Clase

Definición

Espacio de nombres:

System.Xml

Ensamblado:

System.Xml.ReaderWriter.dll

Ensamblado:

System.Xml.dll

Ensamblado:

netstandard.dll

Especifica un conjunto de características compatibles en el objeto XmlWriter creado mediante el método Create.

public ref class XmlWriterSettings sealed

public sealed class XmlWriterSettings

type XmlWriterSettings = class

Public NotInheritable Class XmlWriterSettings

Herencia

Object

XmlWriterSettings

Ejemplos

En el ejemplo siguiente se crea un XmlWriter objeto que escribe en un archivo XML y escribe cada atributo en una nueva línea.

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 la siguiente salida:

<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. El Create método usa la XmlWriterSettings clase para especificar qué características implementar en el XmlWriter objeto que se crea.

Nota

Si usa el XmlWriter objeto con el Transform método , debe usar la OutputSettings propiedad para obtener un XmlWriterSettings objeto con la configuración correcta. Con ello se garantiza que el objeto XmlWriter creado tenga la configuración de resultados correcta.

La XmlWriterSettings clase proporciona propiedades que controlan la conformidad de los datos y el formato de salida.

Para las comprobaciones de conformidad de datos y las correcciones automáticas, use estas propiedades:

Propiedad.	Especifica	Value	Valor predeterminado
CheckCharacters	Si se debe comprobar que los caracteres están en el juego de caracteres XML legal, tal y como se define en W3C.	true o false	true
ConformanceLevel	Si se debe comprobar que la salida es un documento o fragmento XML 1.0 bien formado.	ConformanceLevel.Document (nivel de documento), Fragment (nivel de fragmento) o Auto (detección automática)	ConformanceLevel.Document (conformidad de nivel de documento)
WriteEndDocumentOnClose	Si se van a agregar etiquetas de cierre a todos los elementos no cerrados cuando se llama al Close método .	true o false	true

Para especificar el formato de salida, use estas propiedades:

Propiedad.	Especifica	Value	Valor predeterminado
Encoding	Codificación de texto que se va a usar.	Valor de System.Text.Encoding	Encoding.UTF8
Indent	Si se van a sangr elementos	true o false	false (sin sangría)
IndentChars	Cadena de caracteres que se va a usar al aplicar sangría (se usa cuando Indent se establece trueen ).	String	Dos espacios
NewLineChars	Cadena de caracteres que se va a usar para saltos de línea.	String	\r\n (retorno de carro, avance de línea)
NewLineHandling	Cómo controlar los caracteres de nueva línea.	System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace) o None (leave unchanged)	Replace (reemplace por caracteres especificados por NewLineChars)
NewLineOnAttributes	Si se van a escribir atributos en líneas individuales (no tiene ningún efecto cuando Indent es false).	true o false	false
OmitXmlDeclaration	Si se va a escribir una declaración XML.	true o false	false

Constructores

XmlWriterSettings()

Inicializa una nueva instancia de la clase XmlWriterSettings.

Propiedades

Async	Obtiene o establece un valor que indica si los métodos asincrónicos XmlWriter se pueden utilizar en una instancia determinada de XmlWriter.
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.
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().
ConformanceLevel	Obtiene o establece el nivel de conformidad que el sistema de escritura XML comprueba para la salida XML.
DoNotEscapeUriAttributes	Obtiene o establece un valor que indica si XmlWriter no realiza escape de los atributos de URI.
Encoding	Obtiene o establece el tipo de codificación de texto que se va a usar.
Indent	Obtiene o establece un valor que indica si se va a aplicar sangría a los elementos.
IndentChars	Obtiene o establece la cadena de caracteres que se va a usar al aplicar sangría. Esta opción se utiliza cuando la propiedad Indent se establece en true.
NamespaceHandling	Obtiene o establece un valor que indica si XmlWriter debe quitar declaraciones de espacio de nombres duplicadas al escribir contenido XML. 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.
NewLineChars	Obtiene o establece la cadena de caracteres que se va a usar para los saltos de línea.
NewLineHandling	Obtiene o establece un valor que indica si se deben normalizar los saltos de línea en el resultado.
NewLineOnAttributes	Obtiene o establece un valor que indica si los atributos se deben escribir en una nueva línea.
OmitXmlDeclaration	Obtiene o establece un valor que indica si debe omitir una declaración XML.
OutputMethod	Obtiene el método utilizado para serializar el resultado de XmlWriter.
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().

Métodos

Clone()	Crea una copia de la instancia de la clase XmlWriterSettings.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
Reset()	Restablece los miembros de la clase de configuración a sus valores predeterminados.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)