XmlWriterSettings 類別

定義

命名空間:

System.Xml

組件:

netstandard.dll, System.Xml.ReaderWriter.dll

來源:

XmlWriterSettings.cs

指定一組功能，以支援由方法建立XmlWriter的Create物件。

public ref class XmlWriterSettings sealed

public sealed class XmlWriterSettings

type XmlWriterSettings = class

Public NotInheritable Class XmlWriterSettings

繼承

Object

XmlWriterSettings

範例

以下範例建立 ， XmlWriter 該 寫入 XML 檔案，並將每個屬性寫入新行。

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()

取樣結果如下：

<order
  orderID="367A54"
  date="2001-05-03">
  <price>19.95</price>
</order>

備註

此 Create 方法是取得 XmlWriter 實例的首選機制。 該 Create 方法使用類別 XmlWriterSettings 來指定要實作哪些功能在 XmlWriter 所建立的物件中。

備註

如果你用 XmlWriter 這個方法來 Transform 取得物件，應該用這個 OutputSettings 屬性來取得 XmlWriterSettings 一個設定正確的物件。 這確保所建立 XmlWriter 的物件擁有正確的輸出設定。

該 XmlWriterSettings 類別提供控制資料一致性與輸出格式的屬性。

對於資料符合性檢查和自動更正，請使用以下特性：

房產	指定	價值	預設值
CheckCharacters	是否要檢查字元是否屬於 W3C 定義的合法 XML 字元集。	true 或 false	true
ConformanceLevel	是否要檢查輸出是格式良好的 XML 1.0 文件或片段。	ConformanceLevel.Document （文件層級）、 Fragment （片段層級）或 Auto （自動偵測）	ConformanceLevel.Document （文件層級符合性）
WriteEndDocumentOnClose	當方法被呼叫時 Close ，是否要為所有未封閉元素加上關閉標籤。	true 或 false	true

要指定輸出格式，請使用以下屬性：

房產	指定	價值	預設值
Encoding	文字編碼的用途。	System.Text.Encoding 值	Encoding.UTF8
Indent	是否要縮排元素	true 或 false	false （無壓痕）
IndentChars	縮排時使用的字串（當 Indent 設定為 true時使用 ）。	繩子	兩個空間
NewLineChars	用於換行的字串。	繩子	\r\n （回車，換行）用於非 Unix 平台，或 \n （換行）用於 Unix 平台
NewLineHandling	如何處理換行字元。	System.Xml.NewLineHandling 值： Entitize （正規化）、 Replace （替換）或 None （保持不變）	Replace （替換為由指定 NewLineChars字元）
NewLineOnAttributes	是否要在單一行上寫屬性（當 Indent 時 false不影響）。	true 或 false	false
OmitXmlDeclaration	是否要撰寫 XML 聲明。	true 或 false	false

建構函式

名稱	Description
XmlWriterSettings()	初始化 XmlWriterSettings 類別的新執行個體。

屬性

名稱	Description
Async	取得或設定一個值，指示是否能在特定XmlWriter實例上使用非同步XmlWriter方法。
CheckCharacters	取得或設定一個值，指示 XML 撰寫者是否應檢查文件中所有字元是否符合 W3C XML 1.0 建議中的「2.2 字元」部分。
CloseOutput	取得或設定一個值，指示是否 XmlWriter 也應該關閉底層串流，或 TextWriter 在呼叫該 Close() 方法時關閉。
ConformanceLevel	取得或設定 XML 撰寫者檢查 XML 輸出的符合性層級。
DoNotEscapeUriAttributes	取得或設定一個值，指示是否 XmlWriter 逃逸 URI 屬性。
Encoding	取得或設定要使用的文字編碼類型。
Indent	取得或設定一個值，指示是否縮排元素。
IndentChars	在縮排時取得或設定字串的使用。 當屬性 Indent 設定 true為 時，此設定會使用。
NamespaceHandling	取得或設定一個值，指示在撰寫 XML 內容時是否 XmlWriter 應該移除重複的命名空間宣告。 預設行為是寫入者會輸出寫入者命名空間解析器中所有的命名空間宣告。
NewLineChars	取得或設定用於換行的字串。
NewLineHandling	取得或設定一個值，指示是否要正規化輸出中的換行。
NewLineOnAttributes	取得或設定一個值，指示是否要在新行上寫入屬性。
OmitXmlDeclaration	取得或設定一個值，指示是否省略 XML 宣告。
OutputMethod	取得用於序列化 XmlWriter 輸出的方法。
WriteEndDocumentOnClose	取得或設定一個值，指示當呼叫該方法時，是否 XmlWriter 會為所有未封閉元素的標籤 Close() 加上封閉標籤。

方法

名稱	Description
Clone()	建立實 XmlWriterSettings 例的副本。
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
GetHashCode()	做為預設哈希函式。 (繼承來源 Object)
GetType()	取得目前實例的 Type。 (繼承來源 Object)
MemberwiseClone()	建立目前 Object的淺層複本。 (繼承來源 Object)
Reset()	將設定類別的成員重置為預設值。
ToString()	傳回表示目前 物件的字串。 (繼承來源 Object)