Skip to end of metadata
Go to start of metadata

Represents a report viewer control.

Definition

public class ReportViewer : ISDocumentViewerBase,

IReportViewer, IExportProvider

Summary

The following table summarizes the members exposed in this class.

Public Constructors

ReportViewer Constructor() Create an instance of ReportViewer.

Public Properties

AutoHideParameterBox Gets or sets the value indicating whether parameter box should be hidden automatically.
Bookmarks Gets or sets the bookmarks.
BufferSize Gets or sets the buffer size.
BusyIndicatorVisibility Gets or sets the value indicating whether busy indicator is visible.
CanUserDesign Gets or sets a value that determine whether user can design report at runtime.
CustomToolGroup Gets or sets additional tool group.
DefaultStyles Gets or sets the default styles to be used by report documents.
DesignerCanNew Gets or sets the value indicating whether user can create new report in runtime designer.
DesignerCanOpen Gets or sets the value indicating whether user can open report in runtime designer.
DesignerCanSave Gets or sets the value indicating whether user can save report in runtime designer.
DesignerCanSaveAs Gets or sets the value indicating whether user can save report in runtime designer.
DesignerNewCommand Gets or sets the new command for runtime designer.
DesignerNewReportTemplateUri Gets or sets the new report template uri for runtime designer.
DesignerObjectDataSourceCollection Gets or sets the object data source collection in runtime designer.
DesignerOpenCommand Gets or sets the open command for runtime designer.
DesignerSaveCommand Gets or sets the save command for runtime designer.
DesignerSaveMetadata Gets or sets the save metadata for runtime designer.
Document Gets or sets the rendered document.
EnableBackgroundLoading Gets or sets the value indicating whether backgroudn loading is enabled.
ErrorBoxVisibility Gets or sets the value indicating whether error box is visible.
ErrorText Gets or sets the error text.
Fonts Gets or sets the fonts collection used for reporting
IdleLatency Gets or sets the idle latency.
InitializeReportDocumentCommand Gets or sets the initialize report document command.
IsBackgroundLoading Gets or sets the value indicating whether report viewer use background loading.
IsBusy Gets or sets the value indicating whether report viewer is in busy mode.
IsReportParametersError Gets or sets the value indicating whether report parameters contains error.
LoadedPages Gets or sets the loaded report pages.
LoadingMode Gets or sets the loading mode.
NavigationPaneSelectedIndex Gets or sets the selected index of navigation pane.
ParameterBoxVisibility Gets or sets the value indicating whether parameter box is visible.
PrintCommand Gets or sets the print command.
PrintedCommand Gets or sets the printed command.
PrintOutlineVisibility Gets or sets the value indicating whether print outline is visible.
ReportDataProvider Gets or sets the report data provider.
ReportDefinition Gets or sets the report definition.
ReportDocument Gets or sets the report document.
ReportGlobalizationProvider Gets or sets the report globalization provider.
ReportList Gets or sets the report list.
ReportListItemMemberPath Gets or sets the report list item member path.
ReportListItemsMemberPath Gets or sets the report list items member path.
ReportListNameMemberPath Gets or sets the report list name member path.
ReportListSource Gets or sets the report list source.
ReportListUriMemberPath Gets or sets the report list uri member path.
ReportListVisibility Gets or sets the value indicating whether report lists is visible.
ReportParameters Gets or sets the report parameters.
ReportParameterStyle Gets or sets the report parameter style.
ReportParameterTemplateSelector Gets or sets the template selector for report parameter.
ReportUri Gets or sets the report uri.
ReportViewerServiceHandler Gets or sets the reprot viewer service handler.
ReportXAML Gets or sets the report xaml.
Resource Gets or sets the value of the observable resource.
ResourceDownloader Gets the resource downloader.
ResourceOverride Gets or sets the individual resource object to override the existing localized resource.
ToolBarVisibility Gets or sets the value indicating whether toolbar is visible.

Protected Properties

DocumentViewerPanelType Gets the report viewer panel type.
Product Product Info.

Fields

