XmlReader.ReadOuterXml Метод

Определение

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

System.Xml

Сборки:

netstandard.dll, System.Xml.ReaderWriter.dll

Исходный код:

XmlReader.cs

При переопределении в производном классе считывает содержимое, включая разметку, представляющую этот узел и все его дочерние элементы.

public:
 virtual System::String ^ ReadOuterXml();

public virtual string ReadOuterXml();

abstract member ReadOuterXml : unit -> string
override this.ReadOuterXml : unit -> string

Public Overridable Function ReadOuterXml () As String

Возвращаемое значение

String

Если средство чтения расположено на элементе или узле атрибута, этот метод возвращает все XML-содержимое, включая разметку текущего узла и всех его дочерних элементов; в противном случае возвращает пустую строку.

Исключения

XmlException

Xml не был хорошо сформирован или произошла ошибка при анализе XML.

InvalidOperationException

Метод XmlReader был вызван до завершения предыдущей асинхронной операции. В этом случае InvalidOperationException создается сообщение "Асинхронная операция уже выполняется".

Примеры

В следующем примере сравниваются ReadInnerXml методы и ReadOuterXml методы.

// Load the file and ignore all white space.
XmlReaderSettings settings = new XmlReaderSettings();
settings.IgnoreWhitespace = true;
using (XmlReader reader = XmlReader.Create("2books.xml")) {

  // Moves the reader to the root element.
  reader.MoveToContent();

  // Moves to book node.
  reader.Read();

  // Note that ReadInnerXml only returns the markup of the node's children
  // so the book's attributes are not returned.
  Console.WriteLine("Read the first book using ReadInnerXml...");
  Console.WriteLine(reader.ReadInnerXml());

  // ReadOuterXml returns the markup for the current node and its children
  // so the book's attributes are also returned.
  Console.WriteLine("Read the second book using ReadOuterXml...");
  Console.WriteLine(reader.ReadOuterXml());
}

' Load the file and ignore all white space.
Dim settings As New XmlReaderSettings()
settings.IgnoreWhitespace = True
Using reader As XmlReader = XmlReader.Create("2books.xml")

  ' Moves the reader to the root element.
  reader.MoveToContent()

  ' Moves to book node.
  reader.Read()

  ' Note that ReadInnerXml only returns the markup of the node's children
  ' so the book's attributes are not returned.
  Console.WriteLine("Read the first book using ReadInnerXml...")
  Console.WriteLine(reader.ReadInnerXml())

  ' ReadOuterXml returns the markup for the current node and its children
  ' so the book's attributes are also returned.
  Console.WriteLine("Read the second book using ReadOuterXml...")
  Console.WriteLine(reader.ReadOuterXml())

End Using

В этом примере файл используется 2books.xml в качестве входных данных.

<!--sample XML fragment-->
<bookstore>
  <book genre='novel' ISBN='10-861003-324'>
    <title>The Handmaid's Tale</title>
    <price>19.95</price>
  </book>
  <book genre='novel' ISBN='1-861001-57-5'>
    <title>Pride And Prejudice</title>
    <price>24.95</price>
  </book>
</bookstore>

Комментарии

Этот метод аналогичен, ReadInnerXml кроме того, он возвращает теги начала и окончания.

Этот метод обрабатывает узлы элементов и атрибутов следующим образом:

Тип узла	Позиция перед вызовом	ФРАГМЕНТ XML	Возвращаемое значение	Позиция после вызова
Element	На начальном теге item1 .	<item1 text1></item1><item2 text2></item2>	<item1 text1></item1>	На начальном теге item2 .
Attribute	На узле атрибута attr1 .	<item attr1="val1" attr2="val2">text</item>	attr1="val1"	Остается на узле атрибута attr1 .

Если средство чтения размещается на конечном узле, вызов эквивалентен вызову ReadOuterXmlRead. Метод возвращает ( String.Empty за исключением узлов атрибутов, в этом случае возвращается разметка атрибута).

Этот метод проверяет наличие хорошо сформированного XML. При ReadOuterXml вызове из XmlValidatingReaderметода этот метод также проверяет возвращенное содержимое.

Как реализовано в XmlNodeReaderфайле , XmlTextReader и XmlValidatingReader классы ReadOuterXml , которые метод учитывает пространство имен. Учитывая следующий XML-текст <A xmlns:S="urn:1"><S:B>hello</S:B></A>, если средство чтения было размещено в начальном S:B теге, ReadOuterXml возвращается <S:B xmlns:S="urn:1">hello<S:B/>.

Сведения об асинхронной версии этого метода см. в разделе ReadOuterXmlAsync.