XmlReader.ReadOuterXml Metoda

Definicja

Gdy jest zastępowany w klasie pochodnej, odczytuje zawartość, włącznie z adiustacją, reprezentującą ten węzeł i jego wszystkie elementy podrzędne.When overridden in a derived class, reads the content, including markup, representing this node and all its children.

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

Zwraca

Jeśli czytnik jest umieszczony w elemencie lub węźle atrybutu, Metoda ta zwraca całą zawartość XML, w tym znaczniki bieżącego węzła i wszystkie jego elementy podrzędne; w przeciwnym razie zwraca pusty ciąg.If the reader is positioned on an element or an attribute node, this method returns all the XML content, including markup, of the current node and all its children; otherwise, it returns an empty string.

Wyjątki

KOD XML nie został poprawnie sformułowany lub wystąpił błąd podczas analizowania kodu XML.The XML was not well-formed, or an error occurred while parsing the XML.

Metoda XmlReader została wywołana przed ukończeniem poprzedniej operacji asynchronicznej.An XmlReader method was called before a previous asynchronous operation finished. W takim przypadku InvalidOperationException jest generowany z komunikatem "asynchroniczna operacja jest już w toku".In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

Przykłady

Poniższy przykład porównuje metody ReadInnerXml i ReadOuterXml.The following example compares the ReadInnerXml and ReadOuterXml methods.

// 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

W przykładzie jest użyty plik 2books.xml jako dane wejściowe.The example uses 2books.xml file as input.

<!--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>

Uwagi

Ta metoda jest podobna do ReadInnerXml z wyjątkiem tego, że zwraca również Tagi początkowy i końcowy.This method is similar to ReadInnerXml except it also returns the start and end tags.

Ta metoda obsługuje węzły elementów i atrybutów w następujący sposób:This method handles element and attribute nodes in the following manner:

Typ węzłaNode type Umieść przed wywołaniemPosition before the call Fragment XMLXML fragment Wartość zwracanaReturn value Umieść po wywołaniuPosition After the Call
Element W tagu początkowym item1.On the item1 start tag. <Item1 — > Tekst1</Item1 ><Item2 — > Tekst2</Item2 ><item1>text1</item1><item2>text2</item2> <Item1 — > Tekst1</Item1 ><item1>text1</item1> W tagu początkowym item2.On the item2 start tag.
Attribute W węźle atrybutu attr1.On the attr1 attribute node. <Item attr1 = "Val1" attr2 = "val2" > Text</Item ><item attr1="val1" attr2="val2">text</item> attr1="val1"attr1="val1" Pozostanie w węźle atrybutu attr1.Remains on the attr1 attribute node.

Jeśli czytnik jest umieszczony w węźle liścia, wywołanie ReadOuterXml jest równoważne wywołaniu Read.If the reader is positioned on a leaf node, calling ReadOuterXml is equivalent to calling Read. Metoda zwraca String.Empty (z wyjątkiem węzłów atrybutów, w tym przypadku zwracana jest znacznik atrybutu).The method returns String.Empty (except for attribute nodes, in which case the attribute markup is returned).

Ta metoda sprawdza poprawnie sformułowany kod XML.This method checks for well-formed XML. Jeśli ReadOuterXml jest wywoływana z XmlValidatingReader, ta metoda również sprawdza poprawność zwróconej zawartościIf ReadOuterXml is called from an XmlValidatingReader, this method also validates the content returned

Zgodnie z implementacją w XmlNodeReader, XmlTextReader i XmlValidatingReader klasy ReadOuterXml Metoda ma świadomość przestrzeni nazw.As implemented in the XmlNodeReader, XmlTextReader and XmlValidatingReader classes the ReadOuterXml method is namespace aware. Podano następujący tekst XML <A xmlns:S="urn:1"><S:B>hello</S:B></A>, jeśli czytnik został umieszczony w S:B tagu początkowym, ReadOuterXml zwraca <S:B xmlns:S="urn:1">hello<S:B/>.Given the following XML text <A xmlns:S="urn:1"><S:B>hello</S:B></A>, if the reader were positioned on the S:B start tag, ReadOuterXml returns <S:B xmlns:S="urn:1">hello<S:B/>.

Aby uzyskać asynchroniczną wersję tej metody, zobacz ReadOuterXmlAsync.For the asynchronous version of this method, see ReadOuterXmlAsync.

Dotyczy