Customize the Report Viewer web part
Applies to: ✅ SQL Server 2016 (13.x) Reporting Services and later ✅ Power BI Report Server ✅ SharePoint 2013 and later ❌ SharePoint Online
For content related to previous versions of SQL Server Reporting Services (SSRS), see SQL Server 2014 Reporting Services.
You can use the Report Viewer web part to view reports that run on a report server configured for SharePoint integration. Reports that you can display include report definition (.rdl) files and Report Builder reports. Reports open in the Report Viewer web part in a new page automatically. You can also add a Report Viewer web part to an existing web page or site if you want a particular report to be always visible on that page.
Note
Although they have identical names, the Report Viewer web part that is installed through the Reporting Services Add-in is different from the Report Viewer web part that is included in the RSWebParts.cab file. The instructions in this topic are specifically for the Report Viewer web part that is installed through the Reporting Services Add-in.
You can customize the Report Viewer web part in the following ways:
Change the appearance of the web part by setting properties.
Choose which interactive reporting features are available on the report toolbar.
Specify which view areas are available. The Report Viewer web part has a report view area, a Parameters area, and a Credentials area.
You can't extend the Report Viewer web part to support different file types, and you can't replace the report toolbar with a custom toolbar or add new functionality to the existing toolbar. If you require customization of the standard features, you should create a custom web part.
Set web part properties
A web part has custom properties that are used to configure specific functionality. A web part also has common properties that are standard for every web part.
Change default properties
The Report Viewer web part has default properties that are ideally suited for opening reports on demand from a library or folder. By default, all available controls are displayed on the toolbar. Height and width are set to use all of the available space on the web page. If you want to modify the default properties, you can customize the web part through Site Settings.
On the Site Actions menu, select Site Settings.
Under Galleries, select web parts.
Select ReportViewer.dwp.
Open the tool pane and set the properties you want to use.
Customize an embedded Report Viewer in a web page
You can set properties to make the Report Viewer fit within a web page. The report viewer can use the same style and colors as the page that contains it. You can hide all or part of the toolbar, document map, and parameters area to maximize the report viewing area within the allocated space. The report always uses the styles you defined for it when you created it. You can't customize report appearance after you publish it to a SharePoint library.
If you're embedding the Report Viewer web part in a web page, you should set the Report URL property to a specific report. If you don't, the Report Viewer displays instructions for linking to a report. You can't customize or remove the instructions.
Custom properties of the Report Viewer web part
When setting custom properties, be aware that some properties are used only when the Report Viewer web part is embedded in a page. Examples include Title, Height, Width, Chrome type, and Zone. Other properties, such as Toolbar settings and Parameters settings, are used regardless of whether the Report Viewer appears within a page or opens a report in full-page mode.
The custom properties of the Report Viewer web part are listed in the following table:
| Property | Description |
|---|---|
| Report | A fully qualified path to a report that is on the current SharePoint site, or on a site within the same Web application or farm. For best results when setting more properties, select Apply after you specify the report URL. |
| Hyperlink Target | Standard HTML that specifies the target frame for displaying linked content within the current document. For reports that include hyperlinks to external Web sites, you can specify whether a target document replaces the existing report within the current window, or opens in a new browser window. Valid values include _Top, _Blank, and _Self. _Top uses the current window, _Blank loads the document in a new browser window, and _Self opens the document within the current frame. Although _Parent is a valid value for the Target attribute in HTML, don't use it for a Report Viewer web part that is embedded in a page. |
| Auto-Generate web part Title | A generated title that includes the name of the Report Viewer web part plus the name of the report, separated by a dash. If the report doesn't have a title, the report file name is used. The title is visible when you add a web part to a page. If this check box is selected, the title is generated each time the page is refreshed. |
| Auto-Generate web part Title Detail Link | A generated hyperlink that appears above the web part. You can select the link to open the report in a new page, in full-page mode. |
| Show report builder menu item | Shows or hides the Actions menu option to open Report Builder. |
| Show subscription menu item | Shows or hides the Actions menu option to create a subscription for the report. |
| Show print menu item | Shows or hides the Actions menu option to print the report. |
| Show export menu item | Shows or hides the Actions menu option to export the report. |
| Show refresh button | Shows or hides the refresh button on the toolbar. |
| Show page navigation controls | Shows or hides the report navigation buttons on the toolbar. This option changes the visibility of all the navigation controls. |
| Show back button | Shows or hides the back button on the toolbar. |
| Show find controls | Shows or hides the find controls on the toolbar. The find controls allow a user to search for text in the rendered report. This option changes the visibility of all the find controls. |
| Show zoom control | Shows or hides the zoom control on the toolbar. |
| Show ATOM feed button | Shows or hides the ATOM feed button on the toolbar. |
| ToolBar location | Determines the location of the toolbar within the report viewer. Valid values include Top and Bottom. |
| Prompt area | Valid values include Displayed, Collapsed, and Hidden. Displayed displays the Parameters area for reports that include parameterized values and that require user input before the report runs. Use Hidden if all of the report parameters are specified and you don't want the parameters area to be visible to users. |
| Parameters Area Width | You can choose the measurement and value. The default is 200 pixels. The only requirement for this property is that it's greater than zero. |
| Document Map | A report navigation control that is defined in the report and used to provide one-click access to specific sections of a report. It's available in HTML reports. The document map is displayed in a collapsible area next to the report viewing area. Valid values include Displayed, Collapsed, and Hidden. If a document map is defined for a report, the area is expanded by default unless marked as hidden or collapsed in the web part properties. If the document map is collapsed, you can select the arrow to expand it. |
| Document Map Area Width | You can choose the measurement and value. The default is 200 pixels. The only requirement for this property is that it's greater than zero. |
| Load Parameters | Retrieve parameter properties for the report. Not all reports have parameters. If the report doesn't have parameters, no values are returned. If you set properties for a report that you uploaded, you might get an error indicating that the data source connection is deleted. If this error occurs, reset the connection and then finish setting parameter properties after the connection is specified. For more information about how to set the connection, see Create and Manage Shared Data Sources (Reporting Services in SharePoint Integrated Mode). For best results, select Apply before clicking Load Parameters. After you load parameter properties, you can set them the same way you would in the parameter property pages of the report. For more information about how to set parameters, see Set Parameters on a Published Report (Reporting Services in SharePoint Integrated Mode). |
Customize the toolbar
The toolbar appears beneath the title and extends across the top of the report. The toolbar provides an Actions menu, page navigation for paginated reports, refresh, and zoom. It includes a document map control for reports that have a document map. The Actions menu includes commands for exporting the report, searching for text or numbers within a report, printing the report, and, opening the report in Report Builder.
You can't add new commands to the Actions menu but you can customize it by changing the options that are visible to users. To change the visibility of toolbar buttons and controls, you change options in the ToolBar Items Visibility section of the web part. You can also remove the Print command or specific export formats by making these features unavailable on the report server. Page navigation controls are available for reports that have page breaks; otherwise, the report is a single page of variable length. Refresh reprocesses the report using the parameters that are current for the report. To display all the controls on one line, set the overall width of the web part to at least 400 pixels.
Customize the viewing area
The view area is used to display reports. The report view area is shared with the Parameters and Credentials area, if they're used. If credentials are required, the Credentials area is displayed next to an empty report view area. The Credentials area closes after the user provides credentials and runs the report. To customize the text that prompts users to set credentials, modify the data source connection properties. For more information, see Create and Manage Shared Data Sources (Reporting Services in SharePoint Integrated Mode).
The Parameters area provides fields for entering values before running the report. It's only used when a report definition includes parameters. When either the Parameters or Credentials areas are displayed, the report view is adjusted to use the remaining width of the web part. You can set properties on the web part to customize the width of Parameters. You can also define the labels that appear next to individual parameters on the page. For more information about how to modify parameter labels, see Set Parameters on a Published Report (Reporting Services in SharePoint Integrated Mode).
Related content
Report Viewer web part on a SharePoint site
Add the Report Viewer web part to a web page
More questions? Try asking the Reporting Services forum
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for