XDocument::Parse Method (String^, LoadOptions)

 

Creates a new XDocument from a string, optionally preserving white space, setting the base URI, and retaining line information.

Namespace:   System.Xml.Linq
Assembly:  System.Xml.Linq (in System.Xml.Linq.dll)

public:
static XDocument^ Parse(
	String^ text,
	LoadOptions options
)

Parameters

text
Type: System::String^

A string that contains XML.

options
Type: System.Xml.Linq::LoadOptions

A LoadOptions that specifies white space behavior, and whether to load base URI and line information.

Return Value

Type: System.Xml.Linq::XDocument^

An XDocument populated from the string that contains XML.

If the source XML is indented, setting the PreserveWhitespace flag in options causes the reader to read all white space in the source XML. Nodes of type XText are created for both significant and insignificant white space.

If the source XML is indented, not setting the PreserveWhitespace flag in options causes the reader to ignore all of the insignificant white space in the source XML. The XML tree is created without any text nodes for insignificant white space.

If the source XML is not indented, setting the PreserveWhitespace flag in options has no effect. Significant white space is still preserved, and there are no spans of insignificant white space that could cause the creation of more white space text nodes.

For more information, see Preserving White Space while Loading or Parsing XML and Preserving White Space While Serializing.

Setting SetBaseUri is not valid when parsing from a String.

There is a performance penalty if you set the SetLineInfo flag.

The line information is accurate immediately after loading the XML document. If you modify the XML tree after loading the document, the line information may become meaningless.

LINQ to XML's loading functionality is built upon XmlReader. Therefore, you might catch any exceptions that are thrown by the XmlReader::Create overload methods and the XmlReader methods that read and parse the document.

The following example parses a string into an XDocument.

No code example is currently available or this language may not be supported.

This example produces the following output:


                nodes when preserving whitespace: 8
nodes when not preserving whitespace: 4

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: