XmlWriterSettings 類別

定義

命名空間:

System.Xml

組件:

System.Xml.ReaderWriter.dll

組件:

System.Xml.dll

組件:

netstandard.dll

指定要在由 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	是否要檢查字元是否位於合法的 XML 字元集中，如 W3C 所定義。	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	當 縮排 (設定 true 為) 時 Indent ，要使用的字元字串。	String	兩個空格
NewLineChars	要用於分行符號的字元字串。	String	\r\n (歸位字元、換行字元)
NewLineHandling	如何處理分行符號。	System.Xml.NewLineHandling 值： Entitize (正規化) 、 Replace (取代) ，或 None (保持不變)	Replace (以) 指定的 NewLineChars 字元取代
NewLineOnAttributes	當 為) 時 Indent false ，是否要在個別行上寫入屬性 (沒有任何作用。	true 或 false	false
OmitXmlDeclaration	是否要寫入 XML 宣告。	true 或 false	false

建構函式

XmlWriterSettings()

初始化 XmlWriterSettings 類別的新執行個體。

屬性

Async	取得或設定值，指出非同步 XmlWriter 方法是否可以用於特定 XmlWriter 執行個體。
CheckCharacters	取得或設定值，這個值表示 XML 寫入器是否應該檢查以確定文件中的所有字元都符合 W3C XML 1.0 Recommendation 中的 "2.2 Characters" 一節。
CloseOutput	取得或設定值，指出呼叫 XmlWriter 方法時，TextWriter 是否也應該關閉基礎資料流或 Close()。
ConformanceLevel	取得或設定 XML 寫入器檢查 XML 輸出的一致性層級。
DoNotEscapeUriAttributes	取得或設定值，這個值會指出 XmlWriter 是否不會逸出 URI 屬性。
Encoding	取得或設定要使用的文字編碼方式類型。
Indent	取得或設定值，指出是否要縮排項目。
IndentChars	取得或設定縮排時使用的字元字串。 當 Indent 屬性設為 true 時會使用這項設定。
NamespaceHandling	取得或設定值，這個值表示 XmlWriter 是否應該在寫入 XML 內容時移除重複的命名空間宣告。 預設行為是讓寫入器輸出寫入器命名空間解析程式中出現的所有命名空間宣告。
NewLineChars	取得或設定用於分行符號的字元字串。
NewLineHandling	取得或設定值，指出是否要將輸出中的分行符號標準化。
NewLineOnAttributes	取得或設定值，指出是否將屬性寫在新行上。
OmitXmlDeclaration	取得或設定值，指出是否省略 XML 宣告。
OutputMethod	取得用於序列化 XmlWriter 輸出的方法。
WriteEndDocumentOnClose	取得或設定值，指出 XmlWriter 是否會在呼叫 Close() 方法時，將結尾標記加入至所有未封閉的項目標記。

方法

Clone()	建立 XmlWriterSettings 執行個體的複本。
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
GetHashCode()	做為預設雜湊函式。 (繼承來源 Object)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
Reset()	將設定類別的成員重設為其預設值。
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)