XmlWriterSettings Třída

Definice

Určuje sadu funkcí pro podporu XmlWriter objektu vytvořeného Create metodou.Specifies a set of features to support on the XmlWriter object created by the Create method.

public ref class XmlWriterSettings sealed
public sealed class XmlWriterSettings
type XmlWriterSettings = class
Public NotInheritable Class XmlWriterSettings
Dědičnost
XmlWriterSettings

Příklady

Následující příklad vytvoří XmlWriter zápis do souboru XML a zapíše každý atribut na nový řádek.The following example creates an XmlWriter that writes to an XML file and writes each attribute on a new line.

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 generuje následující výstup:The sample produces the following output:

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

Poznámky

CreateMetoda je upřednostňovaným mechanismem pro získání XmlWriter instancí.The Create method is the preferred mechanism for obtaining XmlWriter instances. CreateMetoda používá XmlWriterSettings třídu k určení, které funkce mají být implementovány v XmlWriter objektu, který je vytvořen.The Create method uses the XmlWriterSettings class to specify which features to implement in the XmlWriter object that is created.

Poznámka

Pokud používáte XmlWriter objekt s Transform metodou, měli byste použít OutputSettings vlastnost k získání XmlWriterSettings objektu se správnými nastaveními.If you're using the XmlWriter object with the Transform method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. Tím se zajistí, že XmlWriter má vytvořený objekt správné výstupní nastavení.This ensures that the created XmlWriter object has the correct output settings.

XmlWriterSettingsTřída poskytuje vlastnosti, které řídí soulad s daty a formát výstupu.The XmlWriterSettings class provides properties that control data conformance and output format.

Pro kontroly shody dat a automatické opravy použijte tyto vlastnosti:For data conformance checks and auto-corrections, use these properties:

VlastnostProperty UrčujeSpecifies HodnotaValue VýchozíDefault
CheckCharacters Určuje, zda mají být v platné znakové sadě XML zkontrolovány znaky definované W3C.Whether to check that characters are in the legal XML character set, as defined by W3C. true nebo falsetrue or false true
ConformanceLevel Určuje, zda je výstupem správný dokument XML 1,0 nebo fragment.Whether to check that output is a well-formed XML 1.0 document or fragment. ConformanceLevel.Document (na úrovni dokumentu), Fragment (na úrovni fragmentu) nebo Auto (automatické zjišťování)ConformanceLevel.Document (document-level), Fragment (fragment-level), or Auto (auto-detection) ConformanceLevel.Document (shoda na úrovni dokumentu)ConformanceLevel.Document (document-level conformance)
WriteEndDocumentOnClose Určuje, zda mají být při volání metody do všech neuzavřených elementů přidány uzavírací značky Close .Whether to add closing tags to all unclosed elements when the Close method is called. true nebo falsetrue or false true

Chcete-li určit výstupní formát, použijte tyto vlastnosti:To specify output format, use these properties:

VlastnostProperty UrčujeSpecifies HodnotaValue VýchozíDefault
Encoding Kódování textu, které se má použít.Text encoding to use. System.Text.Encoding osaSystem.Text.Encoding value Encoding.UTF8
Indent Zda mají být prvky odsazenyWhether to indent elements true nebo falsetrue or false false (bez odsazení)false (no indentation)
IndentChars Řetězec znaků, který má být použit při odsazení (použito Indent , pokud je nastaveno na hodnotu true ).Character string to use when indenting (used when Indent is set to true). ŘetězecString Dva prostoryTwo spaces
NewLineChars Řetězec znaků, který se má použít pro konce řádků.Character string to use for line breaks. ŘetězecString \r\n (návrat z konce řádku, kanál čáry)\r\n (carriage return, line feed)
NewLineHandling Jak zpracovat znaky nového řádku.How to handle newline characters. System.Xml.NewLineHandling hodnota: Entitize (Normalize), Replace (nahradit), nebo None (ponechat beze změny)System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace), or None (leave unchanged) Replace (nahradit znaky určenými parametrem NewLineChars )Replace (replace with characters specified by NewLineChars)
NewLineOnAttributes Zda mají být zapsány atributy na jednotlivých řádcích (nemá žádný vliv Indent , pokud je false ).Whether to write attributes on individual lines (has no effect when Indent is false). true nebo falsetrue or false false
OmitXmlDeclaration Určuje, zda se má zapsat deklarace XML.Whether to write an XML declaration. true nebo falsetrue or false false

Konstruktory

XmlWriterSettings()

Inicializuje novou instanci XmlWriterSettings třídy.Initializes a new instance of the XmlWriterSettings class.

Vlastnosti

Async

Získává nebo nastavuje hodnotu, která indikuje, jestli XmlWriter se můžou na konkrétní instanci používat asynchronní metody XmlWriter .Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

CheckCharacters

Získává nebo nastavuje hodnotu, která indikuje, jestli se má zapisovač XML zkontrolovat, aby všechny znaky v dokumentu odpovídaly oddílu "2,2 znaků" v doporučení W3C XML 1,0.Gets or sets a value that indicates whether the XML writer should check to ensure that all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.

CloseOutput

Získává nebo nastavuje hodnotu, která označuje, jestli se XmlWriter má taky zavřít podkladový datový proud nebo TextWriter když se Close() Metoda zavolá.Gets or sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the Close() method is called.

ConformanceLevel

Získá nebo nastaví úroveň shody, kterou Zapisovací modul XML kontroluje výstup XML pro.Gets or sets the level of conformance that the XML writer checks the XML output for.

DoNotEscapeUriAttributes

Získává nebo nastavuje hodnotu, která indikuje, jestli XmlWriter nejsou řídící atributy identifikátoru URI.Gets or sets a value that indicates whether the XmlWriter does not escape URI attributes.

Encoding

Získá nebo nastaví typ kódování textu, které se má použít.Gets or sets the type of text encoding to use.

Indent

Získá nebo nastaví hodnotu označující, zda se mají prvky odsazovat.Gets or sets a value indicating whether to indent elements.

IndentChars

Získá nebo nastaví řetězec znaků, který má být použit při odsazení.Gets or sets the character string to use when indenting. Toto nastavení se používá, pokud Indent je vlastnost nastavena na hodnotu true .This setting is used when the Indent property is set to true.

NamespaceHandling

Získává nebo nastavuje hodnotu, která indikuje, jestli má XmlWriter při psaní obsahu XML odebrat duplicitní deklarace oborů názvů.Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. Výchozím chováním pro zapisovač je výstup všech deklarací oboru názvů, které jsou k dispozici v překladači oboru názvů zapisovače.The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.

NewLineChars

Získá nebo nastaví řetězec znaků, který se má použít pro konce řádků.Gets or sets the character string to use for line breaks.

NewLineHandling

Získává nebo nastavuje hodnotu, která označuje, jestli se mají ve výstupu normalizovat konce řádků.Gets or sets a value indicating whether to normalize line breaks in the output.

NewLineOnAttributes

Získává nebo nastavuje hodnotu, která označuje, jestli se mají zapisovat atributy na nový řádek.Gets or sets a value indicating whether to write attributes on a new line.

OmitXmlDeclaration

Získává nebo nastavuje hodnotu, která označuje, jestli se má vynechat deklarace XML.Gets or sets a value indicating whether to omit an XML declaration.

OutputMethod

Získá metodu použitou k serializaci XmlWriter výstupu.Gets the method used to serialize the XmlWriter output.

WriteEndDocumentOnClose

Získává nebo nastavuje hodnotu, která označuje, jestli se XmlWriter při volání metody budou do všech neuzavřených značek elementu přidávat uzavírací značky Close() .Gets or sets a value that indicates whether the XmlWriter will add closing tags to all unclosed element tags when the Close() method is called.

Metody

Clone()

Vytvoří kopii XmlWriterSettings instance.Creates a copy of the XmlWriterSettings instance.

Equals(Object)

Určí, zda se zadaný objekt rovná aktuálnímu objektu.Determines whether the specified object is equal to the current object.

(Zděděno od Object)
GetHashCode()

Slouží jako výchozí funkce hash.Serves as the default hash function.

(Zděděno od Object)
GetType()

Získá Type aktuální instanci.Gets the Type of the current instance.

(Zděděno od Object)
MemberwiseClone()

Vytvoří kopii aktuálního seznamu Object .Creates a shallow copy of the current Object.

(Zděděno od Object)
Reset()

Obnoví výchozí hodnoty členů třídy Settings.Resets the members of the settings class to their default values.

ToString()

Vrátí řetězec, který představuje aktuální objekt.Returns a string that represents the current object.

(Zděděno od Object)

Platí pro