DocumentViewerBase.Document Property

Gets or sets a IDocumentPaginatorSource to be paginated and displayed by the viewer. This is a dependency property.

Namespace:  System.Windows.Controls.Primitives
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

'Declaration
Public Property Document As IDocumentPaginatorSource
'Usage
Dim instance As DocumentViewerBase 
Dim value As IDocumentPaginatorSource 

value = instance.Document

instance.Document = value
<object>
  <IDocumentPaginatorSource .../>
</object>

Property Value

Type: System.Windows.Documents.IDocumentPaginatorSource
A IDocumentPaginatorSource to be paginated and displayed by the viewer.
The default property is null.

Identifier field

DocumentProperty

Metadata properties set to true

None

This example demonstrates how to parse a XAML file that contains a FlowDocument, and display the loaded file in a FlowDocumentPageViewer.

The following example defines an empty, named FlowDocumentPageViewer that will be manipulated by the code example below.

<FlowDocumentPageViewer
  Name="flowDocPageViewer" 
  MinZoom="50" MaxZoom="1000"
  Zoom="120" ZoomIncrement="5"
  />

At the most basic level, there are steps involved in loading a FlowDocument file into a FlowDocumentPageViewer.

  1. Open the FlowDocument file as a stream.

  2. Parse the stream into a FlowDocument object. The Load method provided by the XamlReader class is intended to perform this operation.

  3. Set the resulting FlowDocument object as the value of the Document property on the FlowDocumentPageViewer.

The following example performs these steps.

void LoadFlowDocumentPageViewerWithXAMLFile(string fileName)
{
    // Open the file that contains the FlowDocument...
    FileStream xamlFile = new FileStream(fileName, FileMode.Open, FileAccess.Read);
    // and parse the file with the XamlReader.Load method.
    FlowDocument content = XamlReader.Load(xamlFile) as FlowDocument;
    // Finally, set the Document property to the FlowDocument object that was 
    // parsed from the input file.
    flowDocPageViewer.Document = content;

    xamlFile.Close();
}

If the FlowDocument references external resources (such as image files) using relative uniform resource identifiers (URIs), it is necessary to specify a ParserContext that includes a BaseUri so that the parser can make sense of the relative URIs. The XamlReader class provides Load method that accepts a ParserContext.

More Code

How to: Save the Contents of a FlowDocumentPageViewer as a XAML File This example demonstrates how to save the contents of a FlowDocumentPageViewer (represented by the Document property) as a XAML file.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft