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.

Use this parameter To

Toolbar

Show or hide 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.

Parameters

Show or hide 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

Set 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 Microsoft Internet Explorer earlier than Internet Explorer 5.0 and all non-Microsoft browsers. The default value of this parameter is 100.

Section

Set 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

Specify the first section to search. The default value of this parameter is the first page of the report.

EndFind

Set 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

Set 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

Get a particular icon for the HTML Viewer user interface.

Icon

Get the icon of a particular rendering extension.

Stylesheet

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

Use this parameter To

Command

Specify the last section to search. The default value of this parameter is the last page of the report.

Format

Specify the format in which to render a report. Common values include HTML3.2, HTML4.0, HTMLOWC, MHTML, IMAGE, EXCEL, CSV, PDF, XML, and NULL. For more information, see Specifying a Rendering Format in a URL.

ParameterLanguage

Provide 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

Render a report based on a report history snapshot. For more information, see Rendering Report History Snapshots Using URL Access.

Examples

The following example hides the HTML Viewer toolbar by setting the rc:Toolbar parameter value to false:

https://servername/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:

https://servername/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:

https://servername/reportserver?/Sales/YearlySalesSummary&rs:Command=Render&rs:Format=HTML4.0&rc:Zoom=Page Width

The following example toggles section 13 of the report:

https://servername/reportserver?/Sales/YearlySalesSummary&rs:Command=Render&rs:ShowHideToggle=13

See Also

Reference

Using Parameter Prefixes in a URL

Other Resources

URL Access

Help and Information

Getting SQL Server 2005 Assistance