WebReportExcelExportSettings
implements WebReportExportSettings| com.microstrategy.web.objects.WebReportExcelExportSettings |
Class Overview
Interface for configuring export to excel settings.
Obtained by casting the return object of
getExportSettings()
when
setExecutionMode(int)
was previously set to
REPORT_MODE_EXCEL.
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
com.microstrategy.web.objects.WebReportExportSettings
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract int | getGraphType() | ||||||||||
| abstract String | getGraphURL() | ||||||||||
| abstract String | getLayout() | ||||||||||
| abstract String | getOutlineState() | ||||||||||
| abstract int | getVersion() | ||||||||||
| abstract boolean |
isOfficeRefreshAllowed()
Whether MicroStrategy Office, if installed, is allowed to refresh the report.
| ||||||||||
| abstract boolean |
isShowHeaderAndFooter()
Whether to show the Header and Footer on the exported results.
| ||||||||||
| abstract void | setGraphType(int graphType) | ||||||||||
| abstract void |
setGraphURL(String url)
Excel cannot render certain varieties of graphs.
| ||||||||||
| abstract void |
setLayout(String xml)
This governs how the Excel document is laid out.
| ||||||||||
| abstract void | setOfficeRefresh(boolean isAllowed) | ||||||||||
| abstract void |
setOutlineState(String xml)
If outline mode is enabled, this configures which nodes are closed/opened.
| ||||||||||
| abstract void | setSeparateSheets(boolean isSeparateSheets) | ||||||||||
| abstract void |
setShowHeaderAndFooter(boolean value)
Whether to show the Header and Footer on the exported results.
| ||||||||||
| abstract void | setVersion(int version) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.web.objects.WebReportExportSettings
| |||||||||||
Public Methods
public abstract String getGraphURL ()
public abstract boolean isOfficeRefreshAllowed ()
Whether MicroStrategy Office, if installed, is allowed to refresh the report. Default is false.
Returns
- whether MicroStrategy Office, if installed, is allowed to refresh the report
public abstract boolean isShowHeaderAndFooter ()
Whether to show the Header and Footer on the exported results.
The default value is true.
Returns
- Whether to show the Header and Footer on the exported results
public abstract void setGraphType (int graphType)
Parameters
| graphType | the graph type as defined in EnumDSSXMLGraphImgTypes |
|---|
public abstract void setGraphURL (String url)
Excel cannot render certain varieties of graphs. In such cases, a graph image can be embedded instead. Note that if it is dynamically generated by the Intelligence Server, the image will only be visible during while the user's session is valid.
Parameters
| url | address of the graph image |
|---|
public abstract void setLayout (String xml)
This governs how the Excel document is laid out.
Parameters
| xml | the layout xml - please use WebReportExcelLayoutBuilder to generate it
|
|---|
public abstract void setOfficeRefresh (boolean isAllowed)
Parameters
| isAllowed | Whether to allow MicroStrategy Office, if installed, to refresh the report |
|---|
public abstract void setOutlineState (String xml)
If outline mode is enabled, this configures which nodes are closed/opened.
Parameters
| xml | the outline xml. |
|---|
public abstract void setSeparateSheets (boolean isSeparateSheets)
public abstract void setShowHeaderAndFooter (boolean value)
Whether to show the Header and Footer on the exported results.
The default value is true.
Parameters
| value | Whether to show the Header and Footer on the exported results |
|---|
public abstract void setVersion (int version)
Parameters
| version | Excel version as defined in EnumExcelVersion
|
|---|