XmlWriterSettings Třída

Definice

Obor názvů:

System.Xml

Sestavení:

netstandard.dll, System.Xml.ReaderWriter.dll

Zdroj:

XmlWriterSettings.cs

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ří, 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 implementovat v objektu XmlWriter , který je vytvořen.

Poznámka:

Pokud objekt používáte XmlWriter s metodou Transform , měli byste použít OutputSettings vlastnost k získání objektu XmlWriterSettings se správným nastavením. Tím zajistíte, ž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:

Vlastnictví	Specifikuje	Hodnota	Výchozí
CheckCharacters	Zda kontrolovat, zda jsou znaky v právní znakové sadě XML definované W3C.	true nebo false	true
ConformanceLevel	Zda chcete zkontrolovat, zda je výstup správně formátovaný dokument XML 1.0 nebo fragment.	ConformanceLevel.Document (úroveň dokumentu), Fragment (úroveň fragmentu) nebo Auto (automatické zjišťování)	ConformanceLevel.Document (shoda na úrovni dokumentu)
WriteEndDocumentOnClose	Zda přidat koncové značky ke všem nezařazeným prvkům při Close zavolání metody.	true nebo false	true

K určení výstupního formátu použijte tyto vlastnosti:

Vlastnictví	Specifikuje	Hodnota	Výchozí
Encoding	Kódování textu, které se má použít.	System.Text.Encoding hodnota	Encoding.UTF8
Indent	Zda se mají odsadit prvky	true nebo false	false (bez odsazení)
IndentChars	Řetězec znaků, který se má použít při odsazení (používá se, pokud Indent je nastaven na true).	String	Dvě mezery
NewLineChars	Znakový řetězec, který se má použít pro konce řádků.	String	\r\n (návrat na začátek řádku, odřádkování) pro platformy bez unixu nebo \n (podávání čar) pro platformy Unix
NewLineHandling	Jak zpracovat znaky nového řádku	System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace) nebo None (ponechejte beze změny)	Replace (nahraďte znaky určenými znakem NewLineChars)
NewLineOnAttributes	Zda psát atributy na jednotlivých řádcích (nemá žádný vliv, pokud Indent je false).	true nebo false	false
OmitXmlDeclaration	Zda se má zapsat deklarace XML.	true nebo false	false

Konstruktory

Name	Description
XmlWriterSettings()	Inicializuje novou instanci XmlWriterSettings třídy.

Vlastnosti

Name	Description
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á určuje, zda zapisovač XML má zkontrolovat, zda všechny znaky v dokumentu odpovídají oddílu "2,2 Znaků" v doporučení W3C XML 1.0.
CloseOutput	Získá nebo nastaví hodnotu určující, zda XmlWriter má také zavřít základní datový proud nebo TextWriter když Close() je volána metoda.
ConformanceLevel	Získá nebo nastaví úroveň shody, kterou zapisovač XML zkontroluje výstup XML pro.
DoNotEscapeUriAttributes	Získá nebo nastaví hodnotu, která označuje, zda XmlWriter neukazuje atributy identifikátoru 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 se mají odsadit prvky.
IndentChars	Získá nebo nastaví řetězec znaků, který se má použít při odsazení. Toto nastavení se používá, když Indent je vlastnost nastavena na true.
NamespaceHandling	Získá nebo nastaví hodnotu, která určuje, zda XmlWriter má odebrat duplicitní deklarace oboru názvů při zápisu obsahu XML. Výchozí chování je pro zapisovače výstup všech deklarací oboru názvů, které jsou přítomné v překladač oboru názvů zapisovače.
NewLineChars	Získá nebo nastaví znakový řetězec, který se má použít pro konce řádků.
NewLineHandling	Získá nebo nastaví hodnotu označující, zda chcete normalizovat konce řádků ve výstupu.
NewLineOnAttributes	Získá nebo nastaví hodnotu určující, zda zapisovat atributy na nový řádek.
OmitXmlDeclaration	Získá nebo nastaví hodnotu určující, zda vynechat deklaraci XML.
OutputMethod	Získá metodu použitou k serializaci výstupu XmlWriter .
WriteEndDocumentOnClose	Získá nebo nastaví hodnotu, která určuje, zda XmlWriter bude přidat koncové značky do všech nezařazených značek elementů při Close() zavolání metody.

Metody

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