ViewParameter
A complex data type that describes a viewing parameter.
Schema
<xsd:complexType name="ViewParameter">
<xsd:all>
<xsd:element name="Format" type="xsd:string" minOccurs="0"/>
<xsd:element name="UserAgent" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ScalingFactor" type="xsd:long"
minOccurs="0"/>
<xsd:element name="AcceptEncoding" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ViewOperation" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="view"/>
<xsd:enumeration value="print"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="PathInformation" type="xsd:string"
minOccurs="0"/>
<xsd:element name="EmbeddedObjPath" type="xsd:string"
minOccurs="0"/>
<xsd:element name="RedirectPath" type="xsd:string"
minOccurs="0"/>
<xsd:element name="PdfQuality" type="xsd:long"
minOccurs="0"/>
</xsd:all>
</xsd:complexType>
Elements
Format
The format in which the report displays. Valid formats are:
CSS
DHTML
DHTMLLong
DHTMLRaw
ExcelData
Does not support specifying component ID
ExcelDisplay
Does not support specifying component ID
ImageMapURL
PDF
Does not support specifying component ID
PPT
PPTFullyEditable
Reportlet
Valid only if ShowInReportlet is enabled during report design
RTF
Does not support specifying component ID
RTFFullyEditable
Does not support specifying component ID
XMLCompressedDisplay
XMLCompressedExcel
XMLCompressedPDF
XMLCompressedPPT
XMLCompressedReportlet
XMLCompressedRTF
XMLData
XMLDisplay
XMLReportlet
XMLStyle
To support users clicking a point in a chart to navigate to different report sections, set Format to ImageMapURL.
SearchReport uses a different set of formats than other operations that use the ViewParameter data type. For SearchReport, valid formats are:
CSV
EXCEL
TSV
UNCSV
UNTSV
XMLDisplay
UserAgent
The browser to use for report viewing, such as Mozilla/4.0.
ScalingFactor
Adapts the size of a Reportlet to the Reportlet frame.
AcceptEncoding
The list of encoding methods the browser supports.
ViewOperation
The view operation, View or Print.
PathInformation
The path to the report.
EmbeddedObjPath
The base URL to prepend to a static or dynamic object in a report. When viewing a report in a browser, the URL of an image, chart, JavaScript, or another resource refers to the Encyclopedia volume. Use EmbeddedObjPath to change this URL.
RedirectPath
Maps from the current URL to a new target.
PdfQuality
The viewing quality of a PDF.