XmlWriterSettings Класс

Ссылка

Определение

Пространство имен:: System.Xml

Сборка:: System.Xml.ReaderWriter.dll

Сборка:: System.Xml.dll

Сборка:: netstandard.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Задает набор функций, которые должны поддерживаться объектом XmlWriter, создаваемым с помощью метода Create.

public ref class XmlWriterSettings sealed

public sealed class XmlWriterSettings

type XmlWriterSettings = class

Public NotInheritable Class XmlWriterSettings

Наследование: Object
XmlWriterSettings

Примеры

В следующем примере создается объект XmlWriter , который записывает данные в XML-файл и записывает каждый атрибут в новой строке.

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

В примере выводятся следующие выходные данные:

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

Этот Create метод является предпочтительным механизмом для получения XmlWriter экземпляров. Метод Create использует XmlWriterSettings класс, чтобы указать, какие функции следует реализовать в созданном объекте XmlWriter .

Примечание

Если вы используете XmlWriter объект с методом Transform , следует использовать OutputSettings свойство для получения XmlWriterSettings объекта с правильными параметрами. Это гарантирует правильность параметров выходных данных для объекта XmlWriter.

Класс XmlWriterSettings предоставляет свойства, управляющие соответствием данных и форматом вывода.

Для проверок соответствия данным и автоматического исправления используйте следующие свойства:

Свойство	Что определяет	Значение	По умолчанию
CheckCharacters	Следует ли проверять, находятся ли символы в наборе символов XML, как определено W3C.	`true` либо `false`	`true`
ConformanceLevel	Проверяется, является ли вывод хорошо сформированным XML-документом или фрагментом XML 1.0.	ConformanceLevel.Document (уровень документа), Fragment (уровень фрагмента) или Auto (автоматическое обнаружение)	ConformanceLevel.Document (соответствие на уровне документа)
WriteEndDocumentOnClose	Следует ли добавлять закрывающие теги ко всем незакрытым элементам при вызове Close метода.	`true` либо `false`	`true`

Чтобы указать выходной формат, используйте следующие свойства:

Свойство	Что определяет	Значение	По умолчанию
Encoding	Используемая кодировка текста.	Значение System.Text.Encoding	Encoding.UTF8
Indent	Отступ элементов	`true` либо `false`	`false` (без отступа)
IndentChars	Символьная строка, используемая при отступе (используется, если Indent задано значение `true`).	Строка	Два пробела
NewLineChars	Символьная строка, используемая для разрывов строк.	Строка	`\r\n` (возврат каретки, канал строки)
NewLineHandling	Обработка символов новой строки.	System.Xml.NewLineHandling значение: Entitize (нормализация), Replace (замена) или None (оставьте без изменений)	Replace (замените символами, указанными в параметре NewLineChars)
NewLineOnAttributes	Следует ли записывать атрибуты в отдельных строках (не влияет, когда Indent есть `false`).	`true` либо `false`	`false`
OmitXmlDeclaration	Указывает, следует ли записывать xml-объявление.	`true` либо `false`	`false`

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

XmlWriterSettings()

Инициализирует новый экземпляр класса XmlWriterSettings.

Свойства

Async	Получает или задает значение, указывающее, можно ли использовать асинхронные методы XmlWriter для конкретного экземпляра XmlWriter.
CheckCharacters	Возвращает или задает значение, указывающее, должно ли средство записи XML выполнять проверку на предмет того, соответствуют ли все символы в документе разделу "2.2 Characters" документа W3C XML 1.0 Recommendation.
CloseOutput	Возвращает или задает значение, указывающее, следует ли объекту XmlWriter закрывать также и основной поток или TextWriter при вызове метода Close().
ConformanceLevel	Возвращает или задает уровень соответствия, на предмет которого средство записи XML проверяет выходные данные XML.
DoNotEscapeUriAttributes	Возвращает или задает значение, указывающее, преобразует ли XmlWriter атрибуты URI в escape-последовательности.
Encoding	Возвращает или задает тип используемой кодировки текста.
Indent	Возвращает или задает значение, указывающее, следует ли использовать отступ для элементов.
IndentChars	Возвращает или задает строку символов, используемую для отступов. Этот параметр используется, если значение свойства Indent равно `true`.
NamespaceHandling	Получает или задает значение, указывающие, должен ли объект XmlWriter при записи содержимого XML удалять дубликаты объявлений пространств имен. По умолчанию средство записи выводит все объявления пространства имен, присутствующие в его сопоставителе пространства имен.
NewLineChars	Возвращает или задает строку символов, используемую для разрыва строк.
NewLineHandling	Возвращает или задает значение, указывающее, следует ли осуществлять нормализацию разрывов строк в выходных данных.
NewLineOnAttributes	Возвращает или задает значение, указывающее, следует ли записывать атрибуты на новой строке.
OmitXmlDeclaration	Возвращает или задает значение, определяющее, следует ли опустить XML-объявление.
OutputMethod	Возвращает метод, используемый для сериализации выходных данных объекта XmlWriter.
WriteEndDocumentOnClose	Получает или задает значение, указывающее, добавляет ли XmlWriter закрывающие теги ко всем незакрытым тегам элементов при вызове метода Close().

Методы

Clone()	Создает копию экземпляра XmlWriterSettings.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
Reset()	Повторно загружает значения по умолчанию для элементов класса параметров.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

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