XmlWriterSettings Classe

Definizione

Spazio dei nomi:

System.Xml

Assembly:

netstandard.dll, System.Xml.ReaderWriter.dll

Origine:

XmlWriterSettings.cs

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

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 istanze. Il Create metodo usa la XmlWriterSettings classe per specificare le funzionalità da implementare nell'oggetto XmlWriter creato.

Annotazioni

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 si garantisce che l'oggetto creato XmlWriter disponga delle impostazioni di output 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	Impostazione predefinita
CheckCharacters	Indica se verificare che i caratteri si trovino nel set di caratteri XML legali, come definito da W3C.	true oppure false	true
ConformanceLevel	Indica 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 chiuso quando viene chiamato il Close metodo .	true oppure false	true

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

Proprietà	Specifica	Valore	Impostazione predefinita
Encoding	Codifica del testo da usare.	Valore della proprietà System.Text.Encoding	Encoding.UTF8
Indent	Indica se rientrare gli elementi	true oppure false	false (nessun rientro)
IndentChars	Stringa di caratteri da usare per il rientro (usato quando Indent è impostato su true).	Stringa	Due spazi
NewLineChars	Stringa di caratteri da utilizzare per le interruzioni di riga.	Stringa	\r\n (ritorno a capo, avanzamento riga) per piattaforme non Unix o \n (avanzamento riga) per le piattaforme Unix
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 oppure false	false
OmitXmlDeclaration	Indica se scrivere una dichiarazione XML.	true oppure false	false

Costruttori

Nome	Descrizione
XmlWriterSettings()	Inizializza una nuova istanza della classe XmlWriterSettings.

Proprietà

Nome	Descrizione
Async	Ottiene o imposta un valore che indica se i metodi asincroni XmlWriter possono essere utilizzati in una determinata XmlWriter istanza.
CheckCharacters	Ottiene o imposta un valore che indica se il writer XML deve verificare che tutti i caratteri del documento siano conformi alla sezione "2.2 Characters" della raccomandazione W3C XML 1.0.
CloseOutput	Ottiene o imposta un valore che indica se XmlWriter deve anche chiudere il flusso sottostante o TextWriter quando viene chiamato il Close() metodo .
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'oggetto non esegue l'escape XmlWriter degli attributi URI.
Encoding	Ottiene o imposta il tipo di codifica del testo da utilizzare.
Indent	Ottiene o imposta un valore che indica se impostare il rientro degli elementi.
IndentChars	Ottiene o imposta la stringa di caratteri da utilizzare per il rientro. Questa impostazione viene utilizzata quando la Indent proprietà è impostata su true.
NamespaceHandling	Ottiene o imposta un valore che indica se l'oggetto deve rimuovere dichiarazioni di spazio dei nomi duplicate durante la XmlWriter scrittura di contenuto XML. Il comportamento predefinito è che il writer restituisca 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 utilizzare per le interruzioni di riga.
NewLineHandling	Ottiene o imposta un valore che indica se normalizzare le interruzioni di riga nell'output.
NewLineOnAttributes	Ottiene o imposta un valore che indica se scrivere attributi in una nuova riga.
OmitXmlDeclaration	Ottiene o imposta un valore che indica se omettere una dichiarazione XML.
OutputMethod	Ottiene il metodo utilizzato per serializzare l'output XmlWriter .
WriteEndDocumentOnClose	Ottiene o imposta un valore che indica se aggiungerà XmlWriter tag di chiusura a tutti i tag di elemento non chiuso quando viene chiamato il Close() metodo .

Metodi

Nome	Descrizione
Clone()	Crea una copia dell'istanza 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 il Type dell'istanza corrente. (Ereditato da Object)
MemberwiseClone()	Crea una copia superficiale del Objectcorrente. (Ereditato da Object)
Reset()	Reimposta i membri della classe delle impostazioni sui relativi valori predefiniti.
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)