XamlReader::LoadAsync Method (XmlReader^)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Reads the XAML input in the specified XmlReader and returns the root of the corresponding object tree.

Namespace:   System.Windows.Markup
Assembly:  PresentationFramework (in PresentationFramework.dll)

Object^ LoadAsync(
	XmlReader^ reader


Type: System.Xml::XmlReader^

An existing XmlReader that has already loaded/read the XAML input.

Return Value

Type: System::Object^

The root of the created object tree.

Exception Condition

reader is null.


Multiple load operations are performed concurrently with the same XamlReader.

An asynchronous XAML load operation will initially return an object that is purely the root object. Asynchronously, XAML parsing then continues, and any child objects are filled in under the root. This is in contrast to the typical WPF XAML processing behavior and its interaction with WPF concepts of object lifetime. In the typical (non-async) interaction, all properties of an object including all child collections are filled before returning an element and reporting it as loaded. That behavior equates to a bottom-up methodology for creating the tree where the root object is the last object to become available.

You typically would assign the returned object from LoadAsync to some location in your application's object tree, with the knowledge that content might still be filling in and might cause incremental layout updates if the entire content is exposed as part of the UI. For this reason it is typical to isolate or virtualize any asynchronously loaded objects from XAML, and to use application-specific logic or application state to notify when LoadCompleted is handled.

In order for LoadAsync to load XAML input asynchronously, the root element in the XAML markup must contain the attribute and value x:SynchronousMode="Async". The value is treated as case sensitive. If the XAML markup root does not contain x:SynchronousMode="Async", no exception is thrown, and the call is instead processed as a synchronous load (see Load(XmlReader^)).

Only one asynchronous load operation per instance of the XamlReader class can be performed at a time. If more than one asynchronous operation is attempted on the same instance of the XamlReader class an InvalidOperationException is thrown.

.NET Framework
Available since 3.0
Return to top