XmlWriterSettings Třída

Definice

Obor názvů:

System.Xml

Sestavení:

System.Xml.ReaderWriter.dll

Sestavení:

System.Xml.dll

Sestavení:

netstandard.dll

Určuje sadu funkcí pro podporu objektu XmlWriter vytvořeného metodou Create .

public ref class XmlWriterSettings sealed

public sealed class XmlWriterSettings

type XmlWriterSettings = class

Public NotInheritable Class XmlWriterSettings

Dědičnost

Object

XmlWriterSettings

Příklady

Následující příklad vytvoří objekt XmlWriter , který zapíše do souboru XML a zapíše každý atribut na nový řádek.

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

Ukázka vytvoří následující výstup:

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

Poznámky

Metoda Create je upřednostňovaným mechanismem pro získání XmlWriter instancí. Metoda Create používá XmlWriterSettings třídu k určení, které funkce se mají implementovat v objektu XmlWriter , který je vytvořen.

Poznámka

Pokud používáte XmlWriter objekt s metodou Transform , měli byste použít OutputSettings vlastnost k získání objektu XmlWriterSettings se správným nastavením. Tím se zajistí, že vytvořený XmlWriter objekt má správné nastavení výstupu.

Třída XmlWriterSettings poskytuje vlastnosti, které řídí shodu dat a výstupní formát.

Pro kontroly shody dat a automatické opravy použijte tyto vlastnosti:

Vlastnost	Určuje	Hodnota	Výchozí
CheckCharacters	Zda se má zkontrolovat, zda jsou znaky v sadě znaků XML podle definice W3C.	true nebo false	true
ConformanceLevel	Zda se má zkontrolovat, že výstupem je dokument XML 1.0 ve správném formátu nebo fragment.	ConformanceLevel.Document (na úrovni dokumentu), Fragment (na úrovni fragmentu) nebo Auto (automatická detekce)	ConformanceLevel.Document (shoda na úrovni dokumentu)
WriteEndDocumentOnClose	Zda přidat koncové značky do všech neuzavřených elementů při zavolání Close metody.	true nebo false	true

Pokud chcete zadat výstupní formát, použijte tyto vlastnosti:

Vlastnost	Určuje	Hodnota	Výchozí
Encoding	Kódování textu, které se má použít.	System.Text.Encoding Hodnotu	Encoding.UTF8
Indent	Jestli se odsadí prvky	true nebo false	false (bez odsazení)
IndentChars	Řetězec znaků, který se má použít při odsazení (používá se při Indent nastavení na true).	Řetězec	Dvě mezery
NewLineChars	Řetězec znaků, který se má použít pro konce řádků.	Řetězec	\r\n (návratový řádek, podávání řádků)
NewLineHandling	Jak zpracovávat znaky nového řádku	System.Xml.NewLineHandling hodnota: Entitize (normalizovat), Replace (nahradit) nebo None (ponechat beze změny)	Replace (nahraďte znaky zadanými znakem NewLineChars)
NewLineOnAttributes	Zda se mají zapsat atributy na jednotlivé řádky (nemá žádný vliv, pokud Indent je false).	true nebo false	false
OmitXmlDeclaration	Zda se má napsat deklarace XML.	true nebo false	false

Konstruktory

XmlWriterSettings()

Inicializuje novou instanci XmlWriterSettings třídy.

Vlastnosti

Async	Získá nebo nastaví hodnotu, která označuje, zda asynchronní XmlWriter metody lze použít v konkrétní XmlWriter instanci.
CheckCharacters	Získá nebo nastaví hodnotu, která označuje, zda zapisovač XML by měl zkontrolovat, aby se zajistilo, že všechny znaky v dokumentu odpovídají "2.2 znaků" V doporučení W3C XML 1.0.
CloseOutput	Získá nebo nastaví hodnotu označující, zda XmlWriter by měl také zavřít podkladový datový proud nebo TextWriter kdy Close() je volána metoda.
ConformanceLevel	Získá nebo nastaví úroveň shody xml zapisovač kontroluje výstup XML.
DoNotEscapeUriAttributes	Získá nebo nastaví hodnotu, která označuje, zda XmlWriter neukazuje atributy URI.
Encoding	Získá nebo nastaví typ kódování textu, který se má použít.
Indent	Získá nebo nastaví hodnotu označující, zda odsadit prvky.
IndentChars	Získá nebo nastaví řetězec znaku použít při odsazení. Toto nastavení se použije, když je vlastnost nastavená Indent na truehodnotu .
NamespaceHandling	Získá nebo nastaví hodnotu, která určuje, zda XmlWriter by měl odebrat duplicitní deklarace oboru názvů při psaní obsahu XML. Výchozí chování je pro zapisovač, aby výstup všech deklarací oboru názvů, které jsou přítomné v překladače oboru názvů zapisovače.
NewLineChars	Získá nebo nastaví řetězec znaku pro použití pro konce řádků.
NewLineHandling	Získá nebo nastaví hodnotu označující, zda se mají normalizovat konce řádků ve výstupu.
NewLineOnAttributes	Získá nebo nastaví hodnotu označující, zda zapisovat atributy na nový řádek.
OmitXmlDeclaration	Získá nebo nastaví hodnotu označující, zda se má vynechat deklarace XML.
OutputMethod	Získá metodu použitou k serializaci výstupu XmlWriter .
WriteEndDocumentOnClose	Získá nebo nastaví hodnotu, která označuje, zda XmlWriter bude přidávat uzavírací značky do všech neuzavřených značek elementů Close() při zavolání metody.

Metody

Clone()	Vytvoří kopii XmlWriterSettings instance.
Equals(Object)	Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí hashovací funkce. (Zděděno od Object)
GetType()	Získá aktuální Type instanci. (Zděděno od Object)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
Reset()	Obnoví členy třídy settings na jejich výchozí hodnoty.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)