AutoHideParameterBoxProperty Identifies the AutoHideParameterBox dependency property.
BookmarksProperty Identifies the Bookmarks dependency property.
BufferSizeProperty Identifies the BufferSize dependency property.
BusyIndicatorVisibilityProperty Identifies the BusyIndicatorVisibility dependency property.
CanUserDesignProperty Identifies the CanUserDesign dependency property.
CustomToolGroupProperty Identifies the CustomToolGroup dependency property.
DefaultStylesProperty Identifies the DefaultStyles dependency property.
DesignerCanNewProperty Identifies the DesignerCanNew dependency property.
DesignerCanOpenProperty Identifies the DesignerCanOpen dependency property.
DesignerCanSaveAsProperty Identifies the DesignerCanSaveAs dependency property.
DesignerCanSaveProperty Identifies the DesignerCanSave dependency property.
DesignerNewCommandProperty Identifies the DesignerNewCommand dependency property.
DesignerNewReportTemplateUriProperty Identifies the DesignerNewReportTemplateUri dependency property.
DesignerObjectDataSourceCollectionProperty Identifies the DesignerObjectDataSourceCollection dependency property.
DesignerOpenCommandProperty Identifies the DesignerOpenCommand dependency property.
DesignerSaveCommandProperty Identifies the DesignerSaveCommand dependency property.
DesignerSaveMetadataProperty Identifies the DesignerSaveMetadata dependency property.
DocumentProperty Identifies the Document dependency property.
EnableBackgroundLoadingProperty Identifies the EnableBackgroundLoading dependency property.
ErrorBoxVisibilityProperty Identifies the ErrorBoxVisibility dependency property.
ErrorTextProperty Identifies the ErrorText dependency property.
FontsProperty Identifies the Fonts dependency property.
IdleLatencyProperty Identifies the IdleLatency dependency property.
InitializeReportDocumentCommandProperty Identifies the InitializeReportDocumentCommand dependency property.
IsBackgroundLoadingProperty Identifies the IsBackgroundLoading dependency property.
IsBusyProperty Identifies the IsBusy dependency property.
IsReportParametersErrorProperty Identifies the IsReportParametersError dependency property.
LoadedPagesProperty Identifies the LoadedPages dependency property.
LoadingModeProperty Identifies the LoadingMode dependency property.
NavigationPaneSelectedIndexProperty Identifies the NavigationPaneSelectedIndex dependency property.
ParameterBoxVisibilityProperty Identifies the PromptParameterVisibility dependency property.
PrintCommandProperty Identifies the PrintCommand dependency property.
PrintedCommandProperty Identifies the PrintedCommand dependency property.
PrintOutlineVisibilityProperty Identifies the PrintOutlineVisibility dependency property.
ReportDataProviderProperty Identifies the ReportDataProvider dependency property.
ReportDefinitionProperty Identifies the ReportDefinition dependency property.
ReportDocumentProperty Identifies the ReportDocument dependency property.
ReportGlobalizationProviderProperty Identifies the ReportGlobalizationProvider dependency property.
ReportListItemMemberPathProperty Identifies the ReportListItemMemberPath dependency property.
ReportListItemsMemberPathProperty Identifies the ReportListItemsMemberPath dependency property.
ReportListNameMemberPathProperty Identifies the ReportListNameMemberPath dependency property.
ReportListProperty Identifies the ReportList dependency property.
ReportListSourceProperty Identifies the ReportListSource dependency property.
ReportListUriMemberPathProperty Identifies the ReportListUriMemberPath dependency property.
ReportListVisibilityProperty Identifies the ReportListVisibility dependency property.
ReportParametersProperty Identifies the ReportParameters dependency property.
ReportParameterStyleProperty Identifies the ReportParameterStyle dependency property.
ReportParameterTemplateSelectorProperty Identifies the ReportParameterTemplateSelector dependency property.
ReportUriProperty Identifies the ReportUri dependency property.
ReportViewerServiceHandlerProperty Identifies the ReportViewerServiceHandler dependency property.
ReportXAMLProperty Identifies the ReportXAML dependency property.
ResourceOverrideProperty Identifies the ResourceOverride dependency property.
ToolBarVisibilityProperty Identifies the ToolBarVisibility dependency property.

Static Methods

Initialize() Initialize ReportViewer.

Public Methods

AttachEventHandlers() Attach built-in event handlers to control templates. Call this method if necessary.
DetachedEventHandlers() Detach built-in event handlers from control templates. Call this method if necessary.
Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
InitializeTemplates() Initializes control templates.
OnApplyTemplate() Builds the visual tree for the ISItemsControl when a new template is applied.
ScrollToComponent(string) Scroll to a specific component based on the specific hyperlink.
ScrollToComponent(ReportComponentBase) Scroll to a specific component position.

Protected Methods

ClearContainerForItemOverride(DependencyObject, object) Undoes the effects of the System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject,System.Object) method.
OnCurrentPagePropertyChanged(int, int) Called when current page index is changed.
OnCustomContentTemplatePropertyChanged(DataTemplate, DataTemplate) Called when custom content template is changed.
OnMouseLeftButtonUp(MouseButtonEventArgs) Called before the mouse left button up event occurs.
OnMouseMove(MouseEventArgs) Called before the mouse move event occurs.
OnMouseWheel(MouseWheelEventArgs) Called before the mouse wheel event occurs to provide handling for the event in a derived class without attaching a delegate.
OnSearchIndexPropertyChanged(int, int) Called when search index is changed.
OnSearchTextPropertyChanged(string, string) Called when search text is changed.
OnUnloaded(object, RoutedEventArgs) Called when the element is unloaded.
OnZoomLevelPropertyChanged(double, double) Called when zoom level is changed
PrepareContainerForItemOverride(DependencyObject, object) Prepares the specified element to display the specified item.

Events


Public Constructors

public ReportViewer()

Create an instance of ReportViewer.

Public Properties

public bool AutoHideParameterBox { get; set; }

Gets or sets the value indicating whether parameter box should be hidden automatically.

public IEnumerable Bookmarks { get; set; }

Gets or sets the bookmarks.

public int BufferSize { get; set; }

Gets or sets the buffer size.

public Visibility BusyIndicatorVisibility { get; set; }

Gets or sets the value indicating whether busy indicator is visible.

public bool CanUserDesign { get; set; }

Gets or sets a value that determine whether user can design report at runtime.

public UXToolGroup CustomToolGroup { get; set; }

Gets or sets additional tool group.

public IEnumerable DefaultStyles { get; set; }

Gets or sets the default styles to be used by report documents.

public bool DesignerCanNew { get; set; }

Gets or sets the value indicating whether user can create new report in runtime designer.

public bool DesignerCanOpen { get; set; }

Gets or sets the value indicating whether user can open report in runtime designer.

public bool DesignerCanSave { get; set; }

Gets or sets the value indicating whether user can save report in runtime designer.

public bool DesignerCanSaveAs { get; set; }

Gets or sets the value indicating whether user can save report in runtime designer.

public ICommand DesignerNewCommand { get; set; }

Gets or sets the new command for runtime designer.

public Uri DesignerNewReportTemplateUri { get; set; }

Gets or sets the new report template uri for runtime designer.

public IEnumerable DesignerObjectDataSourceCollection { get; set; }

Gets or sets the object data source collection in runtime designer.

public ICommand DesignerOpenCommand { get; set; }

Gets or sets the open command for runtime designer.

public ICommand DesignerSaveCommand { get; set; }

Gets or sets the save command for runtime designer.

public Dictionary<string, string> DesignerSaveMetadata { get; set; }

Gets or sets the save metadata for runtime designer.

public RenderedDocument Document { get; set; }

Gets or sets the rendered document.

public bool EnableBackgroundLoading { get; set; }

Gets or sets the value indicating whether backgroudn loading is enabled.

public Visibility ErrorBoxVisibility { get; set; }

Gets or sets the value indicating whether error box is visible.

public string ErrorText { get; set; }

Gets or sets the error text.

public FontsCollection Fonts { get; set; }

Gets or sets the fonts collection used for reporting

public double IdleLatency { get; set; }

Gets or sets the idle latency.

public ICommand InitializeReportDocumentCommand { get; set; }

Gets or sets the initialize report document command.

public bool IsBackgroundLoading { get; set; }

Gets or sets the value indicating whether report viewer use background loading.

public bool IsBusy { get; set; }

Gets or sets the value indicating whether report viewer is in busy mode.

public bool IsReportParametersError { get; set; }

Gets or sets the value indicating whether report parameters contains error.

public int LoadedPages { get; set; }

Gets or sets the loaded report pages.

public LoadingMode LoadingMode { get; set; }

Gets or sets the loading mode.

public int NavigationPaneSelectedIndex { get; set; }

Gets or sets the selected index of navigation pane.

public Visibility ParameterBoxVisibility { get; set; }

Gets or sets the value indicating whether parameter box is visible.

public ICommand PrintCommand { get; set; }

Gets or sets the print command.

public ICommand PrintedCommand { get; set; }

Gets or sets the printed command.

public Visibility PrintOutlineVisibility { get; set; }

Gets or sets the value indicating whether print outline is visible.

public ReportDataProvider ReportDataProvider { get; set; }

Gets or sets the report data provider.

public ReportDefinition ReportDefinition { get; set; }

Gets or sets the report definition.

public ReportDocument ReportDocument { get; set; }

Gets or sets the report document.

public ReportGlobalizationProvider ReportGlobalizationProvider { get; set; }

Gets or sets the report globalization provider.

public IEnumerable ReportList { get; set; }

Gets or sets the report list.

public string ReportListItemMemberPath { get; set; }

Gets or sets the report list item member path.

public string ReportListItemsMemberPath { get; set; }

Gets or sets the report list items member path.

public string ReportListNameMemberPath { get; set; }

Gets or sets the report list name member path.

public IEnumerable ReportListSource { get; set; }

Gets or sets the report list source.

public string ReportListUriMemberPath { get; set; }

Gets or sets the report list uri member path.

public Visibility ReportListVisibility { get; set; }

Gets or sets the value indicating whether report lists is visible.

public ObservableCollection<ReportParameterMetadata> ReportParameters { get; set; }

Gets or sets the report parameters.

public Style ReportParameterStyle { get; set; }

Gets or sets the report parameter style.

public ReportParameterTemplateSelector ReportParameterTemplateSelector { get; set; }

Gets or sets the template selector for report parameter.

public Uri ReportUri { get; set; }

Gets or sets the report uri.

public string ReportViewerServiceHandler { get; set; }

Gets or sets the reprot viewer service handler.

public string ReportXAML { get; set; }

Gets or sets the report xaml.

public IObservableResource Resource { get; set; }

Gets or sets the value of the observable resource.

Exceptions

NotSupportedException

public ResourceDownloader ResourceDownloader { get; }

Gets the resource downloader.

public IObservableResource ResourceOverride { get; set; }

Gets or sets the individual resource object to override the existing localized resource.

public Visibility ToolBarVisibility { get; set; }

Gets or sets the value indicating whether toolbar is visible.

Protected Properties

protected Type DocumentViewerPanelType { get; }

Gets the report viewer panel type.

protected ProductInfo Product { get; }

Product Info.

Fields

public static readonly DependencyProperty AutoHideParameterBoxProperty

Identifies the AutoHideParameterBox dependency property.

public static readonly DependencyProperty BookmarksProperty

Identifies the Bookmarks dependency property.

public static readonly DependencyProperty BufferSizeProperty

Identifies the BufferSize dependency property.

public static readonly DependencyProperty BusyIndicatorVisibilityProperty

Identifies the BusyIndicatorVisibility dependency property.

public static readonly DependencyProperty CanUserDesignProperty

Identifies the CanUserDesign dependency property.

public static readonly DependencyProperty CustomToolGroupProperty

Identifies the CustomToolGroup dependency property.

