XmlWriterSettings Osztály

Definíció

A metódus által létrehozott objektumot támogató XmlWriter funkciók készletét Create adja meg.

public ref class XmlWriterSettings sealed
public sealed class XmlWriterSettings
type XmlWriterSettings = class
Public NotInheritable Class XmlWriterSettings
Öröklődés
XmlWriterSettings

Példák

Az alábbi példa egy XmlWriter XML-fájlba ír, és minden attribútumot egy új sorba ír.

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

A minta a következő kimenetet állítja elő:

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

Megjegyzések

A Create metódus a példányok beszerzésének XmlWriter előnyben részesített mechanizmusa. A Create metódus az XmlWriterSettings osztály használatával határozza meg, hogy mely szolgáltatásokat kell implementálni a XmlWriter létrehozott objektumban.

Note

Ha az XmlWriter objektumot a Transform metódussal használja, a OutputSettings tulajdonság használatával szerezze be XmlWriterSettings a megfelelő beállításokkal rendelkező objektumot. Ez biztosítja, hogy a létrehozott XmlWriter objektum a megfelelő kimeneti beállításokkal rendelkezik.

Az XmlWriterSettings osztály olyan tulajdonságokat biztosít, amelyek szabályozzák az adatmegformálást és a kimeneti formátumot.

Az adatmegfelelőség-ellenőrzésekhez és az automatikus javításokhoz használja az alábbi tulajdonságokat:

Ingatlan Meghatároz Érték Alapértelmezett
CheckCharacters Ellenőrizze, hogy a karakterek a W3C által meghatározott jogi XML-karakterkészletben vannak-e. true vagy false true
ConformanceLevel Ellenőrizze, hogy a kimenet egy jól formázott XML 1.0-dokumentum vagy -töredék-e. ConformanceLevel.Document (dokumentumszintű), Fragment (töredékszintű) vagy Auto (automatikus észlelés) ConformanceLevel.Document (dokumentumszintű megfelelőség)
WriteEndDocumentOnClose Azt határozza meg, hogy a metódus meghívásakor zárócímkéket adjon-e hozzá az Close összes nem szereplő elemhez. true vagy false true

A kimeneti formátum megadásához használja az alábbi tulajdonságokat:

Ingatlan Meghatároz Érték Alapértelmezett
Encoding Használandó szövegkódolás. System.Text.Encoding Érték Encoding.UTF8
Indent Elemek behúzása true vagy false false (nincs behúzás)
IndentChars Behúzáskor használandó karaktersztring (akkor használatos, ha Indent be van állítva true). Lánc Két szóköz
NewLineChars Vonaltörésekhez használandó karaktersztring. Lánc \r\n (kocsivisszaút, vonalcsatorna) nem Unix-platformokhoz, vagy \n Unix-platformokhoz (vonalcsatorna)
NewLineHandling Újvonalas karakterek kezelése. System.Xml.NewLineHandling érték: Entitize (normalizálás), Replace (csere) vagy None (változatlanul hagyva) Replace (cserélje le a következő által megadott karakterekre NewLineChars: )
NewLineOnAttributes Attribútumok írása egyes sorokra (nincs hatása, ha Indent van false). true vagy false false
OmitXmlDeclaration Xml-deklaráció írása. true vagy false false

Konstruktorok

Name Description
XmlWriterSettings()

Inicializálja a XmlWriterSettings osztály új példányát.

Tulajdonságok

Name Description
Async

Lekéri vagy beállít egy értéket, amely jelzi, hogy az aszinkron XmlWriter metódusok használhatók-e egy adott XmlWriter példányon.

CheckCharacters

Lekéri vagy beállít egy értéket, amely jelzi, hogy az XML-írónak ellenőriznie kell-e, hogy a dokumentum összes karaktere megfeleljen-e a W3C XML 1.0-javaslat "2.2 karakter" szakaszának.

CloseOutput

Lekéri vagy beállít egy értéket, amely jelzi, hogy az XmlWriter alapul szolgáló streamet is be kell-e zárnia, vagy TextWriter amikor a Close() metódust meghívják.

ConformanceLevel

Lekéri vagy beállítja az XML-író által az XML-kimenetet ellenőrző megfelelőségi szintet.

DoNotEscapeUriAttributes

Lekéri vagy beállít egy értéket, amely jelzi, hogy az XmlWriter URI-attribútumok nem kerülnek-e ki.

Encoding

Lekéri vagy beállítja a használni kívánt szövegkódolás típusát.

Indent

Lekéri vagy beállítja az elemek behúzását jelző értéket.

IndentChars

Lekéri vagy beállítja a behúzáskor használni kívánt karaktersztringet. Ezt a beállítást akkor használja a rendszer, ha a Indent tulajdonság értéke true.

NamespaceHandling

Lekéri vagy beállít egy értéket, amely jelzi, hogy az XML-tartalom írásakor el kell-e távolítania a XmlWriter névtér-deklarációkat. Az alapértelmezett viselkedés az, hogy az író az író névtérfeloldójában található összes névtérdeklarációt megjeleníti.

NewLineChars

Lekéri vagy beállítja a sortörésekhez használni kívánt karaktersztringet.

NewLineHandling

Lekéri vagy beállít egy értéket, amely jelzi, hogy normalizálja-e a sortöréseket a kimenetben.

NewLineOnAttributes

Lekéri vagy beállít egy értéket, amely jelzi, hogy attribútumokat szeretne-e írni egy új sorban.

OmitXmlDeclaration

Beolvas vagy beállít egy értéket, amely jelzi, hogy kihagy-e egy XML-deklarációt.

OutputMethod

Lekéri a kimenet szerializálásához használt metódust XmlWriter .

WriteEndDocumentOnClose

Lekéri vagy beállítja azt az értéket, amely jelzi, hogy a metódus meghívásakor a XmlWriter program hozzáad-e zárócímkéket az Close() összes nem szereplő elemcímkéhez.

Metódusok

Name Description
Clone()

Létrehozza a példány másolatát XmlWriterSettings .

Equals(Object)

Meghatározza, hogy a megadott objektum egyenlő-e az aktuális objektummal.

(Öröklődés forrása Object)
GetHashCode()

Ez az alapértelmezett kivonatoló függvény.

(Öröklődés forrása Object)
GetType()

Lekéri az Type aktuális példányt.

(Öröklődés forrása Object)
MemberwiseClone()

Az aktuális Objectpéldány sekély másolatát hozza létre.

(Öröklődés forrása Object)
Reset()

Alaphelyzetbe állítja a beállításosztály tagjait az alapértelmezett értékükre.

ToString()

Az aktuális objektumot jelképező sztringet ad vissza.

(Öröklődés forrása Object)

A következőre érvényes: