XmlWriter Класс

Ссылка

Определение

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

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

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

Сборка:: netstandard.dll

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

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

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

Важно!

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

Представляет средство записи, обеспечивающее быстрый прямой способ (без кэширования) создания потоков или файлов, содержащих XML-данные.

public ref class XmlWriter abstract : IDisposable

public ref class XmlWriter abstract : IAsyncDisposable, IDisposable

public ref class XmlWriter abstract

public abstract class XmlWriter : IDisposable

public abstract class XmlWriter : IAsyncDisposable, IDisposable

public abstract class XmlWriter

type XmlWriter = class
    interface IDisposable

type XmlWriter = class
    interface IAsyncDisposable
    interface IDisposable

type XmlWriter = class

Public MustInherit Class XmlWriter
Implements IDisposable

Public MustInherit Class XmlWriter
Implements IAsyncDisposable, IDisposable

Public MustInherit Class XmlWriter

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

Производный: System.Xml.XmlDictionaryWriter

System.Xml.XmlTextWriter

System.Xml.Xsl.Runtime.XmlQueryOutput

Реализации: IDisposable IAsyncDisposable

Примеры

В следующем примере кода показано, как использовать асинхронный API для создания XML.

async Task TestWriter(Stream stream)
{
    XmlWriterSettings settings = new XmlWriterSettings();
    settings.Async = true;

    using (XmlWriter writer = XmlWriter.Create(stream, settings)) {
        await writer.WriteStartElementAsync("pf", "root", "http://ns");
        await writer.WriteStartElementAsync(null, "sub", null);
        await writer.WriteAttributeStringAsync(null, "att", null, "val");
        await writer.WriteStringAsync("text");
        await writer.WriteEndElementAsync();
        await writer.WriteProcessingInstructionAsync("pName", "pValue");
        await writer.WriteCommentAsync("cValue");
        await writer.WriteCDataAsync("cdata value");
        await writer.WriteEndElementAsync();
        await writer.FlushAsync();
    }
}

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

XmlWriter()

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

Свойства

Settings	Получает объект XmlWriterSettings, используемый для создания данного экземпляра XmlWriter.
WriteState	Когда переопределено в производном классе, возвращает состояние средства записи.
XmlLang	При переопределении в производном классе получает текущую область действия `xml:lang`.
XmlSpace	При переопределении в производном классе возвращает класс XmlSpace, предоставляющий текущую область `xml:space`.

Методы

