Intersoft ClientUI Documentation
XPSDocumentViewer Class
Members 



Represents a document viewer class which accepts XPS document format.
Object Model
XPSDocumentViewer ClassXPSDocument ClassISFramework ClassStyleSelector ClassDataTemplateSelector ClassDocumentViewerResource Class
Syntax
<TemplatePartAttribute(Name="OutlineTreeView", Type=Intersoft.Client.UI.Aqua.UXCollection.UXTreeView)>
Public Class XPSDocumentViewer 
   Inherits Intersoft.Client.UI.DocumentViewers.DocumentViewerGenericBase(Of XPSDocument)
   Implements Intersoft.Client.Framework.IControlIntersoft.Client.Framework.IFrameworkIntersoft.Client.Framework.IItemsControl, Intersoft.Client.Framework.ILicensing 
Dim instance As XPSDocumentViewer
[TemplatePartAttribute(Name="OutlineTreeView", Type=Intersoft.Client.UI.Aqua.UXCollection.UXTreeView)]
public class XPSDocumentViewer : Intersoft.Client.UI.DocumentViewers.DocumentViewerGenericBase<XPSDocument>, Intersoft.Client.Framework.IControlIntersoft.Client.Framework.IFrameworkIntersoft.Client.Framework.IItemsControl, Intersoft.Client.Framework.ILicensing  
[TemplatePartAttribute(Name="OutlineTreeView", Type=Intersoft.Client.UI.Aqua.UXCollection.UXTreeView)]
public ref class XPSDocumentViewer : public Intersoft.Client.UI.DocumentViewers.DocumentViewerGenericBase<XPSDocument>, Intersoft.Client.Framework.IControlIntersoft.Client.Framework.IFrameworkIntersoft.Client.Framework.IItemsControl, Intersoft.Client.Framework.ILicensing  
Remarks

XPSDocumentViewer is a specialized implementation of UXDocumentViewer that designed to work with Microsoft XPS document. XPSDocumentViewer includes sophisticated parsing and layout rendering implementation that fully conform to the XML Paper Specification. For more information about XML Paper Specification (XPS), please visit MSDN Library - XPS Document.

XPSDocumentViewer shares many common features with UXDocumentViewer such as rich navigation support, zoom presets, text selection, search, localization and printing. To learn about these shared features in details, please refer to UXDocumentViewer Overview.

In addition, XPSDocumentViewer provides a number of advanced features to work with XPS document such as background loading feature which is intended to handle large XPS document and outlines navigation.

There are a number of ways to load an XPS document in XPSDocumentViewer. You can set the Source property of the control to the URI of the document, or set the Document property to an XPSDocument object which is ideal for programmatic loading. The most common and the recommended way to load an XPS document is by setting the Source property which can be declared directly in the XAML. You can also bind the Source property for dynamic loading of an XPS document.

XPSDocumentViewer supports two loading strategies such as discussed below.

When loading from a web server, XPSDocumentViewer automatically displays a busy visual hint indicating the current download progress. You can localize the textual content which is discussed later in this section.

The following example shows how to configure the XPSDocumentViewer to load an XPS document from web server.

View
Copy Code
<Intersoft:XPSDocumentViewer Source="Assets/Documents/ClientUI_DevForceIntegration.xps" /> 

Understanding XPSDocumentViewer Elements

XPSDocumentViewer facilitates users with the capability to open, search, and navigate an XPS document. To achieve these capabilities, UXDocumentViewer comes with rich user interface elements that consisted of UXResizablePane, UXNavigationPane, UXVirtualizingListBox, UXTreeView, UXSearchBox, UXToolBar and UXStatusBar.

The following figure illustrates the rich user interface elements of XPSDocumentViewer in details.

XPSDocumentViewer Layout and Elements

The top illustration shows the control's elements with the navigation pane expanded, while the bottom illustration shows the control's elements with the navigation pane minimized.

Although the XPSDocumentViewer already provides predefined UI elements to allow rich user interaction, you are free to customize any of the elements to suit your application's preferences – thanks to the loosely-coupled architeture design that made the customization possible. You can customize the styles and appearance of the elements entirely by editing the control template using designer tools such as Expression Blend.

For more information about the advanced features of XPSDocumentViewer, see XPSDocumentViewer Overview.

Inheritance Hierarchy

System.Object
   System.Windows.DependencyObject
      System.Windows.UIElement
         System.Windows.FrameworkElement
            System.Windows.Controls.Control
               System.Windows.Controls.ItemsControl
                  Intersoft.Client.Framework.ISItemsControl
                     Intersoft.Client.UI.DocumentViewers.DocumentViewerBase
                        Intersoft.Client.UI.DocumentViewers.DocumentViewerGenericBase<T>
                           Intersoft.Client.UI.DocumentViewers.XPSDocumentViewer

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

XPSDocumentViewer Members
Intersoft.Client.UI.DocumentViewers Namespace

Concepts

XPSDocumentViewer Overview
Document Framework Overview

Send Feedback