Intersoft ClientUI Documentation
SqlReportViewer Class
Members 



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

SqlReportViewer is a specialized implementation of UXDocumentViewer designed to work with Microsoft SQL Server 2008 Reporting Services document. SqlReportViewer includes sophisticated parsing and layout rendering implementation which presents the report identical to the design. In addition, it also features automatic pagination capability which renders the report based on the paper size defined in the report. This behavior is similar to the PDF export result in the SQL Server Reporting Services (further abbreviated as SSRS). To learn more about SQL Reporting Services, please visit MSDN Library.

SqlReportViewer supports SQL reporting service actions such as Toggle item, Go to report, Go to bookmark, and Go to URL, as well as exporting. The supported export formats in SQL reporting service, such as XML, CSV, PDF, HTML, Excel, and Word, are well supported in SqlReportViewer.

SqlReportViewer Overview

SqlReportViewer supports most report items available in SSRS such as TextBox, Line, Image as well as comprehensive support for Matrix, Table and List (Tablix). While, other controls such as Chart, Map, and Gauge are not rendered by default. To render these controls, a custom rendering class must be implemented such as described in How-to: Extending SqlReportViewer Rendering Engine.

SqlReportViewer supports both Silverlight and WPF platforms equipped with key features such as pixel-perfect document rendering, search and highlight matching words, text selection, copy to clipboard, navigate to page, background loading and printing support.

In addition, SqlReportViewer also features historical journal navigation using the back and forward toolbar button. Toggle item and goto report actions will automatically add an entry to the historical navigation list.

Using SqlDocumentViewer

SqlReportViewer 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, SqlReportViewer provides a number of advanced features to work with SQL reporting service report such as background loading feature which is designed to handle relatively large report, report navigation, and report browser.

Before you can use SqlReportViewer, you need to first register the rendering extension and configure the server-side settings such as handlers and service points. To get started, please see Walkthrough: Configuring SqlReportViewer for First Time Use.

The following example shows the XAML code to display a SSRS report in SqlReportViewer.

View
Copy Code
<Intersoft:SqlReportViewer ReportProxyHandler="http://adventureworks.com/SqlReportViewerHandler.ashx" 
                           ReportServer="http://localhost/ReportServer" 
                           ReportName="/Customers Report" />

Before you can use SqlReportViewer to display a report, you need to first design the report using either Report Builder or Visual Studio tools for SSRS. The following illustration shows the design-time environment for SSRS and the viewer results in the SqlReportViewer. To learn more about designing report in SSRS, please visit MSDN Library.

Understanding SqlReportViewer Elements

SqlReportViewer facilitates users with the capability to view, search, and navigate a SQL report. To achieve these capabilities, SqlReportViewer 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 SqlReportViewer in details.

SqlViewer Layout

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 SqlReportViewer 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 architecture 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.

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.SqlReportViewer

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

SqlReportViewer Members
Intersoft.Client.UI.DocumentViewers Namespace

Concepts

UXDocumentViewer Overview
SqlReportViewer Overview

Send Feedback