Close()	Когда переопределено в производном классе, закрывает данный поток и базовый поток.
Create(Stream)	Создает новый экземпляр XmlWriter с использованием указанного потока.
Create(Stream, XmlWriterSettings)	Создает новый экземпляр XmlWriter с помощью потока и объекта XmlWriterSettings.
Create(String)	Создает новый экземпляр XmlWriter с использованием указанного имени файла.
Create(String, XmlWriterSettings)	Создает новый экземпляр XmlWriter с помощью имени файла и объекта XmlWriterSettings.
Create(StringBuilder)	Создает новый экземпляр XmlWriter с использованием указанного StringBuilder.
Create(StringBuilder, XmlWriterSettings)	Создает новый экземпляр XmlWriter с использованием объектов StringBuilder и XmlWriterSettings.
Create(TextWriter)	Создает новый экземпляр XmlWriter с использованием указанного TextWriter.
Create(TextWriter, XmlWriterSettings)	Создает новый экземпляр XmlWriter с использованием объектов TextWriter и XmlWriterSettings.
Create(XmlWriter)	Создает новый экземпляр XmlWriter с использованием указанного объекта XmlWriter.
Create(XmlWriter, XmlWriterSettings)	Создает новый экземпляр XmlWriter с использованием указанных объектов XmlWriter и XmlWriterSettings.
Dispose()	Освобождает все ресурсы, используемые текущим экземпляром класса XmlWriter.
Dispose(Boolean)	Освобождает неуправляемые ресурсы, используемые объектом XmlWriter, а при необходимости освобождает также управляемые ресурсы.
DisposeAsync()	Выполняет определяемые приложением задачи, связанные с высвобождением или сбросом неуправляемых ресурсов асинхронно.
DisposeAsyncCore()	Выполняет определяемые приложением задачи, связанные с высвобождением или сбросом управляемых ресурсов асинхронно.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
Flush()	Когда переопределено в производном классе, сохраняет в базовый поток содержимое буфера, а также сохраняет основной поток.
FlushAsync()	Асинхронно записывает в базовый поток содержимое буфера и сохраняет базовый поток.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
LookupPrefix(String)	Когда переопределено в производном классе, возвращает ближайший префикс, определенный в области видимости текущего пространства имен для URI пространства имен.
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
WriteAttributes(XmlReader, Boolean)	При переопределении в производном классе записывает все атрибуты, найденные в текущей позиции в объекте XmlReader.
WriteAttributesAsync(XmlReader, Boolean)	Асинхронно записывает все атрибуты, найденные в текущей позиции в объекте XmlReader.
WriteAttributeString(String, String)	Когда переопределено в производном классе, записывает атрибут с указанным локальным именем и значением.
WriteAttributeString(String, String, String)	Когда переопределено в производном классе, записывает атрибут с указанным локальным именем, URI пространства имен и значением.
WriteAttributeString(String, String, String, String)	Когда переопределено в производном классе, записывает атрибут с указанным префиксом, локальным именем, URI пространства имен и значением.
WriteAttributeStringAsync(String, String, String, String)	Асинхронно записывает атрибут с заданным префиксом, локальным именем, универсальным кодом ресурса (URI) пространства имен и значением.
WriteBase64(Byte[], Int32, Int32)	Когда переопределено в производном классе, преобразует указанный набор двоичных байтов в кодировку Base64 и записывает получившийся текст.
WriteBase64Async(Byte[], Int32, Int32)	Асинхронно преобразует указанный набор двоичных байтов в кодировку Base64 и записывает получившийся текст.
WriteBinHex(Byte[], Int32, Int32)	При переопределении в производном классе преобразует указанный набор двоичных байтов как `BinHex` и выводит получившийся текст.
WriteBinHexAsync(Byte[], Int32, Int32)	Асинхронно кодирует указанные двоичные байты как `BinHex` и выводит получившийся текст.
WriteCData(String)	Когда переопределено в производном классе, записывает блок <![CDATA[...]]>, содержащий заданный текст.
WriteCDataAsync(String)	Асинхронно записывает блок <![CDATA[...]]>, содержащий заданный текст.
WriteCharEntity(Char)	Когда переопределено в производном классе, вызывает создание сущности знака для указанного значения знака Юникода.
WriteCharEntityAsync(Char)	Асинхронно инициирует создание сущности знака для указанного значения знака Юникода.
WriteChars(Char[], Int32, Int32)	Когда переопределено в производном классе, записывает содержимое текстового буфера.
WriteCharsAsync(Char[], Int32, Int32)	Асинхронно записывает содержимое текстового буфера.
WriteComment(String)	Когда переопределено в производном классе, записывает примечание <!--...-->, содержащее заданный текст.
WriteCommentAsync(String)	Асинхронно записывает комментарий <!--...-->, содержащий заданный текст.
WriteDocType(String, String, String, String)	Когда переопределено в производном классе, записывает объявление DOCTYPE с указанным именем и дополнительными атрибутами.
WriteDocTypeAsync(String, String, String, String)	Асинхронно записывает объявление DOCTYPE с указанным именем и дополнительными атрибутами.
WriteElementString(String, String)	Записывает элемент с заданным локальным именем и значением.
WriteElementString(String, String, String)	Записывает элемент с заданным локальным именем, URI пространства имен и значением.
WriteElementString(String, String, String, String)	Записывает элемент с заданным префиксом, локальным именем, универсальный кодом ресурса (URI) пространства имен и значением.
WriteElementStringAsync(String, String, String, String)	Асинхронно записывает элемент с заданным префиксом, локальным именем, универсальным кодом ресурса (URI) пространства имен и значением.
WriteEndAttribute()	При переопределении в производном классе закрывает предыдущий вызов WriteStartAttribute(String, String).
WriteEndAttributeAsync()	Асинхронно закрывает предыдущий вызов WriteStartAttribute(String, String).
WriteEndDocument()	Когда переопределено в производном классе, закрывает все открытые элементы и атрибуты, возвращая средство записи в начальное состояние.
WriteEndDocumentAsync()	Асинхронно закрывает все открытые элементы и атрибуты, возвращая средство записи в начальное состояние.
WriteEndElement()	Когда переопределено в производном классе, закрывает один элемент и извлекает из стека область видимости соответствующего пространства имен.
WriteEndElementAsync()	Асинхронно закрывает один элемент и извлекает из стека область видимости соответствующего пространства имен.
WriteEntityRef(String)	При переопределении в производном классе записывает ссылку на сущность в виде `&name;`.
WriteEntityRefAsync(String)	Асинхронно записывает ссылку на сущность в виде `&name;`.
WriteFullEndElement()	Когда переопределено в производном классе, закрывает один элемент и извлекает из стека область видимости соответствующего пространства имен.
WriteFullEndElementAsync()	Асинхронно закрывает один элемент и извлекает из стека область видимости соответствующего пространства имен.
WriteName(String)	При переопределении в производном классе записывает указанное имя, гарантируя, что оно является допустимым в соответствии с рекомендацией W3C XML 1.0 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).
WriteNameAsync(String)	Асинхронно записывает указанное имя, гарантируя, что оно является допустимым в соответствии с рекомендацией W3C XML 1.0 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).
WriteNmToken(String)	При переопределении в производном классе записывает указанное имя, гарантируя, что оно является допустимым NmToken в соответствии с рекомендацией W3C XML 1.0 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).
WriteNmTokenAsync(String)	Асинхронно записывает указанное имя, гарантируя, что оно является допустимым NmToken в соответствии с рекомендацией W3C XML 1.0 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).
WriteNode(XmlReader, Boolean)	Когда переопределено в производном классе, копирует все данные из средства чтения в средство записи и перемещает средство чтения к началу следующего элемента того же уровня.
WriteNode(XPathNavigator, Boolean)	Копирует все из объекта XPathNavigator в средство записи. Позиция XPathNavigator остается неизменной.
WriteNodeAsync(XmlReader, Boolean)	Асинхронно копирует все данные из средства чтения в средство записи и перемещает средство чтения к началу следующего элемента того же уровня.
WriteNodeAsync(XPathNavigator, Boolean)	Асинхронно копирует все из объекта XPathNavigator в средство записи. Позиция XPathNavigator остается неизменной.
WriteProcessingInstruction(String, String)	При переопределении в производном классе считывает инструкцию обработки с пробелом между именем и текстом в следующем виде: <?имя текст?>.
WriteProcessingInstructionAsync(String, String)	Асинхронно записывает инструкцию обработки с пробелом между именем и текстом в следующем виде: <?имя текст?>.
WriteQualifiedName(String, String)	При переопределении в производном классе считывает полное имя пространства имен. Этот метод выполняет поиск префикса для пространства имен в его области.
WriteQualifiedNameAsync(String, String)	Асинхронно записывает полное имя пространства имен. Этот метод выполняет поиск префикса для пространства имен в его области.
WriteRaw(Char[], Int32, Int32)	Когда переопределено в производном классе, вручную записывает из буфера символов необработанные данные для разметки .
WriteRaw(String)	Когда переопределено в производном классе, вручную записывает из строки необработанные данные для разметки.
WriteRawAsync(Char[], Int32, Int32)	Асинхронно, вручную записывает для разметки необработанные данные из буфера символов.
WriteRawAsync(String)	Асинхронно, вручную записывает необработанные данные для разметки.
WriteStartAttribute(String)	Записывает начало атрибута с заданным локальным именем.
WriteStartAttribute(String, String)	Записывает начало атрибута с заданным локальным именем и URI пространства имен.
WriteStartAttribute(String, String, String)	Когда переопределено в производном классе, записывает начало атрибута с указанным префиксом, локальным именем и URI пространства имен.
WriteStartAttributeAsync(String, String, String)	Асинхронно записывает начало атрибута с заданным префиксом, локальным именем и универсальным кодом ресурса (URI) пространства имен.
WriteStartDocument()	Когда переопределено в производном классе, записывает объявление XML с номером версии "1.0".
WriteStartDocument(Boolean)	Когда переопределено в производном классе, записывает объявление XML с номером версии "1.0" и отдельным атрибутом.
WriteStartDocumentAsync()	Асинхронно записывает объявление XML с номером версии "1.0".
WriteStartDocumentAsync(Boolean)	Асинхронно записывает объявление XML с номером версии "1.0". и отдельным атрибутом.
WriteStartElement(String)	Когда переопределено в производном классе, записывает открывающий тег с указанным локальным именем.
WriteStartElement(String, String)	Когда переопределено в производном классе, записывает указанный открывающий тег и связывает его с заданным пространством имен.
WriteStartElement(String, String, String)	Когда переопределено в производном классе, записывает указанный открывающий тег и связывает его с заданным пространством имен и префиксом.
WriteStartElementAsync(String, String, String)	Асинхронно записывает указанный открывающий тег и связывает его с заданным пространством имен и префиксом.
WriteString(String)	Записывает заданное текстовое содержимое при переопределении в производном классе.
WriteStringAsync(String)	Асинхронно записывает заданное текстовое содержимое.
WriteSurrogateCharEntity(Char, Char)	Когда переопределено в производном классе, создает и записывает сущность символа-заместителя для пары символов-заместителей.
WriteSurrogateCharEntityAsync(Char, Char)	Асинхронно создает и записывает сущность символа-заместителя для пары символов-заместителей.
WriteValue(Boolean)	Записывает значение Boolean.
WriteValue(DateTime)	Записывает значение DateTime.
WriteValue(DateTimeOffset)	Записывает значение DateTimeOffset.
WriteValue(Decimal)	Записывает значение Decimal.
WriteValue(Double)	Записывает значение Double.
WriteValue(Int32)	Записывает значение Int32.
WriteValue(Int64)	Записывает значение Int64.
WriteValue(Object)	Записывает значение объекта.
WriteValue(Single)	Записывает число с плавающей запятой одиночной точности.
WriteValue(String)	Записывает значение String.
WriteWhitespace(String)	Когда переопределено в производном классе, записывает указанный символ-разделитель.
WriteWhitespaceAsync(String)	Асинхронно записывает указанный символ-разделитель.

Явные реализации интерфейса

IDisposable.Dispose()

Описание этого члена см. в разделе Dispose().

Методы расширения

ConfigureAwait(IAsyncDisposable, Boolean)

Настраивает способ выполнения ожиданий для задач, возвращаемых из асинхронного высвобождаемого объекта.

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

См. также раздел

XML-документы и данные