XmlWriterSettings Класс

Определение

Задает набор функций, которые должны поддерживаться объектом XmlWriter, создаваемым с помощью метода 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
Наследование
XmlWriterSettings

Примеры

В следующем примере создается объект XmlWriter , который записывает данные в XML-файл и записывает каждый атрибут в новой строке.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()

Образец выдает следующие выходные данные:The sample produces the following output:

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

Комментарии

CreateМетод является предпочтительным механизмом для получения XmlWriter экземпляров.The Create method is the preferred mechanism for obtaining XmlWriter instances. CreateМетод использует класс, XmlWriterSettings чтобы указать, какие функции должны быть реализованы в XmlWriter созданном объекте.The Create method uses the XmlWriterSettings class to specify which features to implement in the XmlWriter object that is created.

Примечание

Если вы используете XmlWriter объект с Transform методом, следует использовать OutputSettings свойство для получения XmlWriterSettings объекта с правильными параметрами.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. Это гарантирует правильность параметров выходных данных для объекта XmlWriter.This ensures that the created XmlWriter object has the correct output settings.

XmlWriterSettingsКласс предоставляет свойства, управляющие форматом соответствия данных и выходного формата.The XmlWriterSettings class provides properties that control data conformance and output format.

Для проверок соответствия данных и автоматического исправления используйте следующие свойства:For data conformance checks and auto-corrections, use these properties:

Свойство.Property Что определяетSpecifies ЗначениеValue По умолчаниюDefault
CheckCharacters Следует ли проверять, что символы находятся в допустимой кодировке XML, как определено консорциумом W3C.Whether to check that characters are in the legal XML character set, as defined by W3C. true или falsetrue or false true
ConformanceLevel Следует ли проверять, что выходные данные представляют собой XML-документ или фрагмент с правильным форматом 1,0.Whether to check that output is a well-formed XML 1.0 document or fragment. ConformanceLevel.Document (уровень документа), Fragment (уровень фрагмента) или Auto (автоматическое обнаружение)ConformanceLevel.Document (document-level), Fragment (fragment-level), or Auto (auto-detection) ConformanceLevel.Document (соответствие уровня документа)ConformanceLevel.Document (document-level conformance)
WriteEndDocumentOnClose Следует ли добавлять закрывающие теги во все незакрытые элементы при Close вызове метода.Whether to add closing tags to all unclosed elements when the Close method is called. true или falsetrue or false true

Чтобы указать формат выходных данных, используйте следующие свойства:To specify output format, use these properties:

Свойство.Property Что определяетSpecifies ЗначениеValue По умолчаниюDefault
Encoding Используемая кодировка текста.Text encoding to use. Значение System.Text.EncodingSystem.Text.Encoding value Encoding.UTF8
Indent Следует ли понизить уровень элементовWhether to indent elements true или falsetrue or false false (без отступов)false (no indentation)
IndentChars Символьная строка, используемая при отступе (используется, если параметр Indent имеет значение true ).Character string to use when indenting (used when Indent is set to true). СтрокаString Два пробелаTwo spaces
NewLineChars Символьная строка, используемая для разрывов строк.Character string to use for line breaks. СтрокаString \r\n (возврат каретки, перевод строки)\r\n (carriage return, line feed)
NewLineHandling Как работать с символами новой строки.How to handle newline characters. System.Xml.NewLineHandling значение: Entitize (нормализация), Replace (заменить) или None (оставьте без изменений)System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace), or None (leave unchanged) Replace (замените символами, указанными в параметре NewLineChars )Replace (replace with characters specified by NewLineChars)
NewLineOnAttributes Следует ли записывать атрибуты в отдельных строках (не оказывает влияния Indent , если имеет значение false ).Whether to write attributes on individual lines (has no effect when Indent is false). true или falsetrue or false false
OmitXmlDeclaration Следует ли записывать объявление XML.Whether to write an XML declaration. true или falsetrue or false false

Конструкторы

XmlWriterSettings()

Инициализирует новый экземпляр класса XmlWriterSettings.Initializes a new instance of the XmlWriterSettings class.

Свойства

Async

Получает или задает значение, указывающее, можно ли использовать асинхронные методы XmlWriter для конкретного экземпляра XmlWriter.Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

CheckCharacters

Возвращает или задает значение, указывающее, должно ли средство записи XML выполнять проверку на предмет того, соответствуют ли все символы в документе разделу "2.2 Characters" документа W3C XML 1.0 Recommendation.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

Возвращает или задает значение, указывающее, следует ли объекту XmlWriter закрывать также и основной поток или TextWriter при вызове метода 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

Возвращает или задает уровень соответствия, на предмет которого средство записи XML проверяет выходные данные XML.Gets or sets the level of conformance that the XML writer checks the XML output for.

DoNotEscapeUriAttributes

Возвращает или задает значение, указывающее, преобразует ли XmlWriter атрибуты URI в escape-последовательности.Gets or sets a value that indicates whether the XmlWriter does not escape URI attributes.

Encoding

Возвращает или задает тип используемой кодировки текста.Gets or sets the type of text encoding to use.

Indent

Возвращает или задает значение, указывающее, следует ли использовать отступ для элементов.Gets or sets a value indicating whether to indent elements.

IndentChars

Возвращает или задает строку символов, используемую для отступов.Gets or sets the character string to use when indenting. Этот параметр используется, если значение свойства Indent равно true.This setting is used when the Indent property is set to true.

NamespaceHandling

Получает или задает значение, указывающие, должен ли объект XmlWriter при записи содержимого XML удалять дубликаты объявлений пространств имен.Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. По умолчанию средство записи выводит все объявления пространства имен, присутствующие в его сопоставителе пространства имен.The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.

NewLineChars

Возвращает или задает строку символов, используемую для разрыва строк.Gets or sets the character string to use for line breaks.

NewLineHandling

Возвращает или задает значение, указывающее, следует ли осуществлять нормализацию разрывов строк в выходных данных.Gets or sets a value indicating whether to normalize line breaks in the output.

NewLineOnAttributes

Возвращает или задает значение, указывающее, следует ли записывать атрибуты на новой строке.Gets or sets a value indicating whether to write attributes on a new line.

OmitXmlDeclaration

Возвращает или задает значение, определяющее, следует ли опустить XML-объявление.Gets or sets a value indicating whether to omit an XML declaration.

OutputMethod

Возвращает метод, используемый для сериализации выходных данных объекта XmlWriter.Gets the method used to serialize the XmlWriter output.

WriteEndDocumentOnClose

Получает или задает значение, указывающее, добавляет ли XmlWriter закрывающие теги ко всем незакрытым тегам элементов при вызове метода 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.

Методы

Clone()

Создает копию экземпляра XmlWriterSettings.Creates a copy of the XmlWriterSettings instance.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
Reset()

Повторно загружает значения по умолчанию для элементов класса параметров.Resets the members of the settings class to their default values.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к