XmlWriterSettings XmlWriterSettings XmlWriterSettings XmlWriterSettings Class

Definizione

Specifica un set di funzionalità da supportare nell'oggetto XmlWriter creato dal metodo Create.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
Ereditarietà
XmlWriterSettingsXmlWriterSettingsXmlWriterSettingsXmlWriterSettings

Esempi

Nell'esempio seguente viene creato XmlWriter un oggetto che scrive in un file XML e scrive ogni attributo in una nuova riga.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()

L'esempio produce l'output seguente:The sample produces the following output:

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

Commenti

Il Create metodo è il meccanismo preferito per ottenere XmlWriter le istanze.The Create method is the preferred mechanism for obtaining XmlWriter instances. Il Create metodo usa la XmlWriterSettings classe per specificare le XmlWriter funzionalità da implementare nell'oggetto creato.The Create method uses the XmlWriterSettings class to specify which features to implement in the XmlWriter object that is created.

Nota

XmlWriter Se si usa l'oggetto con il Transform metodo, è necessario usare la OutputSettings proprietà per ottenere un XmlWriterSettings oggetto con le impostazioni corrette.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. In questo modo viene assicurato che le impostazioni di output dell'oggetto XmlWriter creato siano corrette.This ensures that the created XmlWriter object has the correct output settings.

La XmlWriterSettings classe fornisce le proprietà che controllano la conformità dei dati e il formato di output.The XmlWriterSettings class provides properties that control data conformance and output format.

Per i controlli di conformità dei dati e la correzione automatica, usare le proprietà seguenti:For data conformance checks and auto-corrections, use these properties:

ProprietàProperty SpecificaSpecifies ValueValue Impostazione predefinitaDefault
CheckCharacters Indica se verificare che i caratteri siano inclusi nel set di caratteri XML valido, come definito da W3C.Whether to check that characters are in the legal XML character set, as defined by W3C. true o falsetrue or false true
ConformanceLevel Indica se verificare che l'output sia un documento o un frammento XML 1,0 ben formato.Whether to check that output is a well-formed XML 1.0 document or fragment. ConformanceLevel.Document(a livello di documento) Fragment , (a livello di frammento Auto ) o (rilevamento automatico)ConformanceLevel.Document (document-level), Fragment (fragment-level), or Auto (auto-detection) ConformanceLevel.Document(conformità a livello di documento)ConformanceLevel.Document (document-level conformance)
WriteEndDocumentOnClose Indica se aggiungere tag di chiusura a tutti gli elementi non chiusi quando Close viene chiamato il metodo.Whether to add closing tags to all unclosed elements when the Close method is called. true o falsetrue or false true

Per specificare il formato di output, usare le proprietà seguenti:To specify output format, use these properties:

ProprietàProperty SpecificaSpecifies ValueValue Impostazione predefinitaDefault
Encoding Codifica del testo da usare.Text encoding to use. Valore di System.Text.EncodingSystem.Text.Encoding value Encoding.UTF8
Indent Indica se rientrare elementiWhether to indent elements true o falsetrue or false false(nessun rientro)false (no indentation)
IndentChars Stringa di caratteri da utilizzare per il rientro ( Indent utilizzato quando è trueimpostato su).Character string to use when indenting (used when Indent is set to true). StringaString Due spaziTwo spaces
NewLineChars Stringa di caratteri da utilizzare per le interruzioni di riga.Character string to use for line breaks. StringaString \r\n(ritorno a capo, avanzamento riga)\r\n (carriage return, line feed)
NewLineHandling Come gestire i caratteri di nuova riga.How to handle newline characters. System.Xml.NewLineHandlingvalore: Entitize (Normalize), Replace (Replace) o None (lasciare invariato)System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace), or None (leave unchanged) Replace(Sostituisci con i caratteri NewLineCharsspecificati da)Replace (replace with characters specified by NewLineChars)
NewLineOnAttributes Indica se scrivere gli attributi su singole righe (non produce alcun Indent effetto falsequando è).Whether to write attributes on individual lines (has no effect when Indent is false). true o falsetrue or false false
OmitXmlDeclaration Indica se scrivere una dichiarazione XML.Whether to write an XML declaration. true o falsetrue or false false

Costruttori

XmlWriterSettings() XmlWriterSettings() XmlWriterSettings() XmlWriterSettings()

Inizializza una nuova istanza della classe XmlWriterSettings.Initializes a new instance of the XmlWriterSettings class.

Proprietà

Async Async Async Async

Ottiene o imposta un valore che indica se è possibile usare i metodi XmlWriter asincroni in una specifica istanza di XmlWriter.Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

CheckCharacters CheckCharacters CheckCharacters 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.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 CloseOutput CloseOutput 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().Gets or sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the Close() method is called.

ConformanceLevel ConformanceLevel ConformanceLevel ConformanceLevel

Ottiene o imposta il livello di conformità per cui il writer XML controlla l'output XML.Gets or sets the level of conformance that the XML writer checks the XML output for.

DoNotEscapeUriAttributes DoNotEscapeUriAttributes DoNotEscapeUriAttributes DoNotEscapeUriAttributes

Ottiene o imposta un valore che indica se l'elemento XmlWriter non imposta come escape gli attributi URI.Gets or sets a value that indicates whether the XmlWriter does not escape URI attributes.

Encoding Encoding Encoding Encoding

Ottiene o imposta il tipo di codifica testo da utilizzare.Gets or sets the type of text encoding to use.

Indent Indent Indent Indent

Ottiene o imposta un valore che indica se impostare il rientro di elementi.Gets or sets a value indicating whether to indent elements.

IndentChars IndentChars IndentChars IndentChars

Ottiene o imposta la stringa di caratteri da utilizzare per il rientro.Gets or sets the character string to use when indenting. Questa impostazione viene usata quando la proprietà Indent è impostata su true.This setting is used when the Indent property is set to true.

NamespaceHandling NamespaceHandling NamespaceHandling 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.Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. Il comportamento predefinito del writer è restituire tutte le dichiarazioni dello spazio dei nomi presenti nel resolver dello spazio dei nomi del writer.The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.

NewLineChars NewLineChars NewLineChars NewLineChars

Ottiene o imposta la stringa di caratteri da utilizzare per le interruzioni di riga.Gets or sets the character string to use for line breaks.

NewLineHandling NewLineHandling NewLineHandling NewLineHandling

Ottiene o imposta un valore che indica se le interruzioni di riga devono essere normalizzate nell'output.Gets or sets a value indicating whether to normalize line breaks in the output.

NewLineOnAttributes NewLineOnAttributes NewLineOnAttributes NewLineOnAttributes

Ottiene o imposta un valore che indica se scrivere gli attributi su una nuova riga.Gets or sets a value indicating whether to write attributes on a new line.

OmitXmlDeclaration OmitXmlDeclaration OmitXmlDeclaration OmitXmlDeclaration

Ottiene o imposta un valore che indica se omettere una dichiarazione XML.Gets or sets a value indicating whether to omit an XML declaration.

OutputMethod OutputMethod OutputMethod OutputMethod

Ottiene il metodo usato per serializzare l'output XmlWriter.Gets the method used to serialize the XmlWriter output.

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

Metodi

Clone() Clone() Clone() Clone()

Crea una copia dell'istanza XmlWriterSettings.Creates a copy of the XmlWriterSettings instance.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Funge da funzione hash predefinita.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Inherited from Object)
Reset() Reset() Reset() Reset()

Ripristina i valori predefiniti dei membri della classe delle impostazioni.Resets the members of the settings class to their default values.

ToString() ToString() ToString() ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Si applica a