public static readonly DependencyProperty DefaultStylesProperty

Identifies the DefaultStyles dependency property.

public static readonly DependencyProperty DesignerCanNewProperty

Identifies the DesignerCanNew dependency property.

public static readonly DependencyProperty DesignerCanOpenProperty

Identifies the DesignerCanOpen dependency property.

public static readonly DependencyProperty DesignerCanSaveAsProperty

Identifies the DesignerCanSaveAs dependency property.

public static readonly DependencyProperty DesignerCanSaveProperty

Identifies the DesignerCanSave dependency property.

public static readonly DependencyProperty DesignerNewCommandProperty

Identifies the DesignerNewCommand dependency property.

public static readonly DependencyProperty DesignerNewReportTemplateUriProperty

Identifies the DesignerNewReportTemplateUri dependency property.

public static readonly DependencyProperty DesignerObjectDataSourceCollectionProperty

Identifies the DesignerObjectDataSourceCollection dependency property.

public static readonly DependencyProperty DesignerOpenCommandProperty

Identifies the DesignerOpenCommand dependency property.

public static readonly DependencyProperty DesignerSaveCommandProperty

Identifies the DesignerSaveCommand dependency property.

public static readonly DependencyProperty DesignerSaveMetadataProperty

Identifies the DesignerSaveMetadata dependency property.

public static readonly DependencyProperty DocumentProperty

Identifies the Document dependency property.

public static readonly DependencyProperty EnableBackgroundLoadingProperty

Identifies the EnableBackgroundLoading dependency property.

public static readonly DependencyProperty ErrorBoxVisibilityProperty

Identifies the ErrorBoxVisibility dependency property.

public static readonly DependencyProperty ErrorTextProperty

Identifies the ErrorText dependency property.

public static readonly DependencyProperty FontsProperty

Identifies the Fonts dependency property.

public static readonly DependencyProperty IdleLatencyProperty

Identifies the IdleLatency dependency property.

public static readonly DependencyProperty InitializeReportDocumentCommandProperty

Identifies the InitializeReportDocumentCommand dependency property.

public static readonly DependencyProperty IsBackgroundLoadingProperty

Identifies the IsBackgroundLoading dependency property.

public static readonly DependencyProperty IsBusyProperty

Identifies the IsBusy dependency property.

public static readonly DependencyProperty IsReportParametersErrorProperty

Identifies the IsReportParametersError dependency property.

public static readonly DependencyProperty LoadedPagesProperty

Identifies the LoadedPages dependency property.

public static readonly DependencyProperty LoadingModeProperty

Identifies the LoadingMode dependency property.

public static readonly DependencyProperty NavigationPaneSelectedIndexProperty

Identifies the NavigationPaneSelectedIndex dependency property.

public static readonly DependencyProperty ParameterBoxVisibilityProperty

Identifies the PromptParameterVisibility dependency property.

public static readonly DependencyProperty PrintCommandProperty

Identifies the PrintCommand dependency property.

public static readonly DependencyProperty PrintedCommandProperty

Identifies the PrintedCommand dependency property.

public static readonly DependencyProperty PrintOutlineVisibilityProperty

Identifies the PrintOutlineVisibility dependency property.

public static readonly DependencyProperty ReportDataProviderProperty

Identifies the ReportDataProvider dependency property.

public static readonly DependencyProperty ReportDefinitionProperty

Identifies the ReportDefinition dependency property.

public static readonly DependencyProperty ReportDocumentProperty

Identifies the ReportDocument dependency property.

public static readonly DependencyProperty ReportGlobalizationProviderProperty

Identifies the ReportGlobalizationProvider dependency property.

public static readonly DependencyProperty ReportListItemMemberPathProperty

Identifies the ReportListItemMemberPath dependency property.

public static readonly DependencyProperty ReportListItemsMemberPathProperty

Identifies the ReportListItemsMemberPath dependency property.

public static readonly DependencyProperty ReportListNameMemberPathProperty

Identifies the ReportListNameMemberPath dependency property.

public static readonly DependencyProperty ReportListProperty

Identifies the ReportList dependency property.

public static readonly DependencyProperty ReportListSourceProperty

Identifies the ReportListSource dependency property.

public static readonly DependencyProperty ReportListUriMemberPathProperty

Identifies the ReportListUriMemberPath dependency property.

public static readonly DependencyProperty ReportListVisibilityProperty

Identifies the ReportListVisibility dependency property.

public static readonly DependencyProperty ReportParametersProperty

Identifies the ReportParameters dependency property.

public static readonly DependencyProperty ReportParameterStyleProperty

Identifies the ReportParameterStyle dependency property.

public static readonly DependencyProperty ReportParameterTemplateSelectorProperty

Identifies the ReportParameterTemplateSelector dependency property.

public static readonly DependencyProperty ReportUriProperty

Identifies the ReportUri dependency property.

public static readonly DependencyProperty ReportViewerServiceHandlerProperty

Identifies the ReportViewerServiceHandler dependency property.

public static readonly DependencyProperty ReportXAMLProperty

Identifies the ReportXAML dependency property.

public static readonly DependencyProperty ResourceOverrideProperty

Identifies the ResourceOverride dependency property.

public static readonly DependencyProperty ToolBarVisibilityProperty

Identifies the ToolBarVisibility dependency property.

Static Methods

public static void Initialize()

Initialize ReportViewer.

Public Methods

public void AttachEventHandlers()

Attach built-in event handlers to control templates. Call this method if necessary.

public void DetachedEventHandlers()

Detach built-in event handlers from control templates. Call this method if necessary.

public void Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void InitializeTemplates()

Initializes control templates.

public void OnApplyTemplate()

Builds the visual tree for the ISItemsControl when a new template is applied.

public void ScrollToComponent(string hyperlink)

Scroll to a specific component based on the specific hyperlink.

Parameters

hyperlink Specifies the hyperlink.

public void ScrollToComponent(ReportComponentBase component)

Scroll to a specific component position.

Parameters

component Specifies the report component.

Protected Methods

protected void ClearContainerForItemOverride(DependencyObject element, object item)

Undoes the effects of the System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject,System.Object) method.

Parameters

element The container element.
item The item.

protected void OnCurrentPagePropertyChanged(int oldPage, int newPage)

Called when current page index is changed.

Parameters

oldPage Specifies the old page index.
newPage Specifies the new page index.

protected void OnCustomContentTemplatePropertyChanged(DataTemplate oldValue, DataTemplate newValue)

Called when custom content template is changed.

Parameters

oldValue Specifies the old content template.
newValue Specifies the new content template.

protected void OnMouseLeftButtonUp(MouseButtonEventArgs e)

Called before the mouse left button up event occurs.

Parameters

e The data for the event.

protected void OnMouseMove(MouseEventArgs e)

Called before the mouse move event occurs.

Parameters

e The data for the event.

protected void OnMouseWheel(MouseWheelEventArgs e)

Called before the mouse wheel event occurs to provide handling for the event in a derived class without attaching a delegate.

Parameters

e The data for the event.

protected void OnSearchIndexPropertyChanged(int oldIndex, int newIndex)

Called when search index is changed.

Parameters

oldIndex Specifies the old search index.
newIndex Specifies the new search index.

protected void OnSearchTextPropertyChanged(string oldValue, string newValue)

Called when search text is changed.

Parameters

oldValue Specifies the old search text.
newValue Specifies the new search text.

protected void OnUnloaded(object sender, RoutedEventArgs e)

Called when the element is unloaded.

Parameters

sender The sender of the event.
e The event data for the property change.

protected void OnZoomLevelPropertyChanged(double oldValue, double newValue)

Called when zoom level is changed

Parameters

oldValue Specifies the old value.
newValue Specifies the new value.

protected void PrepareContainerForItemOverride(DependencyObject element, object item)

Prepares the specified element to display the specified item.

Parameters

element The container element used to display the specified item.
item The item to display.

Events

public event RenderingErrorEventHandler RenderingError

  • No labels