XmlWriterSettings Класс

Определение

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

Сборки:: System.Xml.dll, System.Xml.ReaderWriter.dll

Сборки:: netstandard.dll, System.Xml.ReaderWriter.dll

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

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

Сборка:: netstandard.dll

Исходный код:: XmlWriterSettings.cs

Исходный код:: XmlWriterSettings.cs

Исходный код:: XmlWriterSettings.cs

Исходный код:: XmlWriterSettings.cs

Исходный код:: XmlWriterSettings.cs

Важно!

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

Задает набор функций для поддержки объекта, созданного 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`).	String	Два пробела
NewLineChars	Символьная строка, используемая для разрывов строк.	String	`\r\n` (возврат каретки, канал строки) для платформ, отличных от Unix, или `\n` (канал строк) для платформ Unix
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 Символы" рекомендации W3C XML 1.0.
CloseOutput	Возвращает или задает значение, указывающее, следует ли XmlWriter также закрыть базовый поток или TextWriter при вызове Close() метода.
ConformanceLevel	Возвращает или задает уровень соответствия, на котором модуль записи XML проверяет выходные данные XML.
DoNotEscapeUriAttributes	Возвращает или задает значение, указывающее, не экранирует ли XmlWriter атрибуты URI.
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)

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

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через