XmlWriterSettings Clase

Definición

Espacio de nombres:

System.Xml

Ensamblados:

netstandard.dll, System.Xml.ReaderWriter.dll

Source:

XmlWriterSettings.cs

Especifica un conjunto de características que se admitirán en el XmlWriter objeto creado por el Create método .

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. Esto garantiza que el objeto creado XmlWriter tenga la configuración de salida 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	Importancia	Predeterminado
CheckCharacters	Si desea comprobar que los caracteres están en el conjunto de caracteres XML legal, tal 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	Importancia	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 usará al aplicar sangría (se usa cuando se establece trueen Indent ).	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) para plataformas que no son Unix o \n (fuente de líneas) para plataformas Unix
NewLineHandling	Cómo controlar los caracteres de nueva línea.	System.Xml.NewLineHandling value: Entitize (normalizar), Replace (reemplazar) o None (dejar sin cambios)	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

Nombre	Description
XmlWriterSettings()	Inicializa una nueva instancia de la clase XmlWriterSettings.

Propiedades

Nombre	Description
Async	Obtiene o establece un valor que indica si se pueden usar métodos asincrónicos XmlWriter en una instancia determinada XmlWriter .
CheckCharacters	Obtiene o establece un valor que indica si el escritor XML debe comprobar para asegurarse de que todos los caracteres del documento se ajustan a la sección "2.2 Caracteres" de la Recomendación W3C XML 1.0.
CloseOutput	Obtiene o establece un valor que indica si XmlWriter también debe cerrar la secuencia subyacente o TextWriter cuando se llama al Close() método .
ConformanceLevel	Obtiene o establece el nivel de conformidad para el que el escritor XML comprueba la salida XML.
DoNotEscapeUriAttributes	Obtiene o establece un valor que indica si no aplica XmlWriter escape a los atributos 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 van a sangr elementos.
IndentChars	Obtiene o establece la cadena de caracteres que se va a usar al aplicar sangría. Este valor se usa cuando la Indent propiedad se establece trueen .
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 escritor genera todas las declaraciones de espacio de nombres presentes en el solucionador de espacios de nombres del escritor.
NewLineChars	Obtiene o establece la cadena de caracteres que se va a usar para saltos de línea.
NewLineHandling	Obtiene o establece un valor que indica si se normalizan los saltos de línea en la salida.
NewLineOnAttributes	Obtiene o establece un valor que indica si se van a escribir atributos en una nueva línea.
OmitXmlDeclaration	Obtiene o establece un valor que indica si se debe omitir una declaración XML.
OutputMethod	Obtiene el método usado para serializar la XmlWriter salida.
WriteEndDocumentOnClose	Obtiene o establece un valor que indica si XmlWriter agregará etiquetas de cierre a todas las etiquetas de elementos no cerrados cuando se llame al Close() método .

Métodos

Nombre	Description
Clone()	Crea una copia de la XmlWriterSettings instancia.
Equals(Object)	Determina si el objeto especificado es igual al objeto actual. (Heredado de Object)
GetHashCode()	Actúa como función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Objectactual. (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)