XmlWriterSettings Klasa

Definicja

Przestrzeń nazw:

System.Xml

Zestaw:

System.Xml.ReaderWriter.dll

Zestaw:

System.Xml.dll

Zestaw:

netstandard.dll

Określa zestaw funkcji do obsługi obiektu utworzonego XmlWriter przez metodę Create .

public ref class XmlWriterSettings sealed

public sealed class XmlWriterSettings

type XmlWriterSettings = class

Public NotInheritable Class XmlWriterSettings

Dziedziczenie

Object

XmlWriterSettings

Przykłady

Poniższy przykład tworzy obiekt XmlWriter , który zapisuje w pliku XML i zapisuje każdy atrybut w nowym wierszu.

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

Przykład generuje następujące dane wyjściowe:

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

Uwagi

Metoda Create jest preferowanym mechanizmem uzyskiwania XmlWriter wystąpień. Metoda Create używa XmlWriterSettings klasy do określenia, które funkcje mają być implementujące w XmlWriter utworzonym obiekcie.

Uwaga

Jeśli używasz XmlWriter obiektu z Transform metodą , należy użyć OutputSettings właściwości , aby uzyskać XmlWriterSettings obiekt z poprawnymi ustawieniami. Gwarantuje to, że utworzony XmlWriter obiekt ma poprawne ustawienia danych wyjściowych.

Klasa XmlWriterSettings udostępnia właściwości kontrolujące zgodność danych i format danych wyjściowych.

W przypadku kontroli zgodności danych i automatycznych poprawek użyj następujących właściwości:

Właściwość	Określa	Wartość	Domyślny
CheckCharacters	Czy sprawdzić, czy znaki znajdują się w zestawie znaków XML legalnych, zgodnie z definicją W3C.	true lub false	true
ConformanceLevel	Czy sprawdzić, czy dane wyjściowe są dobrze sformułowanym dokumentem XML 1.0, czy fragmentem.	ConformanceLevel.Document (poziom dokumentu), Fragment (poziom fragmentu) lub Auto (automatyczne wykrywanie)	ConformanceLevel.Document (zgodność na poziomie dokumentu)
WriteEndDocumentOnClose	Czy dodać tagi zamykające do wszystkich nieujawnianych elementów po wywołaniu Close metody.	true lub false	true

Aby określić format danych wyjściowych, użyj następujących właściwości:

Właściwość	Określa	Wartość	Domyślny
Encoding	Kodowanie tekstu do użycia.	System.Text.Encoding Wartość	Encoding.UTF8
Indent	Czy wcięć elementy	true lub false	false (bez wcięcia)
IndentChars	Ciąg znaków do użycia podczas wcięcia (używany, gdy Indent jest ustawiony na truewartość ).	Ciąg	Dwie przestrzenie
NewLineChars	Ciąg znaków do użycia w przypadku podziałów wierszy.	Ciąg	\r\n (powrót karetki, kanał liniowy)
NewLineHandling	Jak obsługiwać znaki nowego wiersza.	System.Xml.NewLineHandling wartość: Entitize (normalizuj), Replace (zastąp) lub None (pozostaw bez zmian)	Replace (zastąp znaki określonymi przez NewLineChars)
NewLineOnAttributes	Czy zapisywać atrybuty w poszczególnych wierszach (nie ma wpływu, gdy Indent jest ).false	true lub false	false
OmitXmlDeclaration	Czy napisać deklarację XML.	true lub false	false

Konstruktory

XmlWriterSettings()

Inicjuje nowe wystąpienie klasy XmlWriterSettings.

Właściwości

Async	Pobiera lub ustawia wartość wskazującą, czy metody asynchroniczne XmlWriter mogą być używane w określonym XmlWriter wystąpieniu.
CheckCharacters	Pobiera lub ustawia wartość wskazującą, czy składnik zapisywania XML powinien sprawdzić, czy wszystkie znaki w dokumencie są zgodne z sekcją "2.2 Znaki" zalecenia W3C XML 1.0.
CloseOutput	Pobiera lub ustawia wartość wskazującą, czy XmlWriter obiekt powinien również zamknąć strumień bazowy, czy TextWriter też po wywołaniu Close() metody.
ConformanceLevel	Pobiera lub ustawia poziom zgodności, dla którego moduł zapisywania XML sprawdza dane wyjściowe XML.
DoNotEscapeUriAttributes	Pobiera lub ustawia wartość wskazującą, czy atrybuty identyfikatora XmlWriter URI nie zostaną zmienione.
Encoding	Pobiera lub ustawia typ kodowania tekstu do użycia.
Indent	Pobiera lub ustawia wartość wskazującą, czy należy wcięć elementy.
IndentChars	Pobiera lub ustawia ciąg znaków do użycia podczas wcięcia. To ustawienie jest używane, gdy właściwość jest ustawiona Indent na truewartość .
NamespaceHandling	Pobiera lub ustawia wartość wskazującą, czy XmlWriter podczas zapisywania zawartości XML program powinien usuwać zduplikowane deklaracje przestrzeni nazw. Domyślne zachowanie jest przeznaczone dla modułu zapisywania w celu wyprowadzenia wszystkich deklaracji przestrzeni nazw, które znajdują się w rozpoznawaniu przestrzeni nazw modułu zapisywania.
NewLineChars	Pobiera lub ustawia ciąg znaków do użycia dla podziałów wierszy.
NewLineHandling	Pobiera lub ustawia wartość wskazującą, czy znormalizować podziały wierszy w danych wyjściowych.
NewLineOnAttributes	Pobiera lub ustawia wartość wskazującą, czy należy zapisywać atrybuty w nowym wierszu.
OmitXmlDeclaration	Pobiera lub ustawia wartość wskazującą, czy pominąć deklarację XML.
OutputMethod	Pobiera metodę używaną do serializacji danych wyjściowych XmlWriter .
WriteEndDocumentOnClose	Pobiera lub ustawia wartość wskazującą, czy XmlWriter podczas wywoływanej metody zostaną dodane tagi zamykające do wszystkich tagów Close() nieujawnianych elementów.

Metody

Clone()	Tworzy kopię XmlWriterSettings wystąpienia.
Equals(Object)	Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetType()	Type Pobiera wartość bieżącego wystąpienia. (Odziedziczone po Object)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
Reset()	Resetuje elementy członkowskie klasy ustawień do ich wartości domyślnych.
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)