• Article

XDocument.Load Method (String, LoadOptions)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Creates a new XDocument from a file located in the application's XAP package, 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)

Syntax

'Declaration
Public Shared Function Load ( _
    uri As String, _
    options As LoadOptions _
) As XDocument

public static XDocument Load(
    string uri,
    LoadOptions options
)

Parameters

  • uri
    Type: System.String
    A URI string that references the file to be loaded into a new XDocument. This file is located in the application's XAP package. If you want to download a file from some other location, follow the steps described in How to: Load an XML file from an Arbitrary URI Location with LINQ to XML.

Return Value

Type: System.Xml.Linq.XDocument
An XDocument that contains the contents of the specified file.

Remarks

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.

If you have to modify XmlReaderSettings, following these steps:

  1. Create an XmlReader by calling one of the Create overloads that take XmlReaderSettings as a parameter.

  2. Pass the XmlReader to one of the XDocument's Load overloads that takes XmlReader as a parameter.

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.

Use Parse to create an XDocument from a string that contains XML.

There is a performance penalty if you set the SetBaseUri and the SetLineInfo flags.

The base URI and the line information are accurate immediately after loading the XML document. If you modify the XML tree after loading the document, the base URI and line information may become meaningless.

For code examples, see:

How to: Load an XML File from an Arbitrary URI Location with LINQ to XML

How to: Save to and Load from Isolated Storage with LINQ to XML

How to: Load a File from a XAP Package Using XmlXapResolver

You can find more examples under Processing XML Data with LINQ to XML (Silverlight).

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.