XmlWriterSettings.OmitXmlDeclaration Свойство

Определение

Пространство имен:

System.Xml

Сборка:

System.Xml.ReaderWriter.dll

Исходный код:

XmlWriterSettings.cs

Возвращает или задает значение, определяющее, следует ли опустить 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

Значение свойства

Boolean

Значение true, если необходимо опустить XML-объявление; в противном случае — значение false. Значением по умолчанию является false; XML-объявление записывается.

Примеры

В следующем примере фрагмент XML записывается в поток памяти.

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.

Комментарии

Это свойство применяется только к экземплярам XmlWriter , которые выводили текстовое содержимое; в противном случае этот параметр игнорируется.

Если OmitXmlDeclaration для задано значение false, xml-объявление записывается автоматически.

Объявление XML всегда записывается, если ConformanceLevel имеет значение Document, даже если OmitXmlDeclaration для задано значение true.

Xml-объявление никогда не записывается, если ConformanceLevel для задано значение Fragment. Можно вызвать для WriteProcessingInstruction явной записи XML-объявления.