HTML Device Information Settings

The following table lists the device information settings for rendering in HTML format.

Setting Value

BookmarkID

The bookmark ID to jump to in the report.

DocMap

Indicates whether to show or hide the report document map. The default value of this parameter is true.

DocMapID

The document map ID to scroll to in the report.

EndFind

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 setting in conjunction with the StartFind setting.

FallbackPage

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.

FindString

The text to search for in the report. The default value of this parameter is an empty string.

GetImage

Gets a particular icon for the HTML Viewer user interface.

HTMLFragment

Indicates whether an HTML fragment is created in place of a full HTML document. An HTML fragment includes the report content in a TABLE element and omits the HTML and BODY elements. The default value is false. If you are rendering to HTML using the Render method of the SOAP API, you need to set this device information to true if you are rendering a report with images. Rendering using SOAP with the HTMLFragment property set to true creates URLs containing session information that can be used to properly request images. The images must be uploaded resources in the report server database.

Icon

The icon of a particular rendering extension.

JavaScript

Indicates whether JavaScript is supported in the rendered report.

LinkTarget

The target for hyperlinks in the report. You can target a window or frame by providing the name of the window, like LinkTarget=window_name, or you can target a new window using LinkTarget=_blank. Other valid target names include _self, _parent, and _top.

Parameters

Indicates whether to show or hide the parameters area of the toolbar. If you set this parameter to a value of true, the parameters area of the toolbar is displayed. The default value of this parameter is true.

ReplacementRoot

The path used for prefixing the value of the href attribute of the A element in the HTML report returned by the report server. By default, the report server provides the path. You can use this setting to specify a root path for any hyperlinks in your report.

Section

The page number of the report to render. A value of 0 indicates that all sections of the report are rendered. The default value is 1.

StartFind

The number of the page on which to begin the search. The default value is the number of the current page. Use this setting in conjunction with the EndFind setting.

StreamRoot

The path used for prefixing the value of the src attribute of the IMG element in the HTML report returned by the report server. By default, the report server provides the path. You can use this setting to specify a root path for the images in a report (for example, http://myserver/resources/companyimages).

StyleStream

Indicates whether styles and scripts are created as a separate stream instead of in the document. The default value is false.

Toolbar

Indicates whether to show or hide the toolbar. The default of this parameter is true. If the value of this parameter is false, all remaining options (except the document map) are ignored. If you omit this parameter, the toolbar is automatically displayed for rendering formats that support it.

The Report Viewer toolbar is rendered when you use URL access to render a report. The toolbar is not rendered through the SOAP API. However, the Toolbar device information setting affects the way that the report is displayed when using the SOAP Render method. If the value of this parameter is true when using SOAP to render to HTML, only the first section of the report is rendered. If the value is false, the entire HTML report is rendered as a single HTML page.

Type

The short name of the browser type (for example, "IE5") as defined in browscap.ini.

Zoom

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.

See Also

Reference

Reporting Services Web Services Class Library
Render

Concepts

Reporting Services Device Information Settings

Other Resources

Specifying Rendering Extension Parameters in Configuration Files

Help and Information

Getting SQL Server 2005 Assistance