PageContent.GetPageRootAsync Method (Boolean)

 
System_CAPS_noteNote

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

Asynchronously loads and returns the FixedPage content element.

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

Public Sub GetPageRootAsync (
	forceReload As Boolean
)

Parameters

forceReload
Type: System.Boolean

true to always reload the FixedPage even if it has been previously loaded and cached; false to load the FixedPage only if there is no cached version.

GetPageRootAsync asynchronously loads and parses the FixedPage data stream associated with this PageContent. Other threads will continue to run while GetPageRootAsync completes.

The following steps illustrate how to load the FixedPage content asynchronously:

  1. Create a GetPageRootCompletedEventHandler delegate and add it to be notified of GetPageRootCompleted events.

  2. Call GetPageRootAsync.

  3. When the GetPageRootCompleted event occurs and the delegate is called, the FixedPage content has completed loading. The loaded FixedPage element is returned through the GetPageRootCompletedEventArgs.Result property.

For more information about the <PageContent> element, see chapter 3 of the XPS specification which you can obtain at XPS: Specification and License Downloads.

.NET Framework
Available since 3.0
Return to top
Show: