XmlWriterSettings.OmitXmlDeclaration Propriedade

Definição

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Obtém ou define um valor que indica se uma declaração XML deve ser omitida.

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 da propriedade

Boolean

true para omitir a declaração XML; caso contrário, false. O padrão é false, uma declaração XML é gravada.

Exemplos

O exemplo a seguir grava um fragmento XML em um fluxo de memória.

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.

Comentários

Essa propriedade só se aplica a XmlWriter instâncias que geram conteúdo de texto; caso contrário, essa configuração é ignorada.

Se OmitXmlDeclaration estiver definido como, a falsedeclaração XML será gravada automaticamente

A declaração XML sempre será gravada se ConformanceLevel estiver definida como Document, mesmo que OmitXmlDeclaration esteja definida como true.

A declaração XML nunca será gravada se ConformanceLevel estiver definida como Fragment. Você pode chamar WriteProcessingInstruction para gravar explicitamente uma declaração XML.