XmlWriterSettings Classe

Definizione

Spazio dei nomi:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Specifica un set di funzionalità da supportare nell'oggetto XmlWriter creato dal metodo Create.

public ref class XmlWriterSettings sealed

public sealed class XmlWriterSettings

type XmlWriterSettings = class

Public NotInheritable Class XmlWriterSettings

Ereditarietà

Object

XmlWriterSettings

Esempio

Nell'esempio seguente viene creato un oggetto XmlWriter che scrive in un file XML e scrive ogni attributo in una nuova riga.

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

L'esempio produce l'output seguente:

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

Commenti

Il Create metodo è il meccanismo preferito per ottenere XmlWriter le istanze. Il Create metodo usa la XmlWriterSettings classe per specificare le funzionalità da implementare nell'oggetto XmlWriter creato.

Nota

Se si usa l'oggetto XmlWriter con il Transform metodo , è necessario usare la OutputSettings proprietà per ottenere un XmlWriterSettings oggetto con le impostazioni corrette. In questo modo viene assicurato che le impostazioni di output dell'oggetto XmlWriter creato siano corrette.

La XmlWriterSettings classe fornisce proprietà che controllano la conformità dei dati e il formato di output.

Per i controlli di conformità dei dati e le correzioni automatiche, usare queste proprietà:

Proprietà	Specifica	Valore	Predefinito
CheckCharacters	Indica se verificare che i caratteri si trovino nel set di caratteri XML legali, come definito da W3C.	true o false	true
ConformanceLevel	Se verificare che l'output sia un documento o un frammento XML 1.0 ben formato.	ConformanceLevel.Document (a livello di documento), Fragment (a livello di frammento) o Auto (rilevamento automatico)	ConformanceLevel.Document (conformità a livello di documento)
WriteEndDocumentOnClose	Indica se aggiungere tag di chiusura a tutti gli elementi non chiusi quando viene chiamato il Close metodo .	true o false	true

Per specificare il formato di output, usare queste proprietà:

Proprietà	Specifica	Valore	Predefinito
Encoding	Codifica del testo da usare.	Valore della proprietà System.Text.Encoding	Encoding.UTF8
Indent	Indica se impostare un rientro degli elementi	true o false	false (nessun rientro)
IndentChars	Stringa di caratteri da usare quando si imposta il rientro (usato quando Indent è impostato su true).	string	Due spazi
NewLineChars	Stringa di caratteri da utilizzare per le interruzioni di riga.	string	\r\n (ritorno a capo, avanzamento riga)
NewLineHandling	Come gestire i caratteri di nuova riga.	System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace) o None (lasciare invariato)	Replace (sostituire con i caratteri specificati da NewLineChars)
NewLineOnAttributes	Indica se scrivere attributi su singole righe (non ha alcun effetto quando Indent è false).	true o false	false
OmitXmlDeclaration	Indica se scrivere una dichiarazione XML.	true o false	false

Costruttori

XmlWriterSettings()

Inizializza una nuova istanza della classe XmlWriterSettings.

Proprietà

Async	Ottiene o imposta un valore che indica se è possibile usare i metodi XmlWriter asincroni in una specifica istanza di XmlWriter.
CheckCharacters	Ottiene o imposta un valore che indica se il writer XML deve verificare la conformità di tutti i caratteri nel documento alla sezione "2.2 Characters" di XML 1.0 Recommendation di W3C.
CloseOutput	Ottiene o imposta un valore che indica se l'elemento XmlWriter deve chiudere anche il flusso sottostante o l'elemento TextWriter quando viene chiamato il metodo Close().
ConformanceLevel	Ottiene o imposta il livello di conformità per cui il writer XML controlla l'output XML.
DoNotEscapeUriAttributes	Ottiene o imposta un valore che indica se l'elemento XmlWriter non imposta come escape gli attributi URI.
Encoding	Ottiene o imposta il tipo di codifica testo da usare.
Indent	Ottiene o imposta un valore che indica se impostare il rientro di elementi.
IndentChars	Ottiene o imposta la stringa di caratteri da usare per il rientro. Questa impostazione viene usata quando la proprietà Indent è impostata su true.
NamespaceHandling	Ottiene o imposta un valore che indica se l'elemento XmlWriter deve rimuovere le dichiarazioni dello spazio dei nomi duplicate quando viene scritto contenuto XML. Il comportamento predefinito del writer è restituire tutte le dichiarazioni dello spazio dei nomi presenti nel resolver dello spazio dei nomi del writer.
NewLineChars	Ottiene o imposta la stringa di caratteri da usare per le interruzioni di riga.
NewLineHandling	Ottiene o imposta un valore che indica se le interruzioni di riga devono essere normalizzate nell'output.
NewLineOnAttributes	Ottiene o imposta un valore che indica se scrivere gli attributi su una nuova riga.
OmitXmlDeclaration	Ottiene o imposta un valore che indica se omettere una dichiarazione XML.
OutputMethod	Ottiene il metodo usato per serializzare l'output XmlWriter.
WriteEndDocumentOnClose	Ottiene o imposta un valore che indica se l'elemento XmlWriter aggiungerà tag di chiusura a tutti i tag di elemento senza chiusura quando viene chiamato il metodo Close().

Metodi

Clone()	Crea una copia dell'istanza di XmlWriterSettings.
Equals(Object)	Determina se l'oggetto specificato è uguale all'oggetto corrente. (Ereditato da Object)
GetHashCode()	Funge da funzione hash predefinita. (Ereditato da Object)
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
Reset()	Ripristina i valori predefiniti dei membri della classe delle impostazioni.
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)