XmlWriterSettings.OmitXmlDeclaration プロパティ

.NET Framework クラス ライブラリ リファレンス

XmlWriterSettings.OmitXmlDeclaration プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

XML 宣言を書き込むかどうかを示す値を取得または設定します。

名前空間: System.Xml
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Public Property OmitXmlDeclaration As
 Boolean

Visual Basic (使用法)

Dim instance As XmlWriterSettings
Dim value As Boolean

value = instance.OmitXmlDeclaration

instance.OmitXmlDeclaration = value

C#

public bool OmitXmlDeclaration { get;
 set; }

C++

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

J#

/** @property */
public boolean get_OmitXmlDeclaration ()

/** @property */
public void set_OmitXmlDeclaration (boolean
 value)

JScript

public function get OmitXmlDeclaration
 () : boolean

public function set OmitXmlDeclaration
 (value : boolean)

プロパティ値
XML 宣言を省略する場合は true。それ以外の場合は false。既定値は false で、XML 宣言が書き込まれます。

解説

このプロパティは、テキストの内容を出力する、XmlWriter のインスタンスにのみ適用されます。それ以外の場合、この設定は無視されます。

OmitXmlDeclaration が false に設定されている場合は、XML 宣言が自動的に書き込まれます。

OmitXmlDeclaration が false に設定されている場合でも、ConformanceLevel が Document に設定されていると XML 宣言が常に書き込まれます。

ConformanceLevel が Fragment に設定されている場合、XML 宣言は書き込まれません。WriteProcessingInstruction を呼び出すと、XML 宣言を明示的に書き込むことができます。

使用例

XML フラグメントをメモリ ストリームに書き込む例を次に示します。

Visual Basic

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 additonal processing on the stream.

C#

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 additonal processing on the stream.

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
XmlWriterSettings クラス
XmlWriterSettings メンバ
System.Xml 名前空間
その他の技術情報
XML ライタの作成