Using URL Access Parameters
You can use the following parameters as part of a URL to configure the look and feel of your reports. The most common parameters are listed in this section. Parameters are case-insensitive and begin with the parameter prefix rs: if directed to the report server and rc: if directed to an HTML Viewer. You can also specify parameters that are specific to devices or rendering extensions. For more information about device-specific parameters, see Specifying Device Information Settings in a URL.
HTML Viewer Commands
The following table describes the URL access parameters that are prefixed with rc: and are used to target the HTML Viewer.
Parameter |
Action |
|---|---|
Toolbar |
Shows or hides the toolbar. If the value of this parameter is false, all remaining options are ignored. If you omit this parameter, the toolbar is automatically displayed for rendering formats that support it. The default of this parameter is true. .gif "Important note") Important
rc:Toolbar=false does not work for URL access strings that use an IP address, instead of a domain name, to target a report hosted on a SharePoint site.
|
Parameters |
Shows or hides the parameters area of the toolbar. If you set this parameter to true, the parameters area of the toolbar is displayed. If you set this parameter to false, the parameters area is not displayed and cannot be displayed by the user. If you set this parameter to a value of Collapsed, the parameters area will not be displayed, but can be toggled by the end user. The default value of this parameter is true. |
Zoom |
Sets the report zoom value as an integer percentage or a string constant. Standard string values include Page Width and Whole Page. This parameter is ignored by versions of Internet Explorer earlier than Internet Explorer 5.0 and all non-Microsoft browsers. The default value of this parameter is 100. |
Section |
Sets which page in the report to display. Any value that is greater than the number of pages in the report displays the last page. Any value that is less than 0 displays page 1 of the report. The default value of this parameter is 1. |
StartFind |
Specifies the last section to search. The default value of this parameter is the last page of the report. |
EndFind |
Sets the number of the last page to use in the search. For example, a value of 5 indicates that the last page to be searched is page 5 of the report. The default value is the number of the current page. Use this parameter in conjunction with the StartFind parameter. |
FallbackPage |
Sets the number of the page to display if a search or a document map selection fails. The default value is the number of the current page. |
GetImage |
Gets a particular icon for the HTML Viewer user interface. |
Icon |
Gets the icon of a particular rendering extension. |
Stylesheet |
Specifies a style sheet to be applied to the HTML Viewer. |
You can pass additional parameters on a URL to direct the output for HTML rendering. For more information, see HTML Device Information Settings.
Report Server Commands
The following table describes the URL access parameters that are prefixed with rs: and are used to target the report server.
Parameter |
Action |
|---|---|
Command |
Specifies the last section to search. The default value of this parameter is the last page of the report. |
Format |
Specifies the format in which to render a report. Common values include HTML3.2, HTML4.0, MHTML, IMAGE, EXCEL, WORD, CSV, PDF, XML, and NULL. For more information, see Specifying a Rendering Format in a URL. |
ParameterLanguage |
Provides a language for parameters passed in a URL that is independent of the browser language. The default value is the browser language. The value can be a culture value, such as en-us or de-de. |
Snapshot |
Renders a report based on a report history snapshot. For more information, see Rendering Report History Snapshots Using URL Access. |
PersistStreams |
Renders a report in a single persisted stream. This parameter is used by the Image renderer to transmit the rendered report one chunk at a time. After using this parameter in a URL access string, use the same URL access string with the GetNextStream parameter instead of the PersistStreams parameter to get the next chunk in the persisted stream. This URL command will eventually return a 0-byte stream to indicate the end of the persisted stream. The default value is false. |
GetNextStream |
Gets the next data chunk in a persisted stream that is accessed using the PersistStreams parameter. For more information, see the description for PersistStreams. The default value is false. |
Report Viewer Web Part Commands
The following table describes the SQL Server reserved report parameter names that are used to target the Report Viewer Web Part when Reporting Services is integrated with Windows SharePoint Services (WSS) 3.0 or later, as well as Microsoft Office SharePoint Server 2007 or later. These parameter names are prefixed with rv:. The Report Viewer Web Part also accepts the rs:ParameterLanguage parameter.
Parameter |
Action |
|---|---|
Toolbar |
Controls the toolbar display for the Report Viewer Web Part. The default value is Full. Values can be:
|
HeaderArea |
Controls the header display for the Report Viewer Web Part. The default value is Full. Values can be:
|
DocMapAreaWidth |
Controls the display width, in pixels, of the parameter area in the Report Viewer Web Part. The default value is the same as the Report Viewer Web Part default. The value must be a non-negative integer. |
AsyncRender |
Controls whether a report is rendered asynchronously. The default value is true, which specifies that a report be rendered asynchronously. The value must be a Boolean value of true or false. |
ParamMode |
Controls how the Report Viewer Web Part’s parameter prompt area is displayed in full-page view. Valid values are:
The default value is Full. |
DocMapMode |
Controls how the Report Viewer Web Part’s document map area is displayed in full-page view. Valid values are:
The default value is Full. |
DockToolBar |
Controls whether the Report Viewer Web Part’s toolbar is docked to the top or bottom. Valid values are Top and Bottom. The default value is Top. |
ToolBarItemsDisplayMode |
Controls which toolbar items are displayed. This is a bitwise enumeration value. To include a toolbar item, add the item’s value to the total value. For example: for no Actions menu, use rv:ToolBarItemsDisplayMode=63 (or 0x3F), which is 1+2+4+8+16+32; for Actions menu items only, use rv:ToolBarItemsDisplayMode=960 (or 0x3C0). Valid values are:
The default value is -1, which includes all toolbar items. |
Examples
The following example hides the HTML Viewer toolbar by setting the rc:Toolbar parameter value to false:
http://<Server Name>/reportserver?/Sales/YearlySalesSummary&rs:Command=Render&rs:Format=HTML4.0&rc:Toolbar=false
The following example passes a hard-coded parameter and hides the input field for user-supplied parameters:
http://<Server Name>/reportserver?/Sales/YearlySalesSummary&rs:Command=Render&rs:Format=HTML4.0&rc:Parameters=false&Year=2002
The following example uses the rc:Zoom parameter to set the zoom property of the report to Page Width:
http://<Server Name>/reportserver?/Sales/YearlySalesSummary&rs:Command=Render&rs:Format=HTML4.0&rc:Zoom=Page Width
The following example toggles section 13 of the report:
http://<Server Name>/reportserver?/Sales/YearlySalesSummary&rs:Command=Render&rs:ShowHideToggle=13