Ask Learn
Preview
Please sign in to use this experience.
Sign inXmlReader.ReadElementContentAsString Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Reads the current element and returns the contents as a String object.
Overloads
| ReadElementContentAsString(String, String) |
Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a String object. |
| ReadElementContentAsString() |
Reads the current element and returns the contents as a String object. |
- Source:
- XmlReader.cs
- Source:
- XmlReader.cs
- Source:
- XmlReader.cs
- Source:
- XmlReader.cs
Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a String object.
public:
virtual System::String ^ ReadElementContentAsString(System::String ^ localName, System::String ^ namespaceURI);C#
public virtual string ReadElementContentAsString(string localName, string namespaceURI);abstract member ReadElementContentAsString : string * string -> string
override this.ReadElementContentAsString : string * string -> stringPublic Overridable Function ReadElementContentAsString (localName As String, namespaceURI As String) As StringParameters
- localName
- String
The local name of the element.
- namespaceURI
- String
The namespace URI of the element.
Returns
The element content as a String object.
Exceptions
The XmlReader is not positioned on an element.
-or-
An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."
The current element contains child elements.
-or-
The element content cannot be converted to a String object.
The method is called with null arguments.
The specified local name and namespace URI do not match that of the current element being read.
Examples
The following example reads the stringValue element and returns the text content (ignoring the comment and processing instruction).
C#
using (XmlReader reader = XmlReader.Create("dataFile.xml")) {
reader.ReadToFollowing("stringValue");
Console.WriteLine(reader.ReadElementContentAsString("stringValue", ""));
}
Using reader As XmlReader = XmlReader.Create("dataFile.xml")
reader.ReadToFollowing("stringValue")
Console.WriteLine(reader.ReadElementContentAsString("stringValue", ""))
End Using
The example uses the dataFile.xml file as input.
XML
<root>
<stringValue>
<!--comment-->
<?some pi?>
text value of the element.
</stringValue>
<longValue>270000000000001</longValue>
<number>0</number>
<double>2E10</double>
<date>2003-01-08T15:00:00-00:00</date>
</root>
Remarks
This method reads the start tag, the contents of the element, and moves the reader past the end element tag. It expands entities and ignores processing instructions and comments. The element can only contain simple content. That is, it cannot have child elements.
For more information, see the Remarks section of the XmlReader reference page and the W3C XML Schema Part 2: Datatypes recommendation.
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1 |
| UWP | 10.0 |
- Source:
- XmlReader.cs
- Source:
- XmlReader.cs
- Source:
- XmlReader.cs
- Source:
- XmlReader.cs
Reads the current element and returns the contents as a String object.
public:
virtual System::String ^ ReadElementContentAsString();C#
public virtual string ReadElementContentAsString();abstract member ReadElementContentAsString : unit -> string
override this.ReadElementContentAsString : unit -> stringPublic Overridable Function ReadElementContentAsString () As StringReturns
The element content as a String object.
Exceptions
The XmlReader is not positioned on an element.
-or-
An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."
The current element contains child elements.
-or-
The element content cannot be converted to a String object.
The method is called with null arguments.
Examples
The following example reads the stringValue element and returns the text content (ignoring the comment and processing instruction).
C#
using (XmlReader reader = XmlReader.Create("dataFile.xml")) {
reader.ReadToFollowing("stringValue");
Console.WriteLine(reader.ReadElementContentAsString());
}
Using reader As XmlReader = XmlReader.Create("dataFile.xml")
reader.ReadToFollowing("stringValue")
Console.WriteLine(reader.ReadElementContentAsString())
End Using
The example uses the dataFile.xml file as input.
XML
<root>
<stringValue>
<!--comment-->
<?some pi?>
text value of the element.
</stringValue>
<longValue>270000000000001</longValue>
<number>0</number>
<double>2E10</double>
<date>2003-01-08T15:00:00-00:00</date>
</root>
Remarks
This method reads the start tag, the contents of the element, and moves the reader past the end element tag. It expands entities and ignores processing instructions and comments. The element can only contain simple content. That is, it cannot have child elements.
For more information, see the Remarks section of the XmlReader reference page and the W3C XML Schema Part 2: Datatypes recommendation.
For the asynchronous version of this method, see ReadElementContentAsStringAsync.
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1 |
| UWP | 10.0 |