XmlWriterSettings.OmitXmlDeclaration Propiedad

Definición

Espacio de nombres:

System.Xml

Ensamblado:

System.Xml.ReaderWriter.dll

Ensamblado:

System.Xml.dll

Ensamblado:

netstandard.dll

Obtiene o establece un valor que indica si debe omitir una declaración XML.

public:
 property bool OmitXmlDeclaration { bool get(); void set(bool value); };

public bool OmitXmlDeclaration { get; set; }

member this.OmitXmlDeclaration : bool with get, set

Public Property OmitXmlDeclaration As Boolean

Valor de propiedad

Boolean

Es true para omitir la declaración XML; en caso contrario, es false. El valor predeterminado es false, se escribe una declaración XML.

Ejemplos

En el ejemplo siguiente se escribe un fragmento XML en una secuencia de memoria.

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");
writer.Flush();
writer.Close();

// Do additional processing on the stream.

Dim settings As XmlWriterSettings = New XmlWriterSettings()
settings.OmitXmlDeclaration = true
settings.ConformanceLevel = ConformanceLevel.Fragment
settings.CloseOutput = false

' Create the XmlWriter object and write some content.
Dim strm as MemoryStream = new MemoryStream()
Dim writer As XmlWriter = XmlWriter.Create(strm, settings)
writer.WriteElementString("orderID", "1-456-ab")
writer.WriteElementString("orderID", "2-36-00a")
writer.Flush()
writer.Close()

' Do additional processing on the stream.

Comentarios

Esta propiedad solo se aplica a XmlWriter instancias que generan contenido de texto; de lo contrario, se omite esta configuración.

Si OmitXmlDeclaration se establece en false, la declaración XML se escribe automáticamente.

La declaración XML siempre se escribe si ConformanceLevel se establece Documenten , incluso si OmitXmlDeclaration se establece en true.

La declaración XML nunca se escribe si ConformanceLevel se establece en Fragment. Puede llamar WriteProcessingInstruction a para escribir explícitamente una declaración